openapi: 3.1.0 info: title: Commerce Layer addresses sku_lists API version: 7.10.1 contact: name: API Support url: https://commercelayer.io email: support@commercelayer.io description: Headless Commerce for Global Brands. servers: - url: https://{your_organization_slug}.commercelayer.io/api description: API - url: https://core.commercelayer.io/users/sign_in description: Sign in - url: https://docs.commercelayer.io/api description: API reference security: - bearerAuth: [] tags: - name: sku_lists description: resource type paths: /bundles/{bundleId}/sku_list: get: operationId: GET/bundleId/sku_list summary: Retrieve the sku list associated to the bundle description: Retrieve the sku list associated to the bundle tags: - sku_lists parameters: - name: bundleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the bundle /buy_x_pay_y_promotions/{buyXPayYPromotionId}/sku_list: get: operationId: GET/buyXPayYPromotionId/sku_list summary: Retrieve the sku list associated to the buy x pay y promotion description: Retrieve the sku list associated to the buy x pay y promotion tags: - sku_lists parameters: - name: buyXPayYPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the buy x pay y promotion /customers/{customerId}/sku_lists: get: operationId: GET/customerId/sku_lists summary: Retrieve the sku lists associated to the customer description: Retrieve the sku lists associated to the customer tags: - sku_lists parameters: - name: customerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_lists associated to the customer /external_promotions/{externalPromotionId}/sku_list: get: operationId: GET/externalPromotionId/sku_list summary: Retrieve the sku list associated to the external promotion description: Retrieve the sku list associated to the external promotion tags: - sku_lists parameters: - name: externalPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the external promotion /fixed_amount_promotions/{fixedAmountPromotionId}/sku_list: get: operationId: GET/fixedAmountPromotionId/sku_list summary: Retrieve the sku list associated to the fixed amount promotion description: Retrieve the sku list associated to the fixed amount promotion tags: - sku_lists parameters: - name: fixedAmountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the fixed amount promotion /fixed_price_promotions/{fixedPricePromotionId}/sku_list: get: operationId: GET/fixedPricePromotionId/sku_list summary: Retrieve the sku list associated to the fixed price promotion description: Retrieve the sku list associated to the fixed price promotion tags: - sku_lists parameters: - name: fixedPricePromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the fixed price promotion /free_gift_promotions/{freeGiftPromotionId}/sku_list: get: operationId: GET/freeGiftPromotionId/sku_list summary: Retrieve the sku list associated to the free gift promotion description: Retrieve the sku list associated to the free gift promotion tags: - sku_lists parameters: - name: freeGiftPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the free gift promotion /free_shipping_promotions/{freeShippingPromotionId}/sku_list: get: operationId: GET/freeShippingPromotionId/sku_list summary: Retrieve the sku list associated to the free shipping promotion description: Retrieve the sku list associated to the free shipping promotion tags: - sku_lists parameters: - name: freeShippingPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the free shipping promotion /percentage_discount_promotions/{percentageDiscountPromotionId}/sku_list: get: operationId: GET/percentageDiscountPromotionId/sku_list summary: Retrieve the sku list associated to the percentage discount promotion description: Retrieve the sku list associated to the percentage discount promotion tags: - sku_lists parameters: - name: percentageDiscountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the percentage discount promotion /promotions/{promotionId}/sku_list: get: operationId: GET/promotionId/sku_list summary: Retrieve the sku list associated to the promotion description: Retrieve the sku list associated to the promotion tags: - sku_lists parameters: - name: promotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the promotion /sku_list_items/{skuListItemId}/sku_list: get: operationId: GET/skuListItemId/sku_list summary: Retrieve the sku list associated to the SKU list item description: Retrieve the sku list associated to the SKU list item tags: - sku_lists parameters: - name: skuListItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the SKU list item /sku_list_promotion_rules/{skuListPromotionRuleId}/sku_list: get: operationId: GET/skuListPromotionRuleId/sku_list summary: Retrieve the sku list associated to the SKU list promotion rule description: Retrieve the sku list associated to the SKU list promotion rule tags: - sku_lists parameters: - name: skuListPromotionRuleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the SKU list promotion rule /sku_lists: get: operationId: GET/sku_lists summary: List all SKU lists description: List all SKU lists tags: - sku_lists responses: '200': description: A list of SKU list objects content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuListResponseList' post: operationId: POST/sku_lists summary: Create a SKU list description: Create a SKU list tags: - sku_lists requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuListCreate' responses: '201': description: The created SKU list object content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuListResponse' /sku_lists/{skuListId}: get: operationId: GET/sku_lists/skuListId summary: Retrieve a SKU list description: Retrieve a SKU list tags: - sku_lists parameters: - name: skuListId in: path schema: type: string required: true description: The resource's id responses: '200': description: The SKU list object content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuListResponse' patch: operationId: PATCH/sku_lists/skuListId summary: Update a SKU list description: Update a SKU list tags: - sku_lists parameters: - name: skuListId in: path schema: type: string required: true description: The resource's id requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuListUpdate' responses: '200': description: The updated SKU list object content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuListResponse' delete: operationId: DELETE/sku_lists/skuListId summary: Delete a SKU list description: Delete a SKU list tags: - sku_lists parameters: - name: skuListId in: path schema: type: string required: true description: The resource's id responses: '204': description: No content /skus/{skuId}/sku_lists: get: operationId: GET/skuId/sku_lists summary: Retrieve the sku lists associated to the SKU description: Retrieve the sku lists associated to the SKU tags: - sku_lists parameters: - name: skuId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_lists associated to the SKU components: schemas: skuListUpdate: required: - data type: object properties: data: type: object required: - type - id - attributes properties: type: type: string description: The resource's type enum: - sku_lists id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attributes: type: object properties: name: type: string description: The SKU list's internal name. example: Personal list nullable: false description: type: string description: An internal description of the SKU list. example: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. nullable: true image_url: type: string description: The URL of an image that represents the SKU list. example: https://img.yourdomain.com/skus/xYZkjABcde.png nullable: true manual: type: boolean description: Indicates if the SKU list is populated manually. example: false nullable: false sku_code_regex: type: string description: The regex that will be evaluated to match the SKU codes, max size is 5000. example: ^(A|B).*$ nullable: true reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: customer: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN skuListResponse: type: object properties: data: type: object properties: id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN type: type: string description: The resource's type enum: - sku_lists links: type: object properties: self: type: string description: URL attributes: $ref: '#/components/schemas/skuList/properties/data/properties/attributes' relationships: type: object properties: customer: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - customer id: type: string description: The resource ID skus: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - skus id: type: string description: The resource ID sku_list_items: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - sku_list_items id: type: string description: The resource ID bundles: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - bundles id: type: string description: The resource ID attachments: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: The resource ID links: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - links id: type: string description: The resource ID event_stores: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: The resource ID skuListCreate: required: - data type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - sku_lists attributes: type: object properties: name: type: string description: The SKU list's internal name. example: Personal list description: type: string description: An internal description of the SKU list. example: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. image_url: type: string description: The URL of an image that represents the SKU list. example: https://img.yourdomain.com/skus/xYZkjABcde.png manual: type: boolean description: Indicates if the SKU list is populated manually. example: false sku_code_regex: type: string description: The regex that will be evaluated to match the SKU codes, max size is 5000. example: ^(A|B).*$ reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar required: - name relationships: type: object properties: customer: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN skuListResponseList: type: object properties: data: type: array items: $ref: '#/components/schemas/skuListResponse/properties/data' skuList: properties: data: properties: attributes: type: object properties: name: type: string description: The SKU list's internal name. example: Personal list nullable: false slug: type: string description: The SKU list's internal slug. example: personal-list-1 nullable: false description: type: string description: An internal description of the SKU list. example: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. nullable: true image_url: type: string description: The URL of an image that represents the SKU list. example: https://img.yourdomain.com/skus/xYZkjABcde.png nullable: true manual: type: boolean description: Indicates if the SKU list is populated manually. example: false nullable: true sku_code_regex: type: string description: The regex that will be evaluated to match the SKU codes, max size is 5000. example: ^(A|B).*$ nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT