Add product document

POST/api/products/{productId}/documents

Associates a document with a product.

Path Parameters

productId*string

Product identifier.

Example"prod_123"

Request Body

application/json

Request payload for Add product document.

fileId*string

File identifier to associate as a product document.

Example"file_123"

isTechSpecs?|

Whether the document should be marked as a technical specification.

priority?|||||

Priority used for ordering or selection.

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/products/prod_123/documents" \  -H "Content-Type: application/json" \  -d '{    "fileId": "file_123"  }'

{
  "success": true
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Add product document

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`