imports

Create an import

Changed on

Create an import

post/imports

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/imports
  • Auth
    HTTP bearer

Request body

Example request

{
  "data": {
    "attributes": {
      "resource_type": "skus",
      "format": "json",
      "parent_resource_id": "1234",
      "inputs": [
        {
          "code": "ABC",
          "name": "Foo"
        },
        {
          "code": "DEF",
          "name": "Bar"
        }
      ],
      "cleanup_records": true,
      "skip_errors": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    }
  }
}

Response

The created import object

Changes

    • breaking

      request property // was restricted to a list of enum values

    • breaking

      request property / was restricted to a list of enum values

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property default value imports was removed

    • info

      added the new addresses enum value to the request property //

    • info

      added the new bundles enum value to the request property //

    • info

      added the new coupons enum value to the request property //

    • info

      added the new customer_addresses enum value to the request property //

    • info

      added the new customer_payment_sources enum value to the request property //

    • info

      added the new customer_subscriptions enum value to the request property //

    • info

      added the new customers enum value to the request property //

    • info

      added the new gift_cards enum value to the request property //

    • info

      added the new imports enum value to the request property /

    • info

      added the new line_item_options enum value to the request property //

    • info

      added the new line_items enum value to the request property //

    • info

      added the new orders enum value to the request property //

    • info

      added the new price_lists enum value to the request property //

    • info

      added the new price_tiers enum value to the request property //

    • info

      added the new prices enum value to the request property //

    • info

      added the new shipping_categories enum value to the request property //

    • info

      added the new sku_list_items enum value to the request property //

    • info

      added the new sku_lists enum value to the request property //

    • info

      added the new sku_options enum value to the request property //

    • info

      added the new skus enum value to the request property //

    • info

      added the new stock_items enum value to the request property //

    • info

      added the new stock_locations enum value to the request property //

    • info

      added the new stock_transfers enum value to the request property //

    • info

      added the new tags enum value to the request property //

    • info

      added the new tax_categories enum value to the request property //

    • info

      added the media type application/vnd.api+json for the response with the status