Sign in
latestOpenAPI 3.0.32026-08-132711294.7 KB

8506f9062fca

Settings

endpoint for finding Ecommerce model

get/v1/configs/ecommerce/{ecommerce_id}

Path parameters

ecommerce_idstring required

The id of the e-commerce.

Query parameters

slugstring

The path of an URL identifying the e-commerce. Optional.

groupstring

The group of the e-commerce. Several e-commerces can have the same group. Optional.

Response

OK

are_partial_reviews_allowedboolean

Allows incrementally reviewing the line items of a process, that is, does not require to bring all of the line items at once

currency_codestring

CurrencyCode

ecommerce_idstring

EcommerceID

email_provider'EMAIL_PROVIDER_UNSPECIFIED' | 'EMAIL_PROVIDER_AWS_SES' | 'EMAIL_PROVIDER_INDITEX' enum

EmailProvider

external_return_policy_urlstring

external policy url

groupstring

Group

identification_flow'IDENTIFICATION_FLOW_UNSPECIFIED' | 'ORDER_ID_AND_EMAIL' | 'ORDER_ID_AND_POSTAL_CODE' enum

How shoppers identify their orders

is_enabledboolean

IsEnabled

is_testingboolean

IsTesting

mark_unreviewed_items_as_missingboolean

When a review brings fewer line items than expected, treat every unit not present in the review as MISSING instead of rejecting the review

namestring

name

orders_sync_disabledboolean

OrdersSyncDisabled

platformstring

Platform

restocking_enabledboolean

RestockingEnabled

slugstring

slug

store_idstring

StoreID

use_casestring

UseCase

website_urlstring

WebsiteURL