# The Product Catalog Import object

## Attributes

- `id` (string)
  The unique identifier for this ProductCatalogImport.

- `object` (string, value is "v2.commerce.product_catalog_import")
  String representing the object’s type. Objects of the same type share the same value of the object field.

- `created` (timestamp)
  The time this ProductCatalogImport was created.

- `feed_type` (enum)
  The type of feed data being imported into the product catalog.
Possible enum values:
  - `inventory`
    Inventory levels and stock availability feed.

  - `pricing`
    Pricing information feed including costs and currency data.

  - `product`
    Product information feed including SKUs, descriptions, and attributes.

- `livemode` (boolean)
  Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

- `metadata` (map)
  Additional information about the object in a structured format.

- `status` (enum)
  The current status of this ProductCatalogImport.
Possible enum values:
  - `awaiting_upload`
    The import is waiting for the file to be uploaded.

  - `failed`
    The import failed and no records were processed.

  - `processing`
    The import is processing the uploaded file.

  - `succeeded`
    The import completed successfully with all records processed.

  - `succeeded_with_errors`
    The import completed but some records failed to process.

- `status_details` (object, nullable)
  Details about the current import status.

  - `status_details.awaiting_upload` (object, nullable)
    Details when the import is awaiting file upload.

    - `status_details.awaiting_upload.upload_url` (object)
      The pre-signed URL information for uploading the catalog file.

      - `status_details.awaiting_upload.upload_url.expires_at` (timestamp)
        The timestamp when the upload URL expires.

      - `status_details.awaiting_upload.upload_url.url` (string)
        The pre-signed URL for uploading the catalog file.

  - `status_details.failed` (object, nullable)
    Details when the import didn’t complete.

    - `status_details.failed.code` (enum)
      The error code for this product catalog processing failure.
Possible enum values:
      - `file_not_found`
        Stripe couldn’t find the import file or it wasn’t uploaded within the required time window.

      - `internal_error`
        An internal error occurred during import processing.

      - `invalid_file`
        Stripe couldn’t process the uploaded file due to parsing errors.

    - `status_details.failed.failure_message` (string)
      A message explaining why the import failed.

    - `status_details.failed.type` (enum)
      The error type for this product catalog processing failure.
Possible enum values:
      - `cannot_proceed`
        The import can’t proceed and requires user action.

      - `transient_failure`
        The import failed due to a transient error and might succeed if retried.

  - `status_details.processing` (object, nullable)
    Details when the import is processing.

    - `status_details.processing.error_count` (int64)
      The number of records that failed to process so far.

    - `status_details.processing.success_count` (int64)
      The number of records processed so far.

  - `status_details.succeeded` (object, nullable)
    Details when the import has succeeded.

    - `status_details.succeeded.success_count` (int64)
      The total number of records processed.

  - `status_details.succeeded_with_errors` (object, nullable)
    Details when the import completed but some records failed to process.

    - `status_details.succeeded_with_errors.error_count` (int64)
      The total number of records that failed to process.

    - `status_details.succeeded_with_errors.error_file` (object)
      A file containing details about all errors that occurred.

      - `status_details.succeeded_with_errors.error_file.content_type` (string)
        The MIME type of the error file.

      - `status_details.succeeded_with_errors.error_file.download_url` (object)
        The pre-signed URL information for downloading the error file.

        - `status_details.succeeded_with_errors.error_file.download_url.expires_at` (timestamp)
          The timestamp when the download URL expires.

        - `status_details.succeeded_with_errors.error_file.download_url.url` (string)
          The pre-signed URL for downloading the error file.

      - `status_details.succeeded_with_errors.error_file.size` (int64)
        The size of the error file in bytes.

    - `status_details.succeeded_with_errors.samples` (array of objects)
      A sample of errors that occurred during processing.

      - `status_details.succeeded_with_errors.samples.id` (string)
        The identifier of the record that failed to process.

      - `status_details.succeeded_with_errors.samples.error_message` (string)
        A description of what went wrong with this record.

      - `status_details.succeeded_with_errors.samples.field` (string)
        The name of the field that caused the error.

      - `status_details.succeeded_with_errors.samples.row` (int64)
        The row number in the import file where the error occurred.

    - `status_details.succeeded_with_errors.success_count` (int64)
      The total number of records processed.

### The Product Catalog Import object

```json
{
  "id": "pcimprt_test_61THl3VA5Zt5cTqbP16T9R4DRrSQbEWmWeLUx7WmOR8K",
  "object": "v2.commerce.product_catalog_import",
  "status": "awaiting_upload",
  "created": "2025-01-01T00:00:00.000Z",
  "status_details": {
    "awaiting_upload": {
      "upload_url": {
        "url": "https://stripeusercontent.com/files/us-west-2/upload/wksp_hb7cNA",
        "expires_at": "2025-01-01T01:00:00.000Z"
      }
    }
  },
  "metadata": {
    "order_id": "12345",
    "source": "api"
  }
}
```