openapi: 3.0.3 info: title: Havenly Addresses Board Products API version: 1.0.0 description: 'Havenly REST API powering the interior-design platform: users and profiles, addresses, design boards and board products, vendor product variants (catalog), attribute types, board feedback, and user opinions/likes. Responses use HAL+JSON (_links/_embedded) with page/limit pagination and zf-doctrine-querybuilder query filters. Authentication is OAuth2 (password grant) returning a Bearer token; payment testing in non-production uses Stripe test cards. Derived from Havenly public Postman API documentation at https://api-docs.havenly.com.' contact: email: developers@havenly.com url: https://api-docs.havenly.com/ servers: - url: https://api.havenly.com description: Production security: - bearerAuth: [] tags: - name: Board Products paths: /board-products: post: operationId: createBoardProduct summary: Create Board Product tags: - Board Products responses: '200': description: Successful response '401': description: Unauthorized description: Route used to add a product to a board. requestBody: required: true content: application/json: schema: type: object example: recommendedQty: 5 board: 52087 vendorVariant: 7759999 status: 2 security: - bearerAuth: [] /board-products/{id}: get: operationId: getASpecificBoardProductById summary: Get a Specific Board Product by ID tags: - Board Products responses: '200': description: Successful response '401': description: Unauthorized description: Get a specific board product by board product ID parameters: - name: id in: path required: true schema: type: integer requestBody: required: true content: application/json: schema: type: object example: recommendedQty: 5 board_id: 29781 vendor_variant_id: 1 security: - bearerAuth: [] /board-products-lite/{id}: get: operationId: getABoardProductById summary: Get a Board Product by ID (lite) tags: - Board Products responses: '200': description: OK content: application/json: schema: type: object example: id: 1584482 created: date: '2017-05-04 13:56:58.000000' timezone_type: 3 timezone: UTC boardId: 56073 designerId: 11676 recommendedQty: 1 subForVendorVariantId: 8099206 boardProductStatusId: 2 _embedded: vendorVariant: id: 6584313 sku: '108224' title: line work rug 6'x6' description: 'power grid. Inspired by the strict linear geometry of city electrical lines, Molly Fitzpatrick of DittoRepeats designed a pattern to disrupt the order. "I started with a basic grid and broke it by adding tilted lines that bisect the rigid straight ones." Originally created as a digital file, master rug makers brought the design to life by hand-tufting the pattern on with chunky, twisted wool yarn. The result is an extra thick pile that adds modern warmth and cozy texture to any space.How will it look in your room? 12"x12" rug samples are available in stores for a fee refundable upon return of the sample. • Designed by Molly Fitzpatrick of DittoRepeats • Hand-tufted • 100% New Zealand/Indian wool blend • All surface rug pad recommended • Vacuum regularly; professional cleaning recommended • Made in India ' color: Black and cream dimensions: 6' sq. material: Wool feedSource: __initializer__: {} __cloner__: {} __isInitialized__: false uri: https://static.havenly.com/product/production/php_58f471db6ed82.jpg shipSurcharge: '0.00' inStock: true backOrdered: false assemblyRequired: false flaggedForReview: true vendorPromotion: null price: 349 shippingType: null salePrice: null saleStartDate: null saleEndDate: null wholesalePrice: null availabilities: {} isSavable: true isReturnable: true isHidden: false discountedPrice: null etaText: CB2 typically ships in-stock items in 3 to 5 business days. promotion: null shippingPromotion: null attributeFamilies: - id: 2 name: Geometric parentId: 1 - id: 1 name: Pattern parentId: null - id: 84 name: Wool parentId: 68 - id: 68 name: Fabric parentId: 28 - id: 28 name: Material parentId: null - id: 125 name: Black parentId: 117 - id: 117 name: Color parentId: null - id: 127 name: Beige parentId: 117 - id: 155 name: Square parentId: 138 - id: 138 name: Size/shape parentId: null linkUri: http://www.cb2.com/line-work-rug-6x6/s108224 taxonomyCategories: [] userData: cart: id: null cartProductId: null quantity: 0 registry: id: null registryProductId: null quantity: 0 userOpinion: 0 isPurchased: false activeRooms: [] _embedded: product_variant: id: 584260 upc: null asin: null _embedded: hav_product: id: 5787489 title: line work rug 6'x6' description: power grid. Inspired by the strict linear geometry of city electrical lines, Molly Fitzpatrick of DittoRepeats designed a pattern to disrupt the order. "I started with a basic grid and broke it by adding tilted lines that bisect the rigid straight ones." brand: null _links: self: href: http://api.havenly.local/hav-products/5787489 _links: self: href: http://api.havenly.local/product-variants/584260 vendor: id: 4 name: CB2 isWholeSale: false affiliateLink: null _links: self: href: http://api.havenly.local/vendor/4 taxonomy: id: 5374 title: Home & Garden parentId: null ancestors: [] _links: self: href: http://api.havenly.local/taxonomies/5374 images: - id: 7709932 name: php_58f471db6ed82.jpg title: null size: 222802 mimeType: image/jpeg md5: d4afedf6b24c1eb32c1dce51ca7067fa uri: https://static.havenly.com/product/production/php_58f471db6ed82.jpg user: null _embedded: messages: [] _links: self: href: http://api.havenly.local/files/7709932 subsets: [] inventoryType: id: 3 title: Regular _links: self: href: http://api.havenly.local/inventory-types/3 _links: self: href: http://api.havenly.local/vendor-variants-lite/6584313 _links: self: href: http://api.havenly.local/board-products-lite/1584482 '401': description: Unauthorized description: 'Get a specific board product by board product ID This endpoint is a lighter/flatter payload in response. For the full HalJson representation use the main endpoint. We built these lighter endpoints to better support the FE team in building faster UIs' parameters: - name: id in: path required: true schema: type: integer requestBody: required: true content: application/json: schema: type: object example: recommendedQty: 5 board_id: 29781 vendor_variant_id: 1 security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'OAuth2 access token from POST /oauth (password grant), sent as Authorization: Bearer .' oauth2: type: oauth2 flows: password: tokenUrl: https://api.havenly.com/oauth scopes: {}