Unpublish Document
Unpublish a document.
post
/v1/catalog/products/{productId}/documents/{id}/unpublish
Path parameters
productIdstringrequired
idstringrequired
Responses
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
--request POST \
--url '/v1/catalog/products/{productId}/documents/{id}/unpublish'200
400
403
404
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-21T18:25:44.954Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-21T18:25:44.954Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-21T18:25:44.954Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-21T18:25:44.954Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": "[Circular Reference]"
},
"logo": "text",
"isDefault": true,
"modules": [
"[Circular Reference]"
],
"users": [
"[Circular Reference]"
],
"buyers": [
"[Circular Reference]"
]
}
]
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
}OK
Last updated
Was this helpful?