Get Customer Survey

Get a specific customer survey by ID.

GET /commerce/shipments/surveys/{id}

Error

A valid request URL is required to generate request examples

200

{
  "_links": {
    "empty": true
  },
  "attributes": {},
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "entries": [
    {
      "answer": {},
      "question": "<string>"
    }
  ],
  "id": "<string>",
  "shipmentNumber": 123,
  "siteId": 123,
  "tenantId": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

id · string · required

id

Response

200

application/hal+json

OK

_links · Links · object

Show child attributes

attributes · object

Show child attributes

auditInfo · AuditInfo · object

Show child attributes

entries · CustomerSurveyEntry · object[]

Show child attributes

id · string

shipmentNumber · integer<int32>

siteId · integer<int32>

tenantId · integer<int32>