Get Document

Gets a document by ID.

GET/v1/catalog/products/{productId}/documents/{id}

Path parameters

productId*string

id*string

Query parameters

Response

200301400404

OK

Body

application/json

idstring

auditQueryModelAudit (object)

$metaQueryModelMetadata (object)

hrefstring

namestring

typestring

descriptionstring

statusstring

filenamenullable string

sizenullable integer (int32)

contentTypestring

urlstring

languagestring

productProductQueryModel (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/catalog/products/{productId}/documents/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-01-23T13:12:59.105Z",
      "by": {
        "id": "text",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-01-23T13:12:59.105Z",
      "by": {
        "id": "text",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "name": "text",
  "type": "text",
  "description": "text",
  "status": "text",
  "filename": "text",
  "size": 0,
  "contentType": "text",
  "url": "text",
  "language": "text",
  "product": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-01-23T13:12:59.105Z",
        "by": {
          "id": "text",
          "audit": {},
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-01-23T13:12:59.105Z",
        "by": {
          "id": "text",
          "audit": {},
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "published": {
        "at": "2025-01-23T13:12:59.105Z",
        "by": {
          "id": "text",
          "audit": {},
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "pending": {
        "at": "2025-01-23T13:12:59.105Z",
        "by": {
          "id": "text",
          "audit": {},
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "unpublished": {
        "at": "2025-01-23T13:12:59.105Z",
        "by": {
          "id": "text",
          "audit": {},
          "$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-01-23T13:12:59.105Z",
          "by": {
            "id": "text",
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-01-23T13:12:59.105Z",
          "by": {
            "id": "text",
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "href": "text",
      "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": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-01-23T13:12:59.105Z",
              "by": {
                "id": "text",
                "$meta": {
                  "omitted": [
                    "text"
                  ]
                },
                "href": "text",
                "name": "text",
                "icon": "text"
              }
            },
            "updated": {
              "at": "2025-01-23T13:12:59.105Z",
              "by": {
                "id": "text",
                "$meta": {
                  "omitted": [
                    "text"
                  ]
                },
                "href": "text",
                "name": "text",
                "icon": "text"
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "description": "text",
          "modules": [
            {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-01-23T13:12:59.105Z",
                  "by": {
                    "id": "text",
                    "$meta": {
                      "omitted": [
                        "text"
                      ]
                    },
                    "href": "text",
                    "name": "text",
                    "icon": "text"
                  }
                },
                "updated": {
                  "at": "2025-01-23T13:12:59.105Z",
                  "by": {
                    "id": "text",
                    "$meta": {
                      "omitted": [
                        "text"
                      ]
                    },
                    "href": "text",
                    "name": "text",
                    "icon": "text"
                  }
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "description": "text",
              "name": "text",
              "accountTypes": [
                "text"
              ],
              "filters": {
                "group.buyers": [
                  "text"
                ]
              },
              "settings": {
                "sharedAccount": false,
                "configurable": false,
                "default": false,
                "paid": false,
                "type": [
                  "text"
                ]
              }
            }
          ],
          "logo": "text",
          "isDefault": false,
          "users": [
            {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-01-23T13:12:59.105Z",
                  "by": {
                    "id": "text",
                    "audit": {},
                    "$meta": {
                      "omitted": [
                        "text"
                      ]
                    },
                    "href": "text",
                    "name": "text",
                    "icon": "text"
                  }
                },
                "updated": {
                  "at": "2025-01-23T13:12:59.105Z",
                  "by": {
                    "id": "text",
                    "audit": {},
                    "$meta": {
                      "omitted": [
                        "text"
                      ]
                    },
                    "href": "text",
                    "name": "text",
                    "icon": "text"
                  }
                },
                "invitationAcceptedAt": "2025-01-23T13:12:59.105Z"
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "email": "text",
              "status": "text",
              "phone": {
                "prefix": "text",
                "number": "text"
              },
              "firstName": "text",
              "lastName": "text",
              "icon": "text",
              "lastLoginAt": "2025-01-23T13:12:59.105Z",
              "settings": {
                "cultureCode": "text",
                "languageCode": "text"
              },
              "name": "text",
              "accounts": []
            }
          ],
          "buyers": [
            {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-01-23T13:12:59.105Z",
                  "by": {
                    "id": "text",
                    "audit": {},
                    "$meta": {
                      "omitted": [
                        "text"
                      ]
                    },
                    "href": "text",
                    "name": "text",
                    "icon": "text"
                  }
                },
                "updated": {
                  "at": "2025-01-23T13:12:59.105Z",
                  "by": {
                    "id": "text",
                    "audit": {},
                    "$meta": {
                      "omitted": [
                        "text"
                      ]
                    },
                    "href": "text",
                    "name": "text",
                    "icon": "text"
                  }
                },
                "activated": {
                  "at": "2025-01-23T13:12:59.105Z",
                  "by": {
                    "id": "text",
                    "audit": {},
                    "$meta": {
                      "omitted": [
                        "text"
                      ]
                    },
                    "href": "text",
                    "name": "text",
                    "icon": "text"
                  }
                },
                "unassigned": {
                  "at": "2025-01-23T13:12:59.105Z",
                  "by": {
                    "id": "text",
                    "audit": {},
                    "$meta": {
                      "omitted": [
                        "text"
                      ]
                    },
                    "href": "text",
                    "name": "text",
                    "icon": "text"
                  }
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "contact": {
                "name": "text",
                "firstName": "text",
                "lastName": "text",
                "email": "[e-mail]",
                "phone": {
                  "prefix": "text",
                  "number": "text"
                },
                "user": {
                  "id": "text",
                  "audit": {
                    "created": {
                      "at": "2025-01-23T13:12:59.105Z",
                      "by": {
                        "id": "text",
                        "audit": {},
                        "$meta": {
                          "omitted": [
                            "text"
                          ]
                        },
                        "href": "text",
                        "name": "text",
                        "icon": "text"
                      }
                    },
                    "updated": {
                      "at": "2025-01-23T13:12:59.105Z",
                      "by": {
                        "id": "text",
                        "audit": {},
                        "$meta": {
                          "omitted": [
                            "text"
                          ]
                        },
                        "href": "text",
                        "name": "text",
                        "icon": "text"
                      }
                    },
                    "invitationAcceptedAt": "2025-01-23T13:12:59.105Z"
                  },
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "email": "text",
                  "status": "text",
                  "phone": {
                    "prefix": "text",
                    "number": "text"
                  },
                  "firstName": "text",
                  "lastName": "text",
                  "icon": "text",
                  "lastLoginAt": "2025-01-23T13:12:59.105Z",
                  "settings": {
                    "cultureCode": "text",
                    "languageCode": "text"
                  },
                  "name": "text",
                  "accounts": []
                },
                "type": "text"
              },
              "externalIds": {
                "erpCompanyContact": "text",
                "erpCustomer": "text",
                "accountExternalId": "text"
              },
              "status": "Active",
              "icon": "text",
              "address": {
                "addressLine1": "text",
                "addressLine2": "text",
                "postCode": "text",
                "city": "text",
                "state": "text",
                "country": "text"
              },
              "taxId": "text",
              "name": "text",
              "errors": [
                {
                  "id": "text",
                  "message": "text"
                }
              ],
              "sellers": [
                {
                  "id": "text",
                  "audit": {
                    "created": {
                      "at": "2025-01-23T13:12:59.105Z",
                      "by": {
                        "id": "text",
                        "$meta": {
                          "omitted": [
                            "text"
                          ]
                        },
                        "href": "text",
                        "name": "text",
                        "icon": "text"
                      }
                    },
                    "updated": {
                      "at": "2025-01-23T13:12:59.105Z",
                      "by": {
                        "id": "text",
                        "$meta": {
                          "omitted": [
                            "text"
                          ]
                        },
                        "href": "text",
                        "name": "text",
                        "icon": "text"
                      }
                    }
                  },
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "externalId": "text",
                  "status": "Active",
                  "icon": "text",
                  "currencies": [
                    "text"
                  ],
                  "address": {
                    "addressLine1": "text",
                    "addressLine2": "text",
                    "postCode": "text",
                    "city": "text",
                    "state": "text",
                    "country": "text"
                  },
                  "name": "text"
                }
              ]
            }
          ]
        }
      ]
    },
    "settings": {
      "productOrdering": false,
      "productRequests": {
        "enabled": false,
        "name": "text",
        "label": "text"
      },
      "itemSelection": false,
      "orderQueueChanges": false,
      "preValidation": {
        "purchaseOrderDraft": false,
        "purchaseOrderQuerying": false,
        "changeOrderDraft": false,
        "terminationOrder": false,
        "productRequest": false
      },
      "splitBilling": {
        "enabled": false,
        "type": "text"
      }
    },
    "statistics": {
      "itemCount": 0,
      "ordersPlacedCount": 0,
      "agreementCount": 0,
      "subscriptionCount": 0,
      "requestCount": 0
    }
  }
}