openapi: 3.1.0 info: title: Commerce Layer addresses sku_options 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_options description: resource type paths: /line_item_options/{lineItemOptionId}/sku_option: get: operationId: GET/lineItemOptionId/sku_option summary: Retrieve the sku option associated to the line item option description: Retrieve the sku option associated to the line item option tags: - sku_options parameters: - name: lineItemOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_option associated to the line item option /sku_options: get: operationId: GET/sku_options summary: List all SKU options description: List all SKU options tags: - sku_options responses: '200': description: A list of SKU option objects content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuOptionResponseList' post: operationId: POST/sku_options summary: Create a SKU option description: Create a SKU option tags: - sku_options requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuOptionCreate' responses: '201': description: The created SKU option object content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuOptionResponse' /sku_options/{skuOptionId}: get: operationId: GET/sku_options/skuOptionId summary: Retrieve a SKU option description: Retrieve a SKU option tags: - sku_options parameters: - name: skuOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The SKU option object content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuOptionResponse' patch: operationId: PATCH/sku_options/skuOptionId summary: Update a SKU option description: Update a SKU option tags: - sku_options parameters: - name: skuOptionId in: path schema: type: string required: true description: The resource's id requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuOptionUpdate' responses: '200': description: The updated SKU option object content: application/vnd.api+json: schema: $ref: '#/components/schemas/skuOptionResponse' delete: operationId: DELETE/sku_options/skuOptionId summary: Delete a SKU option description: Delete a SKU option tags: - sku_options parameters: - name: skuOptionId in: path schema: type: string required: true description: The resource's id responses: '204': description: No content /skus/{skuId}/sku_options: get: operationId: GET/skuId/sku_options summary: Retrieve the sku options associated to the SKU description: Retrieve the sku options associated to the SKU tags: - sku_options parameters: - name: skuId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_options associated to the SKU components: schemas: skuOptionResponseList: type: object properties: data: type: array items: $ref: '#/components/schemas/skuOptionResponse/properties/data' skuOptionUpdate: required: - data type: object properties: data: type: object required: - type - id - attributes properties: type: type: string description: The resource's type enum: - sku_options id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attributes: type: object properties: name: type: string description: The SKU option's internal name. example: Embossing nullable: false currency_code: type: string description: The international 3-letter currency code as defined by the ISO 4217 standard. example: EUR nullable: true description: type: string description: An internal description of the SKU option. example: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. nullable: true price_amount_cents: type: integer description: The price of this shipping method, in cents. example: 1000 nullable: true delay_hours: type: integer description: The delay time (in hours) that should be added to the delivery lead time when this option is purchased. example: 48 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 _add_tags: type: string description: Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels. _remove_tags: type: string description: Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels. 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: market: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN tags: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tags id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN skuOptionResponse: 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_options links: type: object properties: self: type: string description: URL attributes: $ref: '#/components/schemas/skuOption/properties/data/properties/attributes' relationships: type: object properties: market: 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: - market 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 events: 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: - events id: type: string description: The resource ID tags: 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: - tags 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 skuOptionCreate: required: - data type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - sku_options attributes: type: object properties: name: type: string description: The SKU option's internal name. example: Embossing currency_code: type: string description: The international 3-letter currency code as defined by the ISO 4217 standard. example: EUR description: type: string description: An internal description of the SKU option. example: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. price_amount_cents: type: integer description: The price of this shipping method, in cents. example: 1000 delay_hours: type: integer description: The delay time (in hours) that should be added to the delivery lead time when this option is purchased. example: 48 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: market: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN tags: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tags id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN skuOption: properties: data: properties: attributes: type: object properties: name: type: string description: The SKU option's internal name. example: Embossing nullable: false currency_code: type: string description: The international 3-letter currency code as defined by the ISO 4217 standard. example: EUR nullable: true description: type: string description: An internal description of the SKU option. example: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. nullable: true price_amount_cents: type: integer description: The price of this shipping method, in cents. example: 1000 nullable: true price_amount_float: type: number description: The price of this shipping method, float. example: 10.0 nullable: true formatted_price_amount: type: string description: The price of this shipping method, formatted. example: €10,00 nullable: true delay_hours: type: integer description: The delay time (in hours) that should be added to the delivery lead time when this option is purchased. example: 48 nullable: true delay_days: type: integer description: The delay time, in days (rounded). example: 2 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