### GET /v3/ctUsCatalogDownload

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

Downloads the US Catalog as a zip file.

```APIDOC
## GET /v3/ctUsCatalogDownload

### Description
Catalog download for US. Downloads US Catalog as zip file.

### Method
GET

### Endpoint
/v3/ctUsCatalogDownload

### Parameters

### Response
#### Success Response (200)
- **Description**: Returns a zip file containing the US Catalog.

### Response Example
(Binary data representing a zip file)
```

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

### GET /v3/ctCaCatalogDownload

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

Downloads the CA Catalog as a zip file.

```APIDOC
## GET /v3/ctCaCatalogDownload

### Description
Catalog download for CA. Downloads CA Catalog as zip file.

### Method
GET

### Endpoint
/v3/ctCaCatalogDownload

### Parameters

### Response
#### Success Response (200)
- **Description**: Returns a zip file containing the CA Catalog.

### Response Example
(Binary data representing a zip file)
```

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

### Catalog Services - GET /v3/ctUsCatalogDownload

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint downloads the catalog for US.

```APIDOC
## GET /v3/ctUsCatalogDownload

### Description
Catalog download for US

### Method
GET

### Endpoint
/v3/ctUsCatalogDownload
```

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

### Account Services - GET /v1/rest/com/becn/accounts

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint lists all available accounts for the user.

```APIDOC
## GET /v1/rest/com/becn/accounts

### Description
This endpoint lists all available accounts for the user.

### Method
GET

### Endpoint
/v1/rest/com/becn/accounts
```

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

### GET /v3/rest/com/becn/downloadCatalogItemData

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

Downloads a zip file containing catalog item data.

```APIDOC
## GET /v3/rest/com/becn/downloadCatalogItemData

### Description
Downloads a zip file containing catalog item data.

### Method
GET

### Endpoint
/v3/rest/com/becn/downloadCatalogItemData

### Parameters
No parameters documented for this endpoint.

### Response
#### Success Response (200)
- **(file)** - A zip file containing catalog item data.

#### Response Example
(No example provided)
```

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

### GET /v3/rest/com/becn/downloadCatalogItemData

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-yaml

Downloads a zip file containing catalog item data.

```APIDOC
## GET /v3/rest/com/becn/downloadCatalogItemData

### Description
Downloads zip file with catalog item data.

### Method
GET

### Endpoint
/v3/rest/com/becn/downloadCatalogItemData

### Parameters
(No parameters specified in source)

### Request Example
```json
(No example provided in source)
```

### Response
#### Success Response (200)
- (Description empty in source)

#### Response Example
(No example provided in source)
```

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

### Order History Services - GET /v2/rest/com/becn/orderdetail

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint gets details of an order.

```APIDOC
## GET /v2/rest/com/becn/orderdetail

### Description
Get details of an order

### Method
GET

### Endpoint
/v2/rest/com/becn/orderdetail
```

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

### Product and Item Details Schema

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-yaml

This section details the schema for product and item information, including various attributes like descriptions, pricing, availability, and image URLs.

```APIDOC
## Product and Item Schema

This schema defines the structure of product and item data returned by the API.

### Fields

- **templateItemId** (string) - Unique identifier for the template item. Required. Example: `gi24260019`
- **productImageUrl** (string) - URL of the product image. Required. Example: `null`
- **productOnErrorImageUrl** (string) - Fallback image URL if the product image is not found. Required. Example: `https://beacon-uat.becn.com/images/default_not_found.jpg`
- **itemOrProductDescription** (string) - Description of the item or product. Required. Example: `Titanium PSU30 Peel & Stick Synthetic Roofing Underlayment - 2 SQ. Roll Grey`
- **itemNumber** (string) - Unique item number. Required. Example: `'290490'`
- **nickName** (string) - Nickname assigned to the item. Required. Example: `My favorite item`
- **displayOrder** (number) - Display order for the item. Required. Example: `1`
- **productOrItemNumber** (string) - Product or item number. Required. Example: `C-290490`
- **internalProductName** (string) - Internal product name. Required. Example: `PSU30 Peel & Stick Synthetic Roofing Underlayment - 2 SQ. Roll`
- **unitPrice** (number) - Unit price of the product. Required. Example: `211.82`
- **itemUnitPrice** (number) - Item unit price. Required. Example: `0`
- **unitOfMeasure** (string) - Unit of measure for the item. Required. Example: `RL`
- **quantity** (number) - Quantity ordered. Required. Example: `1`
- **available** (boolean) - Indicates if the item is available. Required. Example: `true`
- **itemType** (object) - Type information about the item. Example: `null`
- **senMincronDirectly** (boolean) - Indicates if the description should only be sent to Mincron. Example: `false`
- **vendorColorId** (string) - Vendor color ID associated with the item. Example: `null`
- **description** (string) - Description of the item. Example: `null`
- **subTotal** (number) - Subtotal amount for the item. Example: `0`
- **productOrItemDescription** (string) - Description of the product or item. Example: `null`
- **productNumber** (string) - Product number. Example: `null`
- **defaultUnitOfMeasure** (string) - Default unit of measure for the product or item. Example: `RL`
- **ATGItemMapping** (object) - Mapping for ATG items. Example: `null`
- **itemSubTotal** (number) - Item subtotal. Example: `0`
- **nonStockItem** (boolean) - Indicates if the item is non-stock. Example: `false`
- **sendDescriptionOnlyToMincron** (boolean) - Indicates if the description should only be sent to Mincron. Example: `false`
- **lineComments** (string) - Comments for the item line. Example: `null`
- **mainCategory** (string) - Main category of the item. Example: `null`
- **category** (string) - Category of the item. Example: `null`
- **extendedDescription** (string) - Extended description of the item. Example: `null`
- **hasBranchAvailability** (boolean) - Indicates if the item has branch availability. Example: `false`
- **imageUrl** (object) - Image URLs associated with the item. Example: `$ref: '#/components/schemas/ImageUrl'`
- **currentVariation** (object) - Current variant of the item. Example: `$ref: '#/components/schemas/V1Variant'`
- **variations** (array) - List of variants for the item. Example: `[{ $ref: '#/components/schemas/V1Variant' }]`

### Required Fields

The following fields are required:
`templateItemId`, `productImageUrl`, `productOnErrorImageUrl`, `itemOrProductDescription`, `itemNumber`, `nickName`, `displayOrder`, `productOrItemNumber`, `internalProductName`, `unitPrice`, `itemUnitPrice`, `unitOfMeasure`, `quantity`, `available`

```

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

### GET /v2/rest/com/becn/template

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-yaml

Retrieves a list of all templates and their details for the current user, with enhanced options for including items, pricing, and availability details. This version also supports invoking store logic for availability checks.

```APIDOC
## GET /v2/rest/com/becn/template

### Description
Returns a list of all templates and details for the current user. This version supports filtering by account, including items, variations, pricing, and regional availability. It also allows specifying the invocation method for availability checks.

### Method
GET

### Endpoint
/v2/rest/com/becn/template

### Parameters
#### Query Parameters
- **account** (string) - Optional - If not empty, will filter results by the given account ID.
- **showItems** (string) - Optional - If true, will include items in the response.
- **showItemVariations** (string) - Optional - If true, will include variations in the response.
- **showPricing** (string) - Optional - If true, will include pricing in the response.
- **showItemAvailable** (string) - Optional - If true, will include item regional availability in the response.
- **invokeBy** (string) - Optional - If value is "store", will do the store logic when checking availability.
- **pageSize** (number) - Optional - Number of items per page (default is 10, max is 100).
- **pageNo** (number) - Optional - The page number to return (default is 1).

### Request Example
```json
{
  "account": "280381",
  "showItems": "true",
  "showPricing": "true",
  "invokeBy": "store"
}
```

### Response
#### Success Response (200)
- **V2GetTemplateResponse** (object) - Schema for the v2 template response.

#### Response Example
```json
{
  "templates": [
    {
      "templateId": "tpl_789",
      "name": "Advanced Template",
      "items": [
        {
          "itemId": "item_101",
          "itemName": "Premium Item",
          "pricing": {
            "currency": "USD",
            "amount": 99.99
          }
        }
      ]
    }
  ]
}
```
```

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

### Order History Services - GET /v1/rest/com/becn/orderdetail

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint gets details of an order.

```APIDOC
## GET /v1/rest/com/becn/orderdetail

### Description
Get details of an order

### Method
GET

### Endpoint
/v1/rest/com/becn/orderdetail
```

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

### POST /login

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

Authenticates a user and returns login information. Supports various login parameters and site IDs.

```APIDOC
## POST /login

### Description
Authenticates a user based on provided credentials and site information. Returns detailed message information upon successful login.

### Method
POST

### Endpoint
/login

### Parameters
#### Request Body
- **username** (string) - Required - User's email address for login.
- **password** (string) - Required - User's password.
- **siteId** (string) - Required - Realm identifier. Options: dealersChoice, homeSite, canada.
- **persistentLoginType** (string) - Optional - Type of persistent login (e.g., RememberMe).
- **userAgent** (string) - Optional - User's agent information (e.g., desktop, mobile).
- **apiSiteId** (string) - Optional - API site identifier. Can be null.

### Request Example
```json
{
  "username": "test@gmail.com",
  "password": "password",
  "siteId": "dealersChoice,homeSite,canada",
  "persistentLoginType": "RememberMe",
  "userAgent": "desktop,mobile",
  "apiSiteId": null
}
```

### Response
#### Success Response (200)
- **LoginResponse** - Contains message code and detailed message information.
  - **messageCode** (number) - Example: 200
  - **messageInfo** (object) - Detailed user information.
    - **firstName** (string)
    - **lastName** (string)
    - **emailAddress** (string)
    - **cartLineItems** (number)
    - **internalUser** (boolean)
    - **rewardsEligible** (boolean)
    - **lastSelectedAccount** (object)
    - **profileId** (string)
    - **userType** (string)
    - **accountBranch** (object)
    - **loyaltyFlag** (boolean)

#### Response Example
```json
{
  "messageCode": 200,
  "messageInfo": {
    "firstName": "firstName",
    "lastName": "lastName",
    "emailAddress": "test@test.com",
    "cartLineItems": 0,
    "internalUser": false,
    "rewardsEligible": true,
    "lastSelectedAccount": {
      "loyaltyEnrolled": false,
      "loyaltyFlag": false,
      "enableGAFQuickMeasure": false,
      "gafQuickMeasureFlag": false,
      "rewardsEligible": false,
      "accountName": "e-Commerce Test Customer-BR180",
      "nationalAccount": false,
      "canAccessEVSmartOrder": true,
      "accountViewPrices": true,
      "hasRebate": false,
      "hasMincronRebate": false,
      "accountEnabled": true,
      "customerType": {
        "isDefault": true,
        "name": "BeaconNextGen",
        "realm": "becnca"
      },
      "addCustomSteel": true,
      "accountEagleViewPurchaseStatus": false,
      "cashAccount": false,
      "accountLegacyId": "280381",
      "isAccountClosed": false,
      "viewPrices": false
    },
    "profileId": "660000",
    "userType": "Customer",
    "accountBranch": {
      "address": {
        "street": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string",
        "country": "string"
      },
      "branchNumber": "300",
      "branchPhone": "7203029965",
      "companyName": "WEST DIVISION",
      "divisionName": "MOUNTAIN",
      "active": true,
      "branchName": "DENVER HUB BRANCH",
      "activeToSendEmail": false,
      "branchRegionId": "33",
      "canAccessEVSmartOrderOnBranch": true,
      "enableCommercialGuidedQuote": true,
      "enableOrderHistorySurveyLinking": true
    },
    "loyaltyFlag": false
  }
}
```
```

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

### Quote Services - GET /v2/rest/com/becn/getMincronQuoteDetail

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint gets quote details for a given quote.

```APIDOC
## GET /v2/rest/com/becn/getMincronQuoteDetail

### Description
Get quote details for a given quote

### Method
GET

### Endpoint
/v2/rest/com/becn/getMincronQuoteDetail
```

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

### Template Services - GET /v2/rest/com/becn/getTemplateDetail

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint gets template details for a given template.

```APIDOC
## GET /v2/rest/com/becn/getTemplateDetail

### Description
Get template details for a given template

### Method
GET

### Endpoint
/v2/rest/com/becn/getTemplateDetail
```

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

### POST /v1/rest/com/becn/login

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-yaml

Allows users to log in using their username and password to obtain an authentication token and customer details.

```APIDOC
## POST /v1/rest/com/becn/login

### Description
User login with username/password. Logs in with userName and password to get the token and Customer details.

### Method
POST

### Endpoint
/v1/rest/com/becn/login

### Parameters
#### Request Body
- **schema** (*object*) - Required - The request body must conform to the `LoginRequest` schema.

### Request Example
```json
{
  "userName": "string",
  "password": "string"
}
```

### Response
#### Success Response (200)
- **schema** (*object*) - The response will contain details conforming to the `LoginResponse` schema.

#### Error Response (400)
- **description**: Bad Request.

#### Error Response (401)
- **description**: Unauthorized, the authorization bearer token is invalid.

#### Error Response (500)
- **description**: Internal Server Error.
```

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

### Product Catalog Service - V3 Mincron Mapping

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-yaml

Retrieves product mappings from the V3 Mincron system, including pagination details and a list of mapped products.

```APIDOC
## GET /v3/mincron/mapping

### Description
Retrieves product mappings from the V3 Mincron system. This endpoint returns a result object containing pagination information and a list of mapped products.

### Method
GET

### Endpoint
/v3/mincron/mapping

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **result** (object) - The result of the mincron mapping. Contains `pagination` and `products`.
  - **pagination** (object) - Pagination details for the response.
    - **available** (boolean) - Whether the link is available or not.
    - **label** (string) - Label for the pagination link.
    - **page** (number) - Page number associated with this link.
  - **products** (array) - The list of product mappings.
    - **itemNumber** (string) - The item number.
    - **aliasNumber** (string) - The alias number.
    - **itemDescription** (string) - The item description.
    - **productNumber** (string) - The product number.
    - **customerNumber** (string) - The customer number.

#### Response Example
{
  "result": {
    "pagination": {
      "available": true,
      "label": "Next",
      "page": 2
    },
    "products": [
      {
        "itemNumber": "366162",
        "aliasNumber": "!280381300kmlslG",
        "itemDescription": "OCF DV OAKRIDGE ONYX BLACK",
        "productNumber": "OCFDVO30OB",
        "customerNumber": "280381"
      },
      {
        "itemNumber": "456592",
        "aliasNumber": "!2803813003/F2kN",
        "itemDescription": "CLB 2X8 ADJUSTABLE ROOF BRACKET",
        "productNumber": "CLBB01500",
        "customerNumber": "280381"
      }
    ]
  }
}
```

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

### GET /v2/rest/com/becn/itemDetails

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-yaml

Retrieve details for a specific item.

```APIDOC
## GET /v2/rest/com/becn/itemDetails

### Description
Retrieve details for an item.

### Method
GET

### Endpoint
/v2/rest/com/becn/itemDetails

### Parameters
(No parameters specified in source)

### Request Example
```json
(No example provided in source)
```

### Response
#### Success Response (200)
- (Description empty in source)

#### Response Example
(No example provided in source)
```

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

### Product Catalog Service - GET /v3/rest/com/becn/mincronMapping

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint retrieves mincron mapping products. Backwards compatible with ATG.

```APIDOC
## GET /v3/rest/com/becn/mincronMapping

### Description
Get mincron mapping products. Backwards compatible with ATG.

### Method
GET

### Endpoint
/v3/rest/com/becn/mincronMapping
```

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

### GET /v3/ctUsCatalogDownloadJson

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

Downloads the US Catalog as a JSON file.

```APIDOC
## GET /v3/ctUsCatalogDownloadJson

### Description
JSON Catalog download for US. Downloads US Catalog as json file.

### Method
GET

### Endpoint
/v3/ctUsCatalogDownloadJson

### Parameters

### Response
#### Success Response (200)
- **Description**: Returns a JSON file containing the US Catalog.

### Response Example
(JSON data representing the US Catalog)
```

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

### User Authentication and Profile

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

This section details endpoints related to user authentication, profile retrieval, and management of user-specific settings.

```APIDOC
## GET /users/me

### Description
Retrieves the current logged-in user's information, including profile details, account information, and settings.

### Method
GET

### Endpoint
/users/me

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Comma-separated list of fields to include in the response.

### Request Example
```
GET /users/me?fields=login,firstName,lastName,deliveryTrackingSettings
```

### Response
#### Success Response (200)
- **login** (string) - The user's login email.
- **title** (string) - The user's title.
- **roleType** (string) - The user's role type.
- **firstName** (string) - The user's first name.
- **lastName** (string) - The user's last name.
- **officePhoneNumber** (string) - The user's office phone number.
- **defaultOrganization** (string) - The user's default organization.
- **appLogin** (boolean) - Indicates if the user logged in via the app.
- **proPlusLastPurchaseDate** (string) - The last purchase date for Pro Plus.
- **deviceTokens** (array) - List of device tokens associated with the user.
- **userAccounts** (array) - List of accounts associated with the user.
- **hasPrivateEVAccount** (boolean) - Indicates if the user has a private EV account.
- **lastProPlusMobileAppLogin** (string) - The last login date for Pro Plus mobile app.
- **registrationDate** (string) - The user's registration date.
- **contactAddress** (object) - The user's contact address details.
- **firstLoggedInDate** (string) - The user's first login date.
- **deliveryTrackingSettings** (object) - Delivery tracking settings for the user.
- **mobilePhoneNumber** (string) - The user's mobile phone number.

#### Response Example
```json
{
  "login": "test@test.com",
  "title": "tester",
  "roleType": "admin",
  "firstName": "firstName",
  "lastName": "lastName",
  "officePhoneNumber": "6263396321",
  "code": null,
  "result": null,
  "defaultOrganization": "AAXIS",
  "appLogin": false,
  "proPlusLastPurchaseDate": "2023-11-20 01:53:22.0000723",
  "deviceTokens": null,
  "userAccounts": null,
  "hasPrivateEVAccount": false,
  "lastProPlusMobileAppLogin": "2023-11-20 01:53:22.0000723",
  "registrationDate": "2023-11-20 01:53:22.0000723",
  "contactAddress": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zipCode": "12345",
    "country": "USA"
  },
  "firstLoggedInDate": "2023-11-20 01:53:22.0000723",
  "deliveryTrackingSettings": {
    "dtAccount": {
      "requested": "requested",
      "scheduled": "scheduled",
      "delivered": null
    },
    "allOrders": {
      "requested": "requested",
      "scheduled": "scheduled",
      "delivered": null
    },
    "phone": null,
    "email": null,
    "myOrders": {
      "requested": "requested",
      "scheduled": "scheduled",
      "delivered": null
    }
  },
  "mobilePhoneNumber": "6263396421"
}
```

### Error Handling
- **400 Bad Request**: Invalid request parameters.
- **401 Unauthorized**: Authentication failed.
- **404 Not Found**: User not found.
- **500 Internal Server Error**: Server error.
```

```APIDOC
## POST /users/switch-account

### Description
Switches the current user's active account.

### Method
POST

### Endpoint
/users/switch-account

### Parameters
#### Request Body
- **accountId** (string) - Required - The ID of the account to switch to.

### Request Example
```json
{
  "accountId": "280381"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that the account was switched successfully.

#### Response Example
```json
{
  "message": "Account switched successfully."
}
```

### Error Handling
- **400 Bad Request**: Missing or invalid account ID.
- **401 Unauthorized**: Authentication failed.
- **404 Not Found**: Account not found.
- **500 Internal Server Error**: Server error.
```

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

### GET /products

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

Retrieves mapping products based on the provided account ID. This endpoint is backwards compatible with ATG.

```APIDOC
## GET /products

### Description
Retrieves mapping products based on the customer number. This endpoint is backwards compatible with ATG.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **accountId** (string) - Required - The account ID to get details for
- **pageSize** (number) - Optional - Default page size is 100. Minimum 1, Maximum 100.
- **pageNo** (number) - Optional - Default page no is 1. Minimum 1.

### Response
#### Success Response (200)
- **V3MincronMappingResponse** - Schema for the successful response containing mapping products.

#### Error Responses
- **401** - Unauthorized, the authorization bearer token is invalid
- **405** - Method not allowed
- **417** - Unauthorized, the authorization bearer token is expired
- **500** - Internal exception
```

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

### GET /v2/rest/com/becn/getCurrentUserInfo

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

Retrieves detailed information for the current user.

```APIDOC
## GET /v2/rest/com/becn/getCurrentUserInfo

### Description
Get current user details.

### Method
GET

### Endpoint
/v2/rest/com/becn/getCurrentUserInfo

### Parameters

### Response
#### Success Response (200)
- **schema** (array) - An array of current user information objects.

#### Response Example
```json
{
  "schema": "#/components/schemas/CurrentUserInfoV2Response"
}
```
```

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

### GET /v3/ctCustomerCatalogDownload

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

Downloads a zip file containing catalog item data for a specific customer account.

```APIDOC
## GET /v3/ctCustomerCatalogDownload

### Description
Downloads zip file with catalog item data.

### Method
GET

### Endpoint
/v3/ctCustomerCatalogDownload

### Parameters
#### Query Parameters
- **accountId** (string) - Required - The unique identifier for the customer account.

### Response
#### Success Response (200)
- **Description**: Returns a zip file containing catalog data.

### Response Example
(Binary data representing a zip file)
```

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

### Template Services - GET /v1/rest/com/becn/template

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint lists all templates and details for the current user.

```APIDOC
## GET /v1/rest/com/becn/template

### Description
List all templates and details for the current user

### Method
GET

### Endpoint
/v1/rest/com/becn/template
```

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

### Quote Services - GET /v2/rest/com/becn/quote

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint lists user quotes.

```APIDOC
## GET /v2/rest/com/becn/quote

### Description
List User Quotes

### Method
GET

### Endpoint
/v2/rest/com/becn/quote
```

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

### Template Services - GET /v2/rest/com/becn/template

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint lists all templates and details for the current user.

```APIDOC
## GET /v2/rest/com/becn/template

### Description
List all templates and details for the current user

### Method
GET

### Endpoint
/v2/rest/com/becn/template
```

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

### Invoice Services - GET /v4/rest/com/becn/invoice

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint lists all invoices for an account.

```APIDOC
## GET /v4/rest/com/becn/invoice

### Description
Lists all invoices for an account

### Method
GET

### Endpoint
/v4/rest/com/becn/invoice
```

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

### GET /productDetail/{productId}/{itemId}

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-yaml

Retrieves detailed information for a specific product identified by its product ID and item ID. This endpoint provides a full spectrum of data including descriptions, pricing, availability status, and categorization.

```APIDOC
## GET /productDetail/{productId}/{itemId}

### Description
Retrieves detailed information for a specific product identified by its product ID and item ID. This endpoint provides a full spectrum of data including descriptions, pricing, availability status, and categorization.

### Method
GET

### Endpoint
/productDetail/{productId}/{itemId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - The unique identifier for the product.
- **itemId** (string) - Required - The unique identifier for the item within the product.

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET /productDetail/C-385673/381574
```

### Response
#### Success Response (200)
- **description** (string) - Description of the item.
- **productOrItemDescription** (string) - Description of the product or item.
- **ATGItemMapping** (object) - Mapping for ATG items.
- **sendDescriptionOnlyToMincron** (boolean) - Indicates if only the description should be sent to Mincron.
- **lineComments** (string) - Comments for the item line.
- **mainCategory** (string) - Main category of the item.
- **extendedDescription** (string) - Extended description of the item.
- **hasBranchAvailability** (boolean) - Indicates if the item has branch availability.
- **available** (boolean) - Indicates if the item is available.
- **nonStockItem** (boolean) - Indicates if the item is a non-stock item.
- **unitPrice** (number) - Unit price of the item.
- **itemUnitPrice** (number) - Item unit price.
- **quantity** (number) - Quantity ordered.
- **subTotal** (number) - Subtotal of the item.
- **itemSubTotal** (number) - Item subtotal.
- **displayOrder** (number) - Display order for the item.
- **isAddedToFavorites** (boolean) - Indicates if the item is added to favorites.
- **category** (object) - Category information associated with the item.
- **imageUrl** (object) - Image URLs associated with the item.
- **skusVariation** (object) - SKU variation details.
- **variations** (object) - Variation details.
- **multiVariationData** (object) - Multi-variation data associated with the item.

#### Response Example
```json
{
  "description": null,
  "productOrItemDescription": null,
  "ATGItemMapping": null,
  "sendDescriptionOnlyToMincron": false,
  "lineComments": null,
  "mainCategory": "Asphalt Shingles",
  "extendedDescription": null,
  "hasBranchAvailability": false,
  "available": true,
  "nonStockItem": false,
  "unitPrice": 58.99,
  "itemUnitPrice": 0,
  "quantity": 1,
  "subTotal": 0,
  "itemSubTotal": 0,
  "displayOrder": 1,
  "isAddedToFavorites": false,
  "category": {},
  "imageUrl": {},
  "skusVariation": {},
  "variations": {},
  "multiVariationData": {}
}
```
```

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

### Catalog Services - GET /v3/rest/com/becn/itemlist

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint retrieves a list of items.

```APIDOC
## GET /v3/rest/com/becn/itemlist

### Description
Get list of items

### Method
GET

### Endpoint
/v3/rest/com/becn/itemlist
```

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

### Catalog Services - GET /v3/ctCustomerCatalogDownload

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint downloads a zip file with catalog item data.

```APIDOC
## GET /v3/ctCustomerCatalogDownload

### Description
This endpoint downloads zip file with catalog item data.

### Method
GET

### Endpoint
/v3/ctCustomerCatalogDownload
```

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

### Catalog Services - GET /v2/rest/com/becn/itemDetails

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint retrieves details for an item.

```APIDOC
## GET /v2/rest/com/becn/itemDetails

### Description
Retrieve details for an item

### Method
GET

### Endpoint
/v2/rest/com/becn/itemDetails
```

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

### POST /websites/api_qxo_partner-integrations-service_consolidated-api/v1/rest/com/becn/pricing

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

Retrieves pricing information for a list of SKUs, optionally filtered by UOM. Supports account and job number filtering.

```APIDOC
## POST /v1/rest/com/becn/pricing

### Description
Retrieves pricing information for a list of SKUs, optionally filtered by UOM. Supports account and job number filtering.

### Method
POST

### Endpoint
/v1/rest/com/becn/pricing

### Parameters
#### Query Parameters
- **skuIds** (string) - Required - SKU ID list long string, seperated by commas. If query with UOM(optional), should add UOM after each sku id and seperated by colon. If UOM is empty, will get price of all UOMs for this SKU.
- **accountId** (string) - Optional - Account ID.
- **jobNumber** (string) - Optional - Job Number.

### Request Example
```json
{
  "skuIds": "253729,253737,253740",
  "accountId": "280381",
  "jobNumber": "SHOP"
}
```

### Response
#### Success Response (200)
- **messageCode** (string) - Message code for operation status.
- **message** (string) - Message for operation status.
- **priceInfo** (object) - Contains SKU ID, UOM, and Price pairs.

#### Response Example
```json
{
  "messageCode": "1001",
  "message": "Validation exception",
  "priceInfo": {
    "253729": {
      "BDL": 125.67,
      "PC": 10.86
    },
    "253737": {
      "CTN": 3663.22
    },
    "253740": {
      "CTN": 2384.34,
      "PC": 834.43
    }
  }
}
```
```

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

### Catalog Services - GET /v2/rest/com/becn/itemlist

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint retrieves a list of items.

```APIDOC
## GET /v2/rest/com/becn/itemlist

### Description
Get list of items

### Method
GET

### Endpoint
/v2/rest/com/becn/itemlist
```

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

### Catalog Services - GET /v1/rest/com/becn/items

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint retrieves a list of items.

```APIDOC
## GET /v1/rest/com/becn/items

### Description
Get list of items

### Method
GET

### Endpoint
/v1/rest/com/becn/items
```

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

### POST /v1/rest/com/becn/login

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/-json

User login endpoint. Authenticate users with their username and password to obtain an access token and customer details.

```APIDOC
## POST /v1/rest/com/becn/login

### Description
Login with userName and password to get the token and Customer details.

### Method
POST

### Endpoint
/v1/rest/com/becn/login

### Parameters
#### Request Body
- **username** (string) - Required - The user's username.
- **password** (string) - Required - The user's password.

### Request Example
```json
{
  "username": "user@example.com",
  "password": "your_password"
}
```

### Response
#### Success Response (200)
- **token** (string) - The authentication token.
- **customerDetails** (object) - Details about the customer.

#### Response Example
```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "customerDetails": {
    "customerId": "12345",
    "name": "Example Corp"
  }
}
```
```

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

### Catalog Services - GET /v1/rest/com/becn/itemlist

Source: https://api.qxo.com/partner-integrations-service/consolidated-api/index

This endpoint retrieves a list of items.

```APIDOC
## GET /v1/rest/com/becn/itemlist

### Description
Get list of items

### Method
GET

### Endpoint
/v1/rest/com/becn/itemlist
```