UNunified
commerce
review

Create a review

Changed on

Creates a CommerceReview. Provide the unified CommerceReview fields in the request body; they are mapped to the provider's API. Returns the created CommerceReview.

post/commerce/{connection_id}/review

Request

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

item_idstring

Reference to the product being reviewed (reference to CommerceItem)

item_variant_idstring

Optional reference to specific variant if applicable (reference to CommerceCommerceItemvariant)

location_idstring

(reference to CommerceLocation)

ratingnumber

1-5 rating

titlestring
contentstring
author_namestring
author_emailstring
author_avatar_urlstring
author_locationstring
verified_purchaseboolean
helpful_votesnumber
unhelpful_votesnumber
status'PENDING' | 'APPROVED' | 'REJECTED' | 'SPAM'
is_verifiedboolean
is_featuredboolean
is_publicboolean
urlstring
rawobject

Original review data from source platform

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

item_idstring

Reference to the product being reviewed (reference to CommerceItem)

item_variant_idstring

Optional reference to specific variant if applicable (reference to CommerceCommerceItemvariant)

location_idstring

(reference to CommerceLocation)

ratingnumber

1-5 rating

titlestring
contentstring
author_namestring
author_emailstring
author_avatar_urlstring
author_locationstring
verified_purchaseboolean
helpful_votesnumber
unhelpful_votesnumber
status'PENDING' | 'APPROVED' | 'REJECTED' | 'SPAM'
is_verifiedboolean
is_featuredboolean
is_publicboolean
urlstring
rawobject

Original review data from source platform

Changes

  • 8549868f55d3Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property became optional for the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the enum value location_id to the property items/ of the query request parameter fields

    • info

      added the enum value url to the property items/ of the query request parameter fields

    • info

      the request property // became optional

    • info

      the request property became optional

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • b0e1f4b06639Revision changes
    • info

      endpoint added