Create customer inquiry - Quivo Docs

Create customer inquiry

curl --request POST \
  --url https://api.quivo.co/customerInquiries \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": "<string>",
  "sellerId": 123,
  "warehouseId": 123,
  "messages": [
    {
      "message": "<string>",
      "attachments": [
        {
          "uuid": "<string>",
          "mimeType": "<string>",
          "filename": "<string>"
        }
      ]
    }
  ],
  "topic": "ONBOARDING",
  "category": "INBOUND",
  "subCategory": "FULFILMENT_WAREHOUSE",
  "parentInquiryId": 123,
  "metaInfo": {}
}
'

{
  "subject": "<string>",
  "sellerId": 123,
  "warehouseId": 123,
  "topic": "ONBOARDING",
  "category": "INBOUND",
  "subCategory": "FULFILMENT_WAREHOUSE",
  "parentInquiryId": 123,
  "metaInfo": {},
  "messages": [
    {
      "category": "RATING_MESSAGE",
      "created": "2023-11-07T05:31:56Z",
      "postedAt": "2023-11-07T05:31:56Z",
      "userEmail": "<string>",
      "username": "<string>",
      "fullName": "<string>",
      "metaInfo": {},
      "attachments": [
        {
          "uuid": "<string>",
          "url": {
            "link": "<string>"
          },
          "filename": "<string>"
        }
      ],
      "message": "<string>"
    }
  ],
  "id": 123,
  "created": "2023-11-07T05:31:56Z",
  "status": "WITH_YOU",
  "caseNumber": "<string>",
  "resolvedAt": "2023-11-07T05:31:56Z",
  "currentRating": 123,
  "resolvedBy": "LOGSTA"
}

POST

/

customerInquiries

Create customer inquiry

curl --request POST \
  --url https://api.quivo.co/customerInquiries \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": "<string>",
  "sellerId": 123,
  "warehouseId": 123,
  "messages": [
    {
      "message": "<string>",
      "attachments": [
        {
          "uuid": "<string>",
          "mimeType": "<string>",
          "filename": "<string>"
        }
      ]
    }
  ],
  "topic": "ONBOARDING",
  "category": "INBOUND",
  "subCategory": "FULFILMENT_WAREHOUSE",
  "parentInquiryId": 123,
  "metaInfo": {}
}
'

{
  "subject": "<string>",
  "sellerId": 123,
  "warehouseId": 123,
  "topic": "ONBOARDING",
  "category": "INBOUND",
  "subCategory": "FULFILMENT_WAREHOUSE",
  "parentInquiryId": 123,
  "metaInfo": {},
  "messages": [
    {
      "category": "RATING_MESSAGE",
      "created": "2023-11-07T05:31:56Z",
      "postedAt": "2023-11-07T05:31:56Z",
      "userEmail": "<string>",
      "username": "<string>",
      "fullName": "<string>",
      "metaInfo": {},
      "attachments": [
        {
          "uuid": "<string>",
          "url": {
            "link": "<string>"
          },
          "filename": "<string>"
        }
      ],
      "message": "<string>"
    }
  ],
  "id": 123,
  "created": "2023-11-07T05:31:56Z",
  "status": "WITH_YOU",
  "caseNumber": "<string>",
  "resolvedAt": "2023-11-07T05:31:56Z",
  "currentRating": 123,
  "resolvedBy": "LOGSTA"
}

Body

application/json

Data to create a new resource at /customerInquiries

Request payload for creating a new customer inquiry or support ticket. Contains inquiry details including subject, message, customer information, and optional attachments.

subject

string

required

The subject of the Customer Inquiry.

sellerId

integer<int64>

required

The seller which initiated Customer Inquiry.

warehouseId

integer<int64>

required

The warehouse associated to the Customer Inquiry.

messages

object[]

required

Messages of the Customer Inquiry.

Show child attributes

topic

enum<string>

The topic of the Customer Inquiry.

Available options:

ONBOARDING,

FULFILMENT,

SERVICE,

ACCOUNTING,

TECH_IT,

MISCELLANEOUS_OTHER,

REPORTS

category

enum<string>

The category of the Customer Inquiry.

Available options:

INBOUND,

PICKING_AND_PACKING,

SHIPMENT_AND_OUTBOUND,

ARTICLES_ITEMS_IN_ORDER,

DAMAGES,

RETURNS,

STOCK_DISCREPANCIES,

CARRIER_PICKUPS,

TRACKING_NUMBERS,

MISCELLANEOUS_OTHER_FULFILLMENT,

CARRIERS,

INVESTIGATIONS,

ACCOUNT_DETAILS_CHANGES,

MAPPING_BUNDLES_FULFILMENT_PLANS,

MISCELLANEOUS_OTHER_SERVICE,

KEY_ACCOUNTS,

NEW_SHOP,

INVOICE_ENQUIRIES,

REFUNDS_CREDIT_NOTES,

SERVICE_REPORT_ENQUIRIES,

SURCHARGES,

INSURANCE_CUSTOMS,

DUNNING,

CARRIER_RELATED_CHARGES,

CUSTOMS,

ONBOARDING_FEE,

DOUBLE_CHARGES_TRANSFERS,

PAYMENT_METHODS,

SEPA,

PAYMENT_CONFIRMATIONS,

SPECIAL_REQUESTS,

MISCELLANEOUS_OTHER_ACCOUNTING,

SYSTEM_ERRORS,

SHOP_INTEGRATION,

ADDING_USERS,

CHANGES_IN_CONNECTOR_ACCOUNT,

API_KEY_ROTATION,

MISCELLANEOUS_OTHER_TECH_IT,

SALES_ENQUIRY,

TRANSPORT_ENQUIRY,

ACCOUNT_DETAILS_CHANGE,

MAPPING_BUNDLE_FULFILMENT_PLAN,

CONTACTED_SALES_INSTEAD_OF_SERVICE,

KEY_ACCOUNT,

MISCELLANEOUS_OTHER,

ONBOARDING_SELF_SIGNUP,

OTHER_ONBOARDING_ISSUES,

ARTICLE_WEIGHT_REPORT,

CARTONAGE_REPORT,

RETURNS_REPORT,

BUNDLE_REPORT

subCategory

enum<string>

The sub category of the Customer Inquiry.

Available options:

FULFILMENT_WAREHOUSE,

INSURANCE,

CUSTOMS,

LOST_ITEMS,

DAMAGES,

CARRIER_DISPUTES,

MISCELLANEOUS_OTHER,

SHIPPING_PRICES,

OTHER_CHARGES

parentInquiryId

integer<int64>

The Customer Inquiry on which this Customer Inquiry is based.
This field is optional.

metaInfo

object

Additional information for the Customer Inquiry.
This field is optional.

Show child attributes

Response

Returns the newly created customer inquiry with assigned identifier.

Complete customer inquiry or support ticket information. Contains inquiry details, messages, attachments, ratings, and status.

subject

string

required

The subject of the Customer Inquiry.

sellerId

integer<int64>

required

The seller which initiated Customer Inquiry.

warehouseId

integer<int64>

required

The warehouse associated to the Customer Inquiry.

topic

enum<string>

The topic of the Customer Inquiry.

Available options:

ONBOARDING,

FULFILMENT,

SERVICE,

ACCOUNTING,

TECH_IT,

MISCELLANEOUS_OTHER,

REPORTS

category

enum<string>

The category of the Customer Inquiry.

Available options:

INBOUND,

PICKING_AND_PACKING,

SHIPMENT_AND_OUTBOUND,

ARTICLES_ITEMS_IN_ORDER,

DAMAGES,

RETURNS,

STOCK_DISCREPANCIES,

CARRIER_PICKUPS,

TRACKING_NUMBERS,

MISCELLANEOUS_OTHER_FULFILLMENT,

CARRIERS,

INVESTIGATIONS,

ACCOUNT_DETAILS_CHANGES,

MAPPING_BUNDLES_FULFILMENT_PLANS,

MISCELLANEOUS_OTHER_SERVICE,

KEY_ACCOUNTS,

NEW_SHOP,

INVOICE_ENQUIRIES,

REFUNDS_CREDIT_NOTES,

SERVICE_REPORT_ENQUIRIES,

SURCHARGES,

INSURANCE_CUSTOMS,

DUNNING,

CARRIER_RELATED_CHARGES,

CUSTOMS,

ONBOARDING_FEE,

DOUBLE_CHARGES_TRANSFERS,

PAYMENT_METHODS,

SEPA,

PAYMENT_CONFIRMATIONS,

SPECIAL_REQUESTS,

MISCELLANEOUS_OTHER_ACCOUNTING,

SYSTEM_ERRORS,

SHOP_INTEGRATION,

ADDING_USERS,

CHANGES_IN_CONNECTOR_ACCOUNT,

API_KEY_ROTATION,

MISCELLANEOUS_OTHER_TECH_IT,

SALES_ENQUIRY,

TRANSPORT_ENQUIRY,

ACCOUNT_DETAILS_CHANGE,

MAPPING_BUNDLE_FULFILMENT_PLAN,

CONTACTED_SALES_INSTEAD_OF_SERVICE,

KEY_ACCOUNT,

MISCELLANEOUS_OTHER,

ONBOARDING_SELF_SIGNUP,

OTHER_ONBOARDING_ISSUES,

ARTICLE_WEIGHT_REPORT,

CARTONAGE_REPORT,

RETURNS_REPORT,

BUNDLE_REPORT

subCategory

enum<string>

The sub category of the Customer Inquiry.

Available options:

FULFILMENT_WAREHOUSE,

INSURANCE,

CUSTOMS,

LOST_ITEMS,

DAMAGES,

CARRIER_DISPUTES,

MISCELLANEOUS_OTHER,

SHIPPING_PRICES,

OTHER_CHARGES

parentInquiryId

integer<int64>

The Customer Inquiry on which this Customer Inquiry is based.
This field is optional.

metaInfo

object

Additional information for the Customer Inquiry.
This field is optional.

Show child attributes

messages

object[]

Message content

Show child attributes

id

integer<int64>

The unique identifier for the id

created

string<date-time>

Timestamp when the item was created

status

enum<string>

The current status of the item

Available options:

WITH_YOU,

WITH_LOGSTA,

RESOLVED

caseNumber

string

Number value

resolvedAt

string<date-time>

The resolved at timestamp

currentRating

number<float>

The current rating numeric value

resolvedBy

enum<string>

The resolved by. Possible values: LOGSTA, CLIENT

Available options:

LOGSTA,

CLIENT

List customer inquirys Upload file

⌘I