CrossEngage Product Feed API

openapi: 3.2.0
info:
  version: '1.0'
  title: Product Feed API
  description: The Product feed API allows you to fetch, upload, edit and delete your products in real-time.
servers:
- url: https://api.crossengage.io/product-feed/v1
tags:
- name: product-feed
paths:
  /product:
    get:
      tags:
      - product-feed
      summary: Get products with pagination
      description: 'When requesting a list of products, you may include the `pageNumber` and `pageSize` as parameters.

        By default, you will fetch the first page with 10 products (displayed in Response: pageNumber 0).'
      operationId: getProductsPage
      parameters:
      - name: pageNumber
        description: (optional) the page number. Example `1`.
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: pageSize
        description: (optional) the number of products to be returned on one page. Example `100`
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        200:
          description: A list of products with pagination
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductPage'
  /product/{sku}:
    get:
      tags:
      - product-feed
      summary: Get a single product
      description: 'Get a single product by `sku` or `sku` and `businessUnit`


        * In case, you’re using both `sku` and `businessUnit` as a combined identifier for your products, please provide both of them here.

        * If only `sku` is provided, we will look for a product with that `sku` and an empty `businessUnit`.'
      operationId: getProductBySku
      parameters:
      - name: sku
        description: (required) the product SKU. Examples `123` or `LNK1230098`
        in: path
        required: true
        schema:
          type: string
      - name: businessUnit
        description: (optional) will be used as a part of the product identifier together with ‘sku’ when provided. Example `DE`
        in: query
        required: false
        schema:
          type: string
      responses:
        200:
          description: A single product
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
        404:
          description: The product was not found by `sku` and `business unit`
    put:
      tags:
      - product-feed
      summary: Updates or create a single product
      description: '* To create a new product include `sku` or `sku` and `businessUnit` to the JSON body.

        * To update information about a product include `sku` or `sku` and `businessUnit` of that product to the JSON body. All properties will be updated, missing properties will be removed.

        * Custom attributes can be added as a string type to the product.'
      operationId: updateOrCreateProduct
      parameters:
      - name: sku
        description: (required) the part of the product identifier. Examples `123` or `LNK1230098`
        in: path
        required: true
        schema:
          type: string
      responses:
        202:
          description: Update was scheduled
        400:
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        415:
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Product'
        description: (required) it should be in JSON format
        required: true
    delete:
      tags:
      - product-feed
      summary: Delete a single product
      description: 'Delete a single product by `sku` or `sku` and `businessUnit`

        * A product will be deleted if `sku` or `sku` and `businessUnit` match a product in the system.'
      operationId: deleteProductBySku
      parameters:
      - name: sku
        description: (required) a part of the product identifier. Examples `123` or `LNK1230098`
        in: path
        required: true
        schema:
          type: string
      - name: businessUnit
        description: (optional) will be used as a part of the product identifier together with ‘sku’ when provided. Example `DE`
        in: query
        required: false
        schema:
          type: string
      responses:
        202:
          description: Product deletion was scheduled
components:
  schemas:
    ProductPage:
      description: a standard page object
      properties:
        pageNumber:
          type: integer
          format: int32
          readOnly: true
          example: 0
        pageSize:
          example: 10
          type: integer
          format: int32
          readOnly: true
        totalElements:
          example: 1
          type: integer
          format: int32
          readOnly: true
        content:
          type: array
          items:
            $ref: '#/components/schemas/Product'
      example:
        pageNumber: 0
        pageSize: 10
        totalElements: 1
        content:
        - id: 123
          sku: 56874
          businessUnit: DE
          title: Data-Decision-Delivery Pillow
          description: Extra cozy pillow
          link: https://demo.crossengage.io/product/data-decision-delivery-pillow/
          bigImageLink: https://demo.crossengage.io/wp-content/uploads/2019/05/5586-big.jpg
          smallImageLink: https://demo.crossengage.io/wp-content/uploads/2019/05/5586.jpg
          category: Pilow
          price: 10.0
          salesPrice: 8.5
          salesPriceEffectiveDate: the sale will run until Friday
          discount: -15%
          currency: €
          stockQuantity: 120
          enabled: 1
          attributes:
            colour: Black
            material: Plush
          createdAt: '2020-01-02T16:00:03.449Z'
          updatedAt: '2020-04-21T17:00:03.449Z'
    Error:
      description: Error response
      type: object
      readOnly: true
      properties:
        message:
          description: error message
          type: string
          example: Input validation failed
        key:
          description: 'Dot-separated error key (for example `error.input-validation`).

            '
          type: string
          example: error.input-validation
        args:
          description: 'arguments for the key (example: min=2, max=10, value="some string value" etc.)

            '
          type: object
          additionalProperties:
            type: string
        errors:
          description: list of parameter-related or field-related errors. One field may have several errors.
          type: array
          items:
            $ref: '#/components/schemas/ErrorItem'
    ErrorItem:
      type: object
      readOnly: true
      properties:
        source:
          description: param/field name or path (for instance SomeObject.someField.someOtherField)
          type: string
          example: productDTO.sku
        key:
          description: 'Dot-separated error key (for example `error.constraint-violation.Size`).

            '
          type: string
          example: error.constraint-violation.NotNull
        message:
          description: error message
          type: string
          example: must not be null
        args:
          description: 'arguments for key (example: min=2, max=10, value="some string value" etc.)

            '
          type: object
          additionalProperties:
            type: string
    Product:
      type: object
      description: 'Product data. The unique identifier for the product is a combination of `sku` and `businessUnit`.

        `sku` is the only required field. `businessUnit` is optional.

        Additional fields, not present in the current specification, may be added.

        There is only one limitation - those fields should be of string type.

        '
      properties:
        id:
          type: string
          description: Original product id.
          example: 123
        sku:
          type: string
          description: Product SKU. `sku` together with `businessUnit` serves as a unique product identifier. Required.
          maxLength: 200
          example: 56874
        businessUnit:
          description: Product business unit. `businessUnit` together with `sku` serves as a unique product identifier. Optional.
          example: DE
          type: string
          maxLength: 200
        title:
          description: A product's title.
          type: string
          example: Data-Decision-Delivery Pillow
        description:
          description: A product's description.
          type: string
          example: Extra cozy pillow
        link:
          description: Absolute URL to a product's page.
          type: string
          example: https://demo.crossengage.io/product/data-decision-delivery-pillow/
        bigImageLink:
          description: Absolute URL to a product's larger image.
          type: string
          example: https://demo.crossengage.io/wp-content/uploads/2019/05/5586-big.jpg
        smallImageLink:
          description: Absolute URL to a product's thumbnail image.
          type: string
          example: https://demo.crossengage.io/wp-content/uploads/2019/05/5586.jpg
        category:
          description: Product category.
          type: string
          example: Pilow
        price:
          description: The price of the product without currency.
          type: number
          format: double
          example: 10.0
        salesPrice:
          description: The advertised sale price of the product.
          type: number
          format: double
          example: 8.5
        salesPriceEffectiveDate:
          type: string
          example: the sale will run until Friday
        discount:
          description: The difference between the original price and the discounted price (if set). e.g `-20%` or `20 €`
          type: string
          example: -15%
        currency:
          description: The currency of the prices.
          type: string
          example: €
        stockQuantity:
          description: The number of items in stock.
          type: integer
          format: int32
          example: 120
        enabled:
          description: Represents whether or not the product can be used in marketing communications.
          type: integer
          format: int32
          example: 1
        attributes:
          description: An object representing additional product attributes not covered by the default set. All additional attributes must be written in `camel-сase` format. e.g. `{ "colour":"Black", "material":"Plush" }`
          type: object
          additionalProperties:
            type: string
          example:
            colour: White
            clothMaterial: Plush
        createdAt:
          type: string
          format: date-time
          readOnly: true
          description: The timestamp of when the product was created, this cannot be edited
          example: '2020-01-02T16:00:03.449Z'
        updatedAt:
          type: string
          format: date-time
          readOnly: true
          description: The timestamp of when the product was updated, this cannot be edited
          example: '2020-04-21T17:00:03.449Z'
      required:
      - sku
      example:
        id: 123
        sku: 56874
        businessUnit: DE
        title: Data-Decision-Delivery Pillow
        description: Extra cozy pillow
        link: https://demo.crossengage.io/product/data-decision-delivery-pillow/
        bigImageLink: https://demo.crossengage.io/wp-content/uploads/2019/05/5586-big.jpg
        smallImageLink: https://demo.crossengage.io/wp-content/uploads/2019/05/5586.jpg
        category: Pilow
        price: 10
        salesPrice: 8.5
        salesPriceEffectiveDate: the sale will run until Friday
        discount: -15%
        currency: €
        stockQuantity: 120
        enabled: 1
        attributes:
          colour: Black
          material: Plush
        createdAt: '2020-01-02T16:00:03.449Z'
        updatedAt: '2020-04-21T17:00:03.449Z'