DELETE or CREATE_UPDATE, default value is CREATE_UPDATE"
},
"product_sku": {
"type": "string",
"description": "SKU of the product, to confirm integration of products in your system"
},
"product_urls": {
"type": "array",
"description": "Add links to external resources",
"items": {
"$ref": "#/components/schemas/CM21_Request_ProductUrls"
}
},
"selling_authorization": {
"$ref": "#/components/schemas/CM21_Request_SellingAuthorization",
"description": "Manage selling authorization"
}
}
},
"CM21_Request_Acceptance": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"description": "Accept or reject product by channel",
"items": {
"$ref": "#/components/schemas/CM21_Request_Acceptance_Channels"
}
},
"message": {
"type": "string",
"description": "Rejection message"
},
"reason_code": {
"type": "string",
"description": "Rejection reason code, this field is required if the acceptance status is REJECTED, CHANGES_REQUESTED or TO_REVIEW"
},
"status": {
"type": "string",
"description": "Acceptance status: ACCEPTED, REJECTED, CHANGES_REQUESTED or TO_REVIEW"
}
}
},
"CM21_Request_Acceptance_Channels": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Channel code"
},
"message": {
"type": "string",
"description": "Rejection message"
},
"reason_code": {
"type": "string",
"description": "Rejection reason code, this field is required if the acceptance status is REJECTED, CHANGES_REQUESTED or TO_REVIEW"
},
"status": {
"type": "string",
"description": "Acceptance status: ACCEPTED, REJECTED, CHANGES_REQUESTED or TO_REVIEW"
}
}
},
"CM21_Request_IntegrationErrors": {
"type": "object",
"properties": {
"attribute_code": {
"type": "string",
"description": "Code of the attribute with error(s)"
},
"code": {
"type": "string",
"description": "Error code from your product management system"
},
"message": {
"type": "string",
"description": "Error message from your product management system"
}
}
},
"CM21_Request_ProductUrls": {
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "Link to an external resource"
},
"qualifier": {
"type": "string",
"description": "Link text that appears on Master Product Data Sheets"
}
},
"required": [
"link",
"qualifier"
]
},
"CM21_Request_SellingAuthorization": {
"type": "object",
"properties": {
"authorized_selling_shop_ids": {
"type": "array",
"description": "Restrict product sells to specific shops",
"items": {
"type": "string"
}
},
"restricted": {
"type": "boolean",
"description": "Whether the product is restricted or not"
}
},
"required": [
"authorized_selling_shop_ids",
"restricted"
]
},
"CM21_Response_200": {
"type": "object",
"properties": {
"tracking_id": {
"type": "string",
"description": "Tracking Id to use when getting the status with CM22 or the report with CM23"
}
},
"required": [
"tracking_id"
]
},
"CM22_Response_200": {
"type": "object",
"properties": {
"archived": {
"type": "boolean",
"description": "Whether the synchronization has been archived"
},
"failed": {
"type": "integer",
"format": "int32",
"description": "Number of product synchronizations that failed"
},
"has_report": {
"type": "boolean",
"description": "Whether the synchronization report is available or not"
},
"partial_read": {
"type": "boolean",
"description": "Whether the product synchronization has been partially processed"
},
"processed": {
"type": "integer",
"format": "int32",
"description": "Number of product synchronizations processed"
},
"status": {
"type": "string",
"description": "Status of the synchronization, either WAITING, QUEUED, RUNNING, COMPLETE, or FAILED"
},
"succeeded": {
"type": "integer",
"format": "int32",
"description": "Number of product synchronizations successfully processed"
},
"tracking_id": {
"type": "string",
"description": "Tracking id to use when getting the report with CM23"
}
},
"required": [
"status",
"tracking_id"
]
},
"CM23_Response_200": {
"type": "object",
"properties": {
"global_errors": {
"type": "array",
"description": "List of the global synchronization errors",
"items": {
"$ref": "#/components/schemas/CM23_Response_200_GlobalErrors"
}
},
"processed_items": {
"type": "array",
"description": "Report for products synchronized with API CM21",
"items": {
"$ref": "#/components/schemas/CM23_Response_200_ProcessedItems"
}
}
}
},
"CM23_Response_200_GlobalErrors": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The Mirakl error code"
},
"message": {
"type": "string",
"description": "The error message"
}
},
"required": [
"code",
"message"
]
},
"CM23_Response_200_ProcessedItems": {
"type": "object",
"properties": {
"acceptance": {
"$ref": "#/components/schemas/CM23_Response_200_ProcessedItems_Acceptance",
"description": "Accept or reject product"
},
"catalogs": {
"type": "array",
"description": "List of catalogs codes, to assign product to catalog(s)",
"items": {
"type": "string"
}
},
"data": {
"type": "object",
"additionalProperties": {
"type": "object"
},
"description": "Attribute data of the Master Product Data Sheet"
},
"integration_errors": {
"type": "array",
"description": "Report product integration errors",
"items": {
"$ref": "#/components/schemas/CM23_Response_200_ProcessedItems_IntegrationErrors"
}
},
"mirakl_product_id": {
"type": "string",
"description": "Mirakl product id of the product, retrieved from API CM51"
},
"operation": {
"type": "string",
"description": "Operation DELETE or CREATE_UPDATE, default value is CREATE_UPDATE"
},
"product_sku": {
"type": "string",
"description": "SKU of the product, to confirm integration of products in your system"
},
"product_urls": {
"type": "array",
"description": "Add links to external resources",
"items": {
"$ref": "#/components/schemas/CM23_Response_200_ProcessedItems_ProductUrls"
}
},
"selling_authorization": {
"$ref": "#/components/schemas/CM23_Response_200_ProcessedItems_SellingAuthorization",
"description": "Manage selling authorization"
},
"status": {
"type": "string",
"description": "The product synchronization status, SUCCESS or FAILURE"
},
"synchronization_errors": {
"type": "array",
"description": "List of the synchronization errors",
"items": {
"$ref": "#/components/schemas/CM23_Response_200_ProcessedItems_SynchronizationErrors"
}
}
}
},
"CM23_Response_200_ProcessedItems_Acceptance": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"description": "Accept or reject product by channel",
"items": {
"$ref": "#/components/schemas/CM23_Response_200_ProcessedItems_Acceptance_Channels"
}
},
"message": {
"type": "string",
"description": "Rejection message"
},
"reason_code": {
"type": "string",
"description": "Rejection reason code, this field is required if the acceptance status is REJECTED, CHANGES_REQUESTED or TO_REVIEW"
},
"status": {
"type": "string",
"description": "Acceptance status: ACCEPTED, REJECTED, CHANGES_REQUESTED or TO_REVIEW"
}
}
},
"CM23_Response_200_ProcessedItems_Acceptance_Channels": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Channel code"
},
"message": {
"type": "string",
"description": "Rejection message"
},
"reason_code": {
"type": "string",
"description": "Rejection reason code, this field is required if the acceptance status is REJECTED, CHANGES_REQUESTED or TO_REVIEW"
},
"status": {
"type": "string",
"description": "Acceptance status: ACCEPTED, REJECTED, CHANGES_REQUESTED or TO_REVIEW"
}
}
},
"CM23_Response_200_ProcessedItems_IntegrationErrors": {
"type": "object",
"properties": {
"attribute_code": {
"type": "string",
"description": "Code of the attribute with error(s)"
},
"code": {
"type": "string",
"description": "Error code from your product management system"
},
"message": {
"type": "string",
"description": "Error message from your product management system"
}
}
},
"CM23_Response_200_ProcessedItems_ProductUrls": {
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "Link to an external resource"
},
"qualifier": {
"type": "string",
"description": "Link text that appears on Master Product Data Sheets"
}
},
"required": [
"link",
"qualifier"
]
},
"CM23_Response_200_ProcessedItems_SellingAuthorization": {
"type": "object",
"properties": {
"authorized_selling_shop_ids": {
"type": "array",
"description": "Restrict product sells to specific shops",
"items": {
"type": "string"
}
},
"restricted": {
"type": "boolean",
"description": "Whether the product is restricted or not"
}
},
"required": [
"authorized_selling_shop_ids",
"restricted"
]
},
"CM23_Response_200_ProcessedItems_SynchronizationErrors": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The Mirakl code of the synchronization error"
},
"message": {
"type": "string",
"description": "The synchronization error message"
}
}
},
"CM51_Response_200_Ext_FileStructure": {
"type": "object",
"description": "JSON output",
"properties": {
"acceptance": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Acceptance",
"description": "Mirakl acceptance status and possible rejection reasons and messages."
},
"catalogs": {
"type": "array",
"description": "The list of catalogs for the product, if any.",
"items": {
"type": "string"
}
},
"creation_date": {
"type": "string",
"format": "date-time",
"description": "The creation date of the product."
},
"data": {
"type": "object",
"description": "The content of the \"data\" field depends on your configuration. Each subfield within the \"data\" field is the code of a product attribute."
},
"data_origin": {
"type": "object",
"description": "Origin of attribute values in your Master Product Data Sheets: OPERATOR or PROVIDER. If you set the include_data_provider_origins query parameter to TRUE, data provider will also be returned. Variant group code attributes and identifiers are not supported."
},
"mirakl_product_id": {
"type": "string",
"description": "The Mirakl unique identifier for each exported product. Store this unique identifier in your system and use it in API CM21 to identify the correct integration or to report integration errors for each product."
},
"product_sku": {
"type": "string",
"description": "The SKU of the product."
},
"product_urls": {
"type": "array",
"description": "The list of product urls, if any. ",
"items": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_ProductUrls"
}
},
"selling_authorization": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_SellingAuthorization",
"description": "The selling authorization of the product"
},
"sources": {
"type": "array",
"description": "The list of provider ids and unique identifiers.",
"items": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Sources"
}
},
"synchronization": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Synchronization",
"description": "Mirakl synchronization status and possible integration errors."
},
"trust_and_safety": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_TrustAndSafety",
"description": "Harmful content detection information. Only present when the product has been flagged by content moderation."
},
"update_date": {
"type": "string",
"format": "date-time",
"description": "The last updated date of the product."
},
"validation": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Validation",
"description": "Mirakl validation for each exported product."
}
},
"required": [
"acceptance",
"mirakl_product_id",
"product_sku",
"synchronization",
"update_date",
"validation"
]
},
"CM51_Response_200_Ext_FileStructure_Acceptance": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"description": "Mirakl acceptance status and possible rejection reasons and messages for each channel.",
"items": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Acceptance_Channels"
}
},
"last_operator_action": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction",
"description": "Last operator acceptance action information."
},
"message": {
"type": "string",
"description": "The rejection message for the product, if any. Otherwise, the column is empty."
},
"reason_code": {
"type": "string",
"description": "The rejection reason for the product, if any. Otherwise, the column is empty."
},
"status": {
"type": "string",
"description": "Mirakl acceptance status for each exported product."
}
},
"required": [
"message",
"reason_code",
"status"
]
},
"CM51_Response_200_Ext_FileStructure_Acceptance_Channels": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Channel code in Mirakl."
},
"last_operator_action": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction",
"description": "Last operator acceptance action information."
},
"message": {
"type": "string",
"description": "The rejection message for the product in this specific channel, if any."
},
"reason_code": {
"type": "string",
"description": "The rejection reason for the product in this specific channel, if any."
},
"status": {
"type": "string",
"description": "Product acceptance status in Mirakl for this specific channel."
}
},
"required": [
"code",
"status"
]
},
"CM51_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"description": "Date/time of last operator action that changed the acceptance status of the product."
},
"rule": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction_Rule",
"description": "Automation rule to last modify the acceptance status"
},
"user": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction_User",
"description": "User who performed last action that changed the acceptance status of the product."
}
},
"required": [
"date"
]
},
"CM51_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction_Rule": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code of the automation rule to last modify the acceptance status"
}
},
"required": [
"code"
]
},
"CM51_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction_User": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of user who performed last action that changed the acceptance status of the product."
}
},
"required": [
"name"
]
},
"CM51_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"description": "Date/time of last operator action that changed the acceptance status of the product."
},
"rule": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction_Rule",
"description": "Automation rule to last modify the acceptance status"
},
"user": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction_User",
"description": "User who performed last action that changed the acceptance status of the product."
}
},
"required": [
"date"
]
},
"CM51_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction_Rule": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code of the automation rule to last modify the acceptance status"
}
},
"required": [
"code"
]
},
"CM51_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction_User": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of user who performed last action that changed the acceptance status of the product."
}
},
"required": [
"name"
]
},
"CM51_Response_200_Ext_FileStructure_ProductUrls": {
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "Link to an external resource"
},
"qualifier": {
"type": "string",
"description": "Link text that appears on Master Product Data Sheets"
}
},
"required": [
"link",
"qualifier"
]
},
"CM51_Response_200_Ext_FileStructure_SellingAuthorization": {
"type": "object",
"properties": {
"authorized_selling_shop_ids": {
"type": "array",
"description": "The list of authorized selling shop ids, if any.",
"items": {
"type": "string"
}
},
"restricted": {
"type": "boolean",
"description": "The boolean to determined if the product has selling restriction."
}
},
"required": [
"authorized_selling_shop_ids",
"restricted"
]
},
"CM51_Response_200_Ext_FileStructure_Sources": {
"type": "object",
"properties": {
"provider_code": {
"type": "string",
"description": "The Id of the provider"
},
"provider_sku": {
"type": "string",
"description": "The unique Identifier given by the provider"
}
}
},
"CM51_Response_200_Ext_FileStructure_Synchronization": {
"type": "object",
"properties": {
"integration_errors": {
"type": "array",
"description": "Integration errors for each exported product.",
"items": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Synchronization_IntegrationErrors"
}
},
"status": {
"type": "string",
"description": "Mirakl synchronization status for each exported product."
}
},
"required": [
"integration_errors",
"status"
]
},
"CM51_Response_200_Ext_FileStructure_Synchronization_IntegrationErrors": {
"type": "object",
"properties": {
"attribute_code": {
"type": "string",
"description": "The attribute code"
},
"code": {
"type": "string",
"description": "The integration error code"
},
"message": {
"type": "string",
"description": "The integration error message"
}
}
},
"CM51_Response_200_Ext_FileStructure_TrustAndSafety": {
"type": "object",
"properties": {
"analyzed_at": {
"type": "string",
"format": "date-time",
"description": "The product moderation date"
},
"review": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_TrustAndSafety_Review",
"description": "The details of a review performed by an operator on a flagged product"
},
"risk_categories": {
"type": "array",
"description": "List of identified risk categories.",
"items": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_TrustAndSafety_RiskCategories"
}
},
"score": {
"type": "number",
"format": "double",
"description": "Overall harmfulness score of the product."
}
},
"required": [
"risk_categories",
"score"
]
},
"CM51_Response_200_Ext_FileStructure_TrustAndSafety_Review": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"description": "The date of the moderation review"
},
"status": {
"type": "string",
"description": "The status of the moderation review: SAFE, HARMFUL."
},
"user": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_TrustAndSafety_Review_User",
"description": "The operator user who did the moderation review"
}
},
"required": [
"status"
]
},
"CM51_Response_200_Ext_FileStructure_TrustAndSafety_Review_User": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the operator user who did the moderation review"
}
},
"required": [
"name"
]
},
"CM51_Response_200_Ext_FileStructure_TrustAndSafety_RiskCategories": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Risk category code."
},
"flagged_attributes": {
"type": "array",
"description": "List of product attributes contributing to the harmfulness score.",
"items": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_TrustAndSafety_RiskCategories_FlaggedAttributes"
}
},
"score": {
"type": "number",
"format": "double",
"description": "Harmfulness score for the given risk category."
}
},
"required": [
"code",
"flagged_attributes",
"score"
]
},
"CM51_Response_200_Ext_FileStructure_TrustAndSafety_RiskCategories_FlaggedAttributes": {
"type": "object",
"properties": {
"attribute_code": {
"type": "string",
"description": "Flagged attribute code."
},
"score": {
"type": "number",
"format": "double",
"description": "Harmfulness score for the given product attribute."
}
},
"required": [
"attribute_code",
"score"
]
},
"CM51_Response_200_Ext_FileStructure_Validation": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"description": "Mirakl validation status for each channel on exported product.",
"items": {
"$ref": "#/components/schemas/CM51_Response_200_Ext_FileStructure_Validation_Channels"
}
},
"status": {
"type": "string",
"description": "Mirakl validation status for each exported product."
}
},
"required": [
"status"
]
},
"CM51_Response_200_Ext_FileStructure_Validation_Channels": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Channel code in Mirakl."
},
"status": {
"type": "string",
"description": "Mirakl channel validation status on exported product. Can be VALID, INVALID, or NOT_ANALYZED if the validation status is not yet calculated for this channel."
}
},
"required": [
"code",
"status"
]
},
"CM51_Response_200_TextCsv_Ext_FileStructure": {
"type": "object",
"description": "CSV output",
"properties": {
"mirakl-acceptance-status": {
"type": "string",
"description": "Mirakl acceptance status for each exported product."
},
"mirakl-authorized-selling-shop-ids": {
"type": "array",
"description": "The list of authorized selling shop ids, if any.",
"items": {
"type": "string"
}
},
"mirakl-catalogs": {
"type": "array",
"description": "The list of catalogs for the product, if any. Otherwise, the column is empty.",
"items": {
"type": "string"
}
},
"mirakl-channels-acceptance-status": {
"type": "string",
"description": "Product acceptance status in Mirakl for each channel, using this pattern: channel_code|status."
},
"mirakl-channels-last-operator-acceptance-action-date": {
"type": "string",
"description": "Date/time of last operator action that changed the acceptance status of the product, specific to each channel, if any. It uses this pattern: channel_code|date."
},
"mirakl-channels-last-operator-acceptance-action-rule-code": {
"type": "string",
"description": "Code of the automation rule to last modify the acceptance status, specific to each channel, if any. It uses this pattern: channel_code|rule_code."
},
"mirakl-channels-last-operator-acceptance-action-user-name": {
"type": "string",
"description": "Name of user who performed last action that changed the acceptance status of the product, specific to each channel, if any. It uses this pattern: channel_code|user."
},
"mirakl-channels-rejection-message": {
"type": "string",
"description": "The rejection message of an exported product, specific to each channel, if any. It uses this pattern: channel_code|rejection_message. The column is empty if there is no rejection message."
},
"mirakl-channels-rejection-reason": {
"type": "string",
"description": "The rejection reason of an exported product, specific to each channel, if any. It uses this pattern: channel_code|rejection_code. The column is empty if there is no rejection reason."
},
"mirakl-channels-validation-statuses": {
"type": "array",
"description": "Mirakl validation status for each channel on exported product, following the pattern: channel_code|status. Can be VALID, INVALID, or NOT_ANALYZED if the validation status is not yet calculated for this channel. Otherwise, the column is empty.",
"items": {
"type": "string"
}
},
"mirakl-creation-date": {
"type": "string",
"format": "date-time",
"description": "The creation date of the product."
},
"mirakl-integration-errors": {
"type": "array",
"description": "Integration errors for each exported product, following the pattern : error_code|error_message|attribute_code Otherwise, the column is empty.",
"items": {
"type": "string"
}
},
"mirakl-last-operator-acceptance-action-date": {
"type": "string",
"description": "Date/time of last operator action that changed the acceptance status of the product."
},
"mirakl-last-operator-acceptance-action-rule-code": {
"type": "string",
"description": "Code of the automation rule to last modify the acceptance status"
},
"mirakl-last-operator-acceptance-action-user-name": {
"type": "string",
"description": "Name of user who performed last action that changed the acceptance status of the product."
},
"mirakl-product-id": {
"type": "string",
"description": "The Mirakl unique identifier for each exported product. Store this unique identifier in your system and use it in API CM21 to identify the correct integration or to report integration errors for each product."
},
"mirakl-product-sku": {
"type": "string",
"description": "The SKU of the product."
},
"mirakl-product-urls": {
"type": "array",
"description": "The list of product urls, if any. Following the pattern : qualifier|link",
"items": {
"type": "string"
}
},
"mirakl-rejection-message": {
"type": "string",
"description": "The rejection message for the product, if any. Otherwise, the column is empty."
},
"mirakl-rejection-reason": {
"type": "string",
"description": "The rejection reason for the product, if any. Otherwise, the column is empty."
},
"mirakl-restricted-selling": {
"type": "boolean",
"description": "The boolean to determined if the product has selling restriction."
},
"mirakl-sources": {
"type": "array",
"description": "The list of provider unique identifiers, following the pattern providerId|providerUniqueIdentifier ",
"items": {
"type": "string"
}
},
"mirakl-synchronization-status": {
"type": "string",
"description": "Mirakl synchronization status for each exported product."
},
"mirakl-trust-and-safety-analyzed-at": {
"type": "string",
"format": "date-time",
"description": "The product moderation date"
},
"mirakl-trust-and-safety-review-date": {
"type": "string",
"format": "date-time",
"description": "The date of the moderation review"
},
"mirakl-trust-and-safety-review-status": {
"type": "string",
"description": "The status of the moderation review: SAFE, HARMFUL."
},
"mirakl-trust-and-safety-review-user-name": {
"type": "string",
"description": "Name of the operator user who did the moderation review"
},
"mirakl-trust-and-safety-risk-categories": {
"type": "string",
"description": "Risk category code and its related harmfulness score, following the pattern: risk_category_code|score. Multiple risk categories are comma-separated. The column is empty if the product has not been flagged."
},
"mirakl-trust-and-safety-score": {
"type": "string",
"description": "Overall harmfulness score of the product."
},
"mirakl-update-date": {
"type": "string",
"format": "date-time",
"description": "The last updated date of the product."
},
"mirakl-validation-status": {
"type": "string",
"description": "Mirakl validation status for each exported product."
}
},
"required": [
"mirakl-acceptance-status",
"mirakl-product-id",
"mirakl-product-sku",
"mirakl-synchronization-status",
"mirakl-update-date",
"mirakl-validation-status"
]
},
"CM52_Request": {
"type": "object",
"properties": {
"acceptance_status": {
"type": "array",
"description": "Acceptance status of the product. Default to ACCEPTED.",
"items": {
"type": "string",
"description": "Enum: `\"NEW\"`, `\"REJECTED\"`, `\"ACCEPTED\"`, `\"CHANGES_REQUESTED\"`, `\"TO_REVIEW\"`\n"
},
"maxItems": 100,
"minItems": 0,
"uniqueItems": true
},
"catalog": {
"type": "array",
"description": "Catalog of the product",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 0,
"uniqueItems": true
},
"category": {
"type": "array",
"description": "Category code of the product",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 0,
"uniqueItems": true
},
"channel": {
"type": "string",
"description": "Channel code on which to retrieve validation and acceptance statuses.",
"maxLength": 255,
"minLength": 0
},
"export_type": {
"type": "string",
"description": "Format of the generated files: CSV or JSON (value is either text/csv or application/json). Default to application/json."
},
"include_data_provider_origins": {
"type": "boolean",
"default": false,
"description": "Include non-shop providers (such as the beta OpenAI provider) in the data_origin field. Only available for json exports."
},
"items_per_chunk": {
"type": "integer",
"format": "int64",
"description": "Maximum number of items included in the generated files"
},
"megabytes_per_chunk": {
"type": "integer",
"format": "int64",
"description": "Maximum mega bytes weight for generated files"
},
"product_id": {
"type": "array",
"description": "Mirakl product id of the product",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 0
},
"product_sku": {
"type": "array",
"description": "SKU of the product",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 0,
"uniqueItems": true
},
"rejection_reason": {
"type": "array",
"description": "Rejection reason code of the product",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 0,
"uniqueItems": true
},
"restrict_attributes": {
"type": "boolean",
"default": true,
"description": "If a channel code is specified, returns only the attributes specific to this channel."
},
"synchronization_status": {
"type": "array",
"description": "Synchronization status of the product. Default to SYNCHRONIZED,PENDING,INTEGRATION_ERRORS.",
"items": {
"type": "string",
"description": "Enum: `\"SYNCHRONIZED\"`, `\"PENDING\"`, `\"INTEGRATION_ERRORS\"`\n\nVALID.",
"items": {
"type": "string",
"description": "Enum: `\"VALID\"`, `\"INVALID\"`\n"
},
"maxItems": 100,
"minItems": 0,
"uniqueItems": true
},
"variant_group_code": {
"type": "array",
"description": "Variant group code of the product",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 0,
"uniqueItems": true
}
}
},
"CM52_Response_200": {
"type": "object",
"properties": {
"tracking_id": {
"type": "string",
"description": "Id to poll in order to track the export's progress"
}
}
},
"CM53_Response_200": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/CM53_Response_200_Error",
"description": "Specific error if the status is 'FAILED'"
},
"last_updated": {
"type": "string",
"format": "date-time",
"description": "The last updated date of the export"
},
"status": {
"type": "string",
"description": "Current status of the export, can be 'PENDING', 'FAILED', 'CANCELED', or 'COMPLETED'"
},
"urls": {
"type": "array",
"description": "List of generated urls to call to download each generated chunks",
"items": {
"type": "string"
}
}
}
},
"CM53_Response_200_Error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code"
},
"message": {
"type": "string",
"description": "The error message"
}
}
},
"CM54_Response_200_Ext_FileStructure": {
"type": "object",
"description": "JSON output",
"properties": {
"acceptance": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Acceptance",
"description": "Mirakl acceptance status and possible rejection reasons and messages."
},
"catalogs": {
"type": "array",
"description": "The list of catalogs for the product, if any.",
"items": {
"type": "string"
}
},
"creation_date": {
"type": "string",
"format": "date-time",
"description": "The creation date of the product."
},
"data": {
"type": "object",
"description": "The content of the \"data\" field depends on your configuration. Each subfield within the \"data\" field is the code of a product attribute."
},
"data_origin": {
"type": "object",
"description": "Origin of attribute values in your Master Product Data Sheets: OPERATOR or PROVIDER. If you set the include_data_provider_origins query parameter to TRUE, data provider will also be returned. Variant group code attributes and identifiers are not supported."
},
"mirakl_product_id": {
"type": "string",
"description": "The Mirakl unique identifier for each exported product. Store this unique identifier in your system and use it in API CM21 to identify the correct integration or to report integration errors for each product."
},
"product_sku": {
"type": "string",
"description": "The SKU of the product."
},
"product_urls": {
"type": "array",
"description": "The list of product urls, if any. ",
"items": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_ProductUrls"
}
},
"selling_authorization": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_SellingAuthorization",
"description": "The selling authorization of the product"
},
"sources": {
"type": "array",
"description": "The list of provider ids and unique identifiers.",
"items": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Sources"
}
},
"synchronization": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Synchronization",
"description": "Mirakl synchronization status and possible integration errors."
},
"trust_and_safety": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_TrustAndSafety",
"description": "Harmful content detection information. Only present when the product has been flagged by content moderation."
},
"update_date": {
"type": "string",
"format": "date-time",
"description": "The last updated date of the product."
},
"validation": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Validation",
"description": "Mirakl validation for each exported product."
}
},
"required": [
"acceptance",
"mirakl_product_id",
"product_sku",
"synchronization",
"update_date",
"validation"
]
},
"CM54_Response_200_Ext_FileStructure_Acceptance": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"description": "Mirakl acceptance status and possible rejection reasons and messages for each channel.",
"items": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Acceptance_Channels"
}
},
"last_operator_action": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction",
"description": "Last operator acceptance action information."
},
"message": {
"type": "string",
"description": "The rejection message for the product, if any. Otherwise, the column is empty."
},
"reason_code": {
"type": "string",
"description": "The rejection reason for the product, if any. Otherwise, the column is empty."
},
"status": {
"type": "string",
"description": "Mirakl acceptance status for each exported product."
}
},
"required": [
"message",
"reason_code",
"status"
]
},
"CM54_Response_200_Ext_FileStructure_Acceptance_Channels": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Channel code in Mirakl."
},
"last_operator_action": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction",
"description": "Last operator acceptance action information."
},
"message": {
"type": "string",
"description": "The rejection message for the product in this specific channel, if any."
},
"reason_code": {
"type": "string",
"description": "The rejection reason for the product in this specific channel, if any."
},
"status": {
"type": "string",
"description": "Product acceptance status in Mirakl for this specific channel."
}
},
"required": [
"code",
"status"
]
},
"CM54_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"description": "Date/time of last operator action that changed the acceptance status of the product."
},
"rule": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction_Rule",
"description": "Automation rule to last modify the acceptance status"
},
"user": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction_User",
"description": "User who performed last action that changed the acceptance status of the product."
}
},
"required": [
"date"
]
},
"CM54_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction_Rule": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code of the automation rule to last modify the acceptance status"
}
},
"required": [
"code"
]
},
"CM54_Response_200_Ext_FileStructure_Acceptance_Channels_LastOperatorAction_User": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of user who performed last action that changed the acceptance status of the product."
}
},
"required": [
"name"
]
},
"CM54_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"description": "Date/time of last operator action that changed the acceptance status of the product."
},
"rule": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction_Rule",
"description": "Automation rule to last modify the acceptance status"
},
"user": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction_User",
"description": "User who performed last action that changed the acceptance status of the product."
}
},
"required": [
"date"
]
},
"CM54_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction_Rule": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code of the automation rule to last modify the acceptance status"
}
},
"required": [
"code"
]
},
"CM54_Response_200_Ext_FileStructure_Acceptance_LastOperatorAction_User": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of user who performed last action that changed the acceptance status of the product."
}
},
"required": [
"name"
]
},
"CM54_Response_200_Ext_FileStructure_ProductUrls": {
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "Link to an external resource"
},
"qualifier": {
"type": "string",
"description": "Link text that appears on Master Product Data Sheets"
}
},
"required": [
"link",
"qualifier"
]
},
"CM54_Response_200_Ext_FileStructure_SellingAuthorization": {
"type": "object",
"properties": {
"authorized_selling_shop_ids": {
"type": "array",
"description": "The list of authorized selling shop ids, if any.",
"items": {
"type": "string"
}
},
"restricted": {
"type": "boolean",
"description": "The boolean to determined if the product has selling restriction."
}
},
"required": [
"authorized_selling_shop_ids",
"restricted"
]
},
"CM54_Response_200_Ext_FileStructure_Sources": {
"type": "object",
"properties": {
"provider_code": {
"type": "string",
"description": "The Id of the provider"
},
"provider_sku": {
"type": "string",
"description": "The unique Identifier given by the provider"
}
}
},
"CM54_Response_200_Ext_FileStructure_Synchronization": {
"type": "object",
"properties": {
"integration_errors": {
"type": "array",
"description": "Integration errors for each exported product.",
"items": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Synchronization_IntegrationErrors"
}
},
"status": {
"type": "string",
"description": "Mirakl synchronization status for each exported product."
}
},
"required": [
"integration_errors",
"status"
]
},
"CM54_Response_200_Ext_FileStructure_Synchronization_IntegrationErrors": {
"type": "object",
"properties": {
"attribute_code": {
"type": "string",
"description": "The attribute code"
},
"code": {
"type": "string",
"description": "The integration error code"
},
"message": {
"type": "string",
"description": "The integration error message"
}
}
},
"CM54_Response_200_Ext_FileStructure_TrustAndSafety": {
"type": "object",
"properties": {
"analyzed_at": {
"type": "string",
"format": "date-time",
"description": "The product moderation date"
},
"review": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_TrustAndSafety_Review",
"description": "The details of a review performed by an operator on a flagged product"
},
"risk_categories": {
"type": "array",
"description": "List of identified risk categories.",
"items": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_TrustAndSafety_RiskCategories"
}
},
"score": {
"type": "number",
"format": "double",
"description": "Overall harmfulness score of the product."
}
},
"required": [
"risk_categories",
"score"
]
},
"CM54_Response_200_Ext_FileStructure_TrustAndSafety_Review": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"description": "The date of the moderation review"
},
"status": {
"type": "string",
"description": "The status of the moderation review: SAFE, HARMFUL."
},
"user": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_TrustAndSafety_Review_User",
"description": "The operator user who did the moderation review"
}
},
"required": [
"status"
]
},
"CM54_Response_200_Ext_FileStructure_TrustAndSafety_Review_User": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the operator user who did the moderation review"
}
},
"required": [
"name"
]
},
"CM54_Response_200_Ext_FileStructure_TrustAndSafety_RiskCategories": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Risk category code."
},
"flagged_attributes": {
"type": "array",
"description": "List of product attributes contributing to the harmfulness score.",
"items": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_TrustAndSafety_RiskCategories_FlaggedAttributes"
}
},
"score": {
"type": "number",
"format": "double",
"description": "Harmfulness score for the given risk category."
}
},
"required": [
"code",
"flagged_attributes",
"score"
]
},
"CM54_Response_200_Ext_FileStructure_TrustAndSafety_RiskCategories_FlaggedAttributes": {
"type": "object",
"properties": {
"attribute_code": {
"type": "string",
"description": "Flagged attribute code."
},
"score": {
"type": "number",
"format": "double",
"description": "Harmfulness score for the given product attribute."
}
},
"required": [
"attribute_code",
"score"
]
},
"CM54_Response_200_Ext_FileStructure_Validation": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"description": "Mirakl validation status for each channel on exported product.",
"items": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Validation_Channels"
}
},
"status": {
"type": "string",
"description": "Mirakl validation status for each exported product."
},
"validation_errors": {
"type": "array",
"description": "List of validation errors related to the product.",
"items": {
"$ref": "#/components/schemas/CM54_Response_200_Ext_FileStructure_Validation_ValidationErrors"
}
}
},
"required": [
"status"
]
},
"CM54_Response_200_Ext_FileStructure_Validation_Channels": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Channel code in Mirakl."
},
"status": {
"type": "string",
"description": "Mirakl channel validation status on exported product. Can be VALID, INVALID, or NOT_ANALYZED if the validation status is not yet calculated for this channel."
}
},
"required": [
"code",
"status"
]
},
"CM54_Response_200_Ext_FileStructure_Validation_ValidationErrors": {
"type": "object",
"properties": {
"attribute_code": {
"type": "string",
"description": "Impacted attribute."
},
"channels": {
"type": "array",
"description": "Sales channels for which this attribute is invalid on.",
"items": {
"type": "string"
}
},
"code": {
"type": "string",
"description": "Product validation error code."
},
"message": {
"type": "string",
"description": "Specific validation error message."
}
},
"required": [
"attribute_code",
"code"
]
},
"CM54_Response_200_TextCsv_Ext_FileStructure": {
"type": "object",
"description": "CSV output",
"properties": {
"mirakl-acceptance-status": {
"type": "string",
"description": "Mirakl acceptance status for each exported product."
},
"mirakl-authorized-selling-shop-ids": {
"type": "array",
"description": "The list of authorized selling shop ids, if any.",
"items": {
"type": "string"
}
},
"mirakl-catalogs": {
"type": "array",
"description": "The list of catalogs for the product, if any. Otherwise, the column is empty.",
"items": {
"type": "string"
}
},
"mirakl-channels-acceptance-status": {
"type": "string",
"description": "Product acceptance status in Mirakl for each channel, using this pattern: channel_code|status."
},
"mirakl-channels-last-operator-acceptance-action-date": {
"type": "string",
"description": "Date/time of last operator action that changed the acceptance status of the product, specific to each channel, if any. It uses this pattern: channel_code|date."
},
"mirakl-channels-last-operator-acceptance-action-rule-code": {
"type": "string",
"description": "Code of the automation rule to last modify the acceptance status, specific to each channel, if any. It uses this pattern: channel_code|rule_code."
},
"mirakl-channels-last-operator-acceptance-action-user-name": {
"type": "string",
"description": "Name of user who performed last action that changed the acceptance status of the product, specific to each channel, if any. It uses this pattern: channel_code|user."
},
"mirakl-channels-rejection-message": {
"type": "string",
"description": "The rejection message of an exported product, specific to each channel, if any. It uses this pattern: channel_code|rejection_message. The column is empty if there is no rejection message."
},
"mirakl-channels-rejection-reason": {
"type": "string",
"description": "The rejection reason of an exported product, specific to each channel, if any. It uses this pattern: channel_code|rejection_code. The column is empty if there is no rejection reason."
},
"mirakl-channels-validation-statuses": {
"type": "array",
"description": "Mirakl validation status for each channel on exported product, following the pattern: channel_code|status. Can be VALID, INVALID, or NOT_ANALYZED if the validation status is not yet calculated for this channel. Otherwise, the column is empty.",
"items": {
"type": "string"
}
},
"mirakl-creation-date": {
"type": "string",
"format": "date-time",
"description": "The creation date of the product."
},
"mirakl-integration-errors": {
"type": "array",
"description": "Integration errors for each exported product, following the pattern : error_code|error_message|attribute_code Otherwise, the column is empty.",
"items": {
"type": "string"
}
},
"mirakl-last-operator-acceptance-action-date": {
"type": "string",
"description": "Date/time of last operator action that changed the acceptance status of the product."
},
"mirakl-last-operator-acceptance-action-rule-code": {
"type": "string",
"description": "Code of the automation rule to last modify the acceptance status"
},
"mirakl-last-operator-acceptance-action-user-name": {
"type": "string",
"description": "Name of user who performed last action that changed the acceptance status of the product."
},
"mirakl-product-id": {
"type": "string",
"description": "The Mirakl unique identifier for each exported product. Store this unique identifier in your system and use it in API CM21 to identify the correct integration or to report integration errors for each product."
},
"mirakl-product-sku": {
"type": "string",
"description": "The SKU of the product."
},
"mirakl-product-urls": {
"type": "array",
"description": "The list of product urls, if any. Following the pattern : qualifier|link",
"items": {
"type": "string"
}
},
"mirakl-rejection-message": {
"type": "string",
"description": "The rejection message for the product, if any. Otherwise, the column is empty."
},
"mirakl-rejection-reason": {
"type": "string",
"description": "The rejection reason for the product, if any. Otherwise, the column is empty."
},
"mirakl-restricted-selling": {
"type": "boolean",
"description": "The boolean to determined if the product has selling restriction."
},
"mirakl-sources": {
"type": "array",
"description": "The list of provider unique identifiers, following the pattern providerId|providerUniqueIdentifier ",
"items": {
"type": "string"
}
},
"mirakl-synchronization-status": {
"type": "string",
"description": "Mirakl synchronization status for each exported product."
},
"mirakl-trust-and-safety-analyzed-at": {
"type": "string",
"format": "date-time",
"description": "The product moderation date"
},
"mirakl-trust-and-safety-review-date": {
"type": "string",
"format": "date-time",
"description": "The date of the moderation review"
},
"mirakl-trust-and-safety-review-status": {
"type": "string",
"description": "The status of the moderation review: SAFE, HARMFUL."
},
"mirakl-trust-and-safety-review-user-name": {
"type": "string",
"description": "Name of the operator user who did the moderation review"
},
"mirakl-trust-and-safety-risk-categories": {
"type": "string",
"description": "Risk category code and its related harmfulness score, following the pattern: risk_category_code|score. Multiple risk categories are comma-separated. The column is empty if the product has not been flagged."
},
"mirakl-trust-and-safety-score": {
"type": "string",
"description": "Overall harmfulness score of the product."
},
"mirakl-update-date": {
"type": "string",
"format": "date-time",
"description": "The last updated date of the product."
},
"mirakl-validation-status": {
"type": "string",
"description": "Mirakl validation status for each exported product."
}
},
"required": [
"mirakl-acceptance-status",
"mirakl-product-id",
"mirakl-product-sku",
"mirakl-synchronization-status",
"mirakl-update-date",
"mirakl-validation-status"
]
},
"CM61_Response_200_Ext_FileStructure": {
"type": "object",
"description": "JSON output",
"properties": {
"creation_date": {
"type": "string",
"format": "date-time",
"description": "The creation date of the product."
},
"deletion_date": {
"type": "string",
"format": "date-time",
"description": "The deletion date of the product."
},
"deletion_user": {
"$ref": "#/components/schemas/CM61_Response_200_Ext_FileStructure_DeletionUser",
"description": "The operator user who deleted the product."
},
"mirakl_product_id": {
"type": "string",
"description": "The Mirakl unique identifier for each exported deleted product."
},
"product_sku": {
"type": "string",
"description": "The operator unique identifier of the product deleted."
}
},
"required": [
"deletion_date",
"mirakl_product_id"
]
},
"CM61_Response_200_Ext_FileStructure_DeletionUser": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The user name"
}
}
},
"CM61_Response_200_TextCsv_Ext_FileStructure": {
"type": "object",
"description": "CSV output",
"properties": {
"mirakl-creation-date": {
"type": "string",
"format": "date-time",
"description": "The creation date of the product."
},
"mirakl-deletion-date": {
"type": "string",
"format": "date-time",
"description": "The deletion date of the product."
},
"mirakl-deletion-username": {
"type": "string",
"description": "The operator user who deleted the product."
},
"mirakl-product-id": {
"type": "string",
"description": "The Mirakl unique identifier for each exported deleted product."
},
"mirakl-product-sku": {
"type": "string",
"description": "The operator unique identifier of the product deleted."
}
},
"required": [
"mirakl-deletion-date",
"mirakl-product-id"
]
},
"CUR01_Response_200": {
"type": "object",
"properties": {
"currencies": {
"type": "array",
"description": "List of currencies",
"items": {
"$ref": "#/components/schemas/CUR01_Response_200_Currencies"
}
}
},
"required": [
"currencies"
]
},
"CUR01_Response_200_Currencies": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Currency code"
},
"label": {
"type": "string",
"description": "Currency label"
},
"platform_default": {
"type": "boolean",
"description": "Default currency of the platform"
}
},
"required": [
"code",
"label"
]
},
"DO01_Response_200": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"description": "Document types",
"items": {
"$ref": "#/components/schemas/DO01_Response_200_Documents"
}
}
},
"required": [
"documents"
]
},
"DO01_Response_200_Documents": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Type code"
},
"description": {
"type": "string",
"description": "Type description"
},
"entity": {
"type": "string",
"description": "Entity type linked to the document type\n\nEnum: `\"ORDER\"`, `\"SHOP\"`\n"
},
"label": {
"type": "string",
"description": "Type label "
},
"mime_types": {
"type": "array",
"description": "Authorized mime types",
"items": {
"type": "string"
}
},
"models": {
"type": "array",
"description": "The list of platform models on which this document type is available. This field is only present for document types linked to a 'SHOP' entity.",
"items": {
"type": "string",
"description": "Enum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n"
}
}
},
"required": [
"code",
"description",
"entity",
"label"
]
},
"H01_Request_MultipartFormData_File_Ext_FileStructure": {
"type": "object",
"properties": {
"hierarchy-code": {
"type": "string",
"description": "Code of the hierarchy",
"maxLength": 255,
"minLength": 0
},
"hierarchy-label": {
"type": "string",
"description": "Label of the hierarchy",
"maxLength": 255,
"minLength": 0
},
"hierarchy-label[xx]": {
"type": "string",
"description": "Label of the hierarchy in a specific language.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n",
"maxLength": 255,
"minLength": 0
},
"hierarchy-parent-code": {
"type": "string",
"description": "Code of the parent hierarchy",
"maxLength": 255,
"minLength": 0
},
"update-delete": {
"type": "string",
"description": "Update or delete the hierarchy.\n\nThe possible values are `update` and `delete`.true\" if error report is available. Value is filled when the import is completed."
},
"import_status": {
"type": "string",
"description": "Import status\n\nEnum: `\"WAITING\"`, `\"QUEUED\"`, `\"RUNNING\"`, `\"COMPLETE\"`, `\"CANCELLED\"`, `\"FAILED\"`\n"
}
},
"required": [
"has_error_report",
"import_status"
]
},
"H03_Response_200_TextCsv_Ext_FileStructure": {
"type": "object",
"description": "CSV output",
"properties": {
"error-line": {
"type": "string",
"description": "Number of the error line"
},
"error-message": {
"type": "string",
"description": "Description of the error"
},
"hierarchy-code": {
"type": "string",
"description": "Code of the hierarchy",
"maxLength": 255,
"minLength": 0
},
"hierarchy-label": {
"type": "string",
"description": "Label of the hierarchy",
"maxLength": 255,
"minLength": 0
},
"hierarchy-label[xx]": {
"type": "string",
"description": "Label of the hierarchy in a specific language.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n",
"maxLength": 255,
"minLength": 0
},
"hierarchy-parent-code": {
"type": "string",
"description": "Code of the parent hierarchy",
"maxLength": 255,
"minLength": 0
},
"update-delete": {
"type": "string",
"description": "Update or delete the hierarchy.\n\nThe possible values are `update` and `delete`.DISABLED"
},
"ai_rewrite": {
"$ref": "#/components/schemas/P41_Request_MultipartFormData_ConversionOptions_AiRewrite",
"description": "Enable AI rewrite. Default to ENABLED"
},
"ai_translation": {
"$ref": "#/components/schemas/P41_Request_MultipartFormData_ConversionOptions_AiTranslation",
"description": "Enable AI translation. Default to DISABLED"
}
}
},
"P41_Request_MultipartFormData_ConversionOptions_AiEnrichment": {
"type": "object",
"description": "Enable AI translation. Default to DISABLED",
"properties": {
"status": {
"type": "string",
"description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n"
}
}
},
"P41_Request_MultipartFormData_ConversionOptions_AiRewrite": {
"type": "object",
"description": "Enable AI translation. Default to DISABLED",
"properties": {
"status": {
"type": "string",
"description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n"
}
}
},
"P41_Request_MultipartFormData_ConversionOptions_AiTranslation": {
"type": "object",
"description": "Enable AI translation. Default to DISABLED",
"properties": {
"status": {
"type": "string",
"description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n"
}
}
},
"P41_Response_201": {
"type": "object",
"properties": {
"import_id": {
"type": "integer",
"format": "int64",
"description": "Import identifier"
}
},
"required": [
"import_id"
]
},
"P42_Response_200": {
"type": "object",
"properties": {
"conversion_options": {
"$ref": "#/components/schemas/P42_Response_200_ConversionOptions",
"description": "Options used for the conversion"
},
"conversion_type": {
"type": "string",
"description": "Type of conversion applied on products\n\nEnum: `\"AI_CONVERTER\"`\n"
},
"date_created": {
"type": "string",
"format": "date-time",
"description": "Import creation date"
},
"has_error_report": {
"type": "boolean",
"description": "Returns true if error report is available. Value is filled when the import status is COMPLETE."
},
"has_new_product_report": {
"type": "boolean",
"description": "Returns true if new product report is available. Value is filled when the import status is COMPLETE."
},
"has_transformation_error_report": {
"type": "boolean",
"description": "Returns true if transformation error report is available. Value is filled when the import status is SENT or COMPLETE."
},
"has_transformed_file": {
"type": "boolean",
"description": "Returns true if transformed file is available. Value is filled when the import status is SENT or COMPLETE."
},
"import_id": {
"type": "integer",
"format": "int64",
"description": "Import identifier"
},
"import_status": {
"type": "string",
"description": "Import status\n\nEnum: `\"TRANSFORMATION_WAITING\"`, `\"TRANSFORMATION_RUNNING\"`, `\"TRANSFORMATION_FAILED\"`, `\"WAITING\"`, `\"RUNNING\"`, `\"SENT\"`, `\"COMPLETE\"`, `\"CANCELLED\"`, `\"FAILED\"`\n"
},
"integration_details": {
"$ref": "#/components/schemas/P42_Response_200_IntegrationDetails",
"description": "Integration details"
},
"reason_status": {
"type": "string",
"description": "A message explaining the reason of the import status, if relevant"
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "Shop identifier"
},
"transform_lines_in_error": {
"type": "integer",
"format": "int64",
"description": "Total count of transformed lines in error"
},
"transform_lines_in_success": {
"type": "integer",
"format": "int64",
"description": "Total count of transformed lines in success"
},
"transform_lines_read": {
"type": "integer",
"format": "int64",
"description": "Total count of transformed lines read"
},
"transform_lines_with_warning": {
"type": "integer",
"format": "int64",
"description": "Total count of transformed lines with warning"
}
},
"required": [
"date_created",
"has_error_report",
"has_new_product_report",
"has_transformed_file",
"import_id",
"import_status",
"shop_id",
"transform_lines_in_error",
"transform_lines_in_success",
"transform_lines_read",
"transform_lines_with_warning"
]
},
"P42_Response_200_ConversionOptions": {
"type": "object",
"properties": {
"ai_enrichment": {
"$ref": "#/components/schemas/P42_Response_200_ConversionOptions_AiEnrichment",
"description": "Enable AI enrichment"
},
"ai_rewrite": {
"$ref": "#/components/schemas/P42_Response_200_ConversionOptions_AiRewrite",
"description": "Enable AI rewrite"
},
"ai_translation": {
"$ref": "#/components/schemas/P42_Response_200_ConversionOptions_AiTranslation",
"description": "Enable AI translation"
}
}
},
"P42_Response_200_ConversionOptions_AiEnrichment": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n"
}
}
},
"P42_Response_200_ConversionOptions_AiRewrite": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n"
}
}
},
"P42_Response_200_ConversionOptions_AiTranslation": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n"
}
}
},
"P42_Response_200_IntegrationDetails": {
"type": "object",
"properties": {
"invalid_products": {
"type": "integer",
"format": "int64",
"description": "Number of invalid products"
},
"products_not_accepted_in_time": {
"type": "integer",
"format": "int64",
"description": "Number of products that haven't been accepted in the required time"
},
"products_not_synchronized_in_time": {
"type": "integer",
"format": "int64",
"description": "Number of products that haven't been synchronized in the required time"
},
"products_reimported": {
"type": "integer",
"format": "int64",
"description": "Number of products that have been reimported in a more recent file"
},
"products_successfully_synchronized": {
"type": "integer",
"format": "int64",
"description": "Number of products successfully synchronized on operator system"
},
"products_with_synchronization_issues": {
"type": "integer",
"format": "int64",
"description": "Number of products having synchronization issues with operator system"
},
"products_with_wrong_identifiers": {
"type": "integer",
"format": "int64",
"description": "Number of products having wrong identifiers"
},
"rejected_products": {
"type": "integer",
"format": "int64",
"description": "Number of rejected products by operator system"
}
}
},
"P43_Request_MultipartFormData_IntegrationDetails": {
"type": "object",
"properties": {
"invalid_products": {
"type": "integer",
"format": "int64",
"description": "Number of invalid products"
},
"products_not_accepted_in_time": {
"type": "integer",
"format": "int64",
"description": "Number of products that haven't been accepted in the required time"
},
"products_not_synchronized_in_time": {
"type": "integer",
"format": "int64",
"description": "Number of products that haven't been synchronized in the required time"
},
"products_reimported": {
"type": "integer",
"format": "int64",
"description": "Number of products that have been reimported in a more recent file"
},
"products_successfully_synchronized": {
"type": "integer",
"format": "int64",
"description": "Number of products successfully synchronized on operator system"
},
"products_with_synchronization_issues": {
"type": "integer",
"format": "int64",
"description": "Number of products having synchronization issues with operator system"
},
"products_with_wrong_identifiers": {
"type": "integer",
"format": "int64",
"description": "Number of products having wrong identifiers"
},
"rejected_products": {
"type": "integer",
"format": "int64",
"description": "Number of rejected products by operator system"
}
}
},
"P51_Response_200": {
"type": "object",
"properties": {
"product_import_trackings": {
"type": "array",
"description": "List of product import status information",
"items": {
"$ref": "#/components/schemas/P51_Response_200_ProductImportTrackings"
}
},
"total_count": {
"type": "integer",
"format": "int32",
"description": "Total count of product import status information"
}
},
"required": [
"total_count"
]
},
"P51_Response_200_ProductImportTrackings": {
"type": "object",
"properties": {
"conversion_options": {
"$ref": "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions",
"description": "Options used for the conversion"
},
"conversion_type": {
"type": "string",
"description": "Type of conversion applied on products\n\nEnum: `\"AI_CONVERTER\"`\n"
},
"date_created": {
"type": "string",
"format": "date-time",
"description": "Import creation date"
},
"has_error_report": {
"type": "boolean",
"description": "Returns true if error report is available. Value is filled when the import status is COMPLETE."
},
"has_new_product_report": {
"type": "boolean",
"description": "Returns true if new product report is available. Value is filled when the import status is COMPLETE."
},
"has_transformation_error_report": {
"type": "boolean",
"description": "Returns true if transformation error report is available. Value is filled when the import status is SENT or COMPLETE."
},
"has_transformed_file": {
"type": "boolean",
"description": "Returns true if transformed file is available. Value is filled when the import status is SENT or COMPLETE."
},
"import_id": {
"type": "integer",
"format": "int64",
"description": "Import identifier"
},
"import_status": {
"type": "string",
"description": "Import status\n\nEnum: `\"TRANSFORMATION_WAITING\"`, `\"TRANSFORMATION_RUNNING\"`, `\"TRANSFORMATION_FAILED\"`, `\"WAITING\"`, `\"RUNNING\"`, `\"SENT\"`, `\"COMPLETE\"`, `\"CANCELLED\"`, `\"FAILED\"`\n"
},
"integration_details": {
"$ref": "#/components/schemas/P51_Response_200_ProductImportTrackings_IntegrationDetails",
"description": "Integration details"
},
"reason_status": {
"type": "string",
"description": "A message explaining the reason of the import status, if relevant"
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "Shop identifier"
},
"transform_lines_in_error": {
"type": "integer",
"format": "int64",
"description": "Total count of transformed lines in error"
},
"transform_lines_in_success": {
"type": "integer",
"format": "int64",
"description": "Total count of transformed lines in success"
},
"transform_lines_read": {
"type": "integer",
"format": "int64",
"description": "Total count of transformed lines read"
},
"transform_lines_with_warning": {
"type": "integer",
"format": "int64",
"description": "Total count of transformed lines with warning"
}
},
"required": [
"date_created",
"has_error_report",
"has_new_product_report",
"has_transformed_file",
"import_id",
"import_status",
"shop_id",
"transform_lines_in_error",
"transform_lines_in_success",
"transform_lines_read",
"transform_lines_with_warning"
]
},
"P51_Response_200_ProductImportTrackings_ConversionOptions": {
"type": "object",
"properties": {
"ai_enrichment": {
"$ref": "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiEnrichment",
"description": "Enable AI enrichment"
},
"ai_rewrite": {
"$ref": "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiRewrite",
"description": "Enable AI rewrite"
},
"ai_translation": {
"$ref": "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiTranslation",
"description": "Enable AI translation"
}
}
},
"P51_Response_200_ProductImportTrackings_ConversionOptions_AiEnrichment": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n"
}
}
},
"P51_Response_200_ProductImportTrackings_ConversionOptions_AiRewrite": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n"
}
}
},
"P51_Response_200_ProductImportTrackings_ConversionOptions_AiTranslation": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n"
}
}
},
"P51_Response_200_ProductImportTrackings_IntegrationDetails": {
"type": "object",
"properties": {
"invalid_products": {
"type": "integer",
"format": "int64",
"description": "Number of invalid products"
},
"products_not_accepted_in_time": {
"type": "integer",
"format": "int64",
"description": "Number of products that haven't been accepted in the required time"
},
"products_not_synchronized_in_time": {
"type": "integer",
"format": "int64",
"description": "Number of products that haven't been synchronized in the required time"
},
"products_reimported": {
"type": "integer",
"format": "int64",
"description": "Number of products that have been reimported in a more recent file"
},
"products_successfully_synchronized": {
"type": "integer",
"format": "int64",
"description": "Number of products successfully synchronized on operator system"
},
"products_with_synchronization_issues": {
"type": "integer",
"format": "int64",
"description": "Number of products having synchronization issues with operator system"
},
"products_with_wrong_identifiers": {
"type": "integer",
"format": "int64",
"description": "Number of products having wrong identifiers"
},
"rejected_products": {
"type": "integer",
"format": "int64",
"description": "Number of rejected products by operator system"
}
}
},
"PC01_Response_200": {
"type": "object",
"properties": {
"features": {
"$ref": "#/components/schemas/PC01_Response_200_Features",
"description": "Features activated on the platform"
},
"modules": {
"$ref": "#/components/schemas/PC01_Response_200_Modules",
"description": "Modules activated on the platform"
},
"platform_configuration": {
"$ref": "#/components/schemas/PC01_Response_200_PlatformConfiguration",
"description": "High level platform configurations"
},
"platform_name": {
"type": "string",
"description": "Operator platform name"
},
"tenant_name": {
"type": "string",
"description": "Tenant platform name"
},
"timezone": {
"type": "string",
"description": "Platform timezone"
}
},
"required": [
"features",
"modules",
"platform_configuration",
"platform_name",
"tenant_name",
"timezone"
]
},
"PC01_Response_200_Features": {
"type": "object",
"properties": {
"catalog": {
"$ref": "#/components/schemas/PC01_Response_200_Features_Catalog",
"description": "Catalog related features"
},
"circular_economy_data_collection": {
"type": "boolean",
"description": "Allows operators to collect data related to the circular economy regulation"
},
"competitive_pricing_tool": {
"type": "boolean",
"description": "The competitive pricing tool allows stores to view and possibly match competing Marketplace offers"
},
"direct_payment_customer_store": {
"$ref": "#/components/schemas/PC01_Response_200_Features_DirectPaymentCustomerStore",
"description": "Allows transactions taking place outside of Mirakl between customers and sellers"
},
"disable_seller_alternative_carrier": {
"type": "boolean",
"description": "Prevent stores from specifying alternatives carriers outside those predefined by the operator"
},
"dropship": {
"$ref": "#/components/schemas/PC01_Response_200_Features_Dropship",
"description": "Dropship related features"
},
"kyc_status_per_seller": {
"type": "boolean",
"description": "Allows PSPs to provide operators with seller KYC statuses"
},
"lead_time_to_ship_by_sellers_enabled": {
"type": "string",
"description": "Allows sellers to override the default lead time to ship\n\nEnum: `\"YES\"`, `\"NO\"`, `\"YES_PER_STORE\"`\n"
},
"multi_currency": {
"type": "boolean",
"description": "Defines if platform support multi currencies"
},
"multi_payout_psp_per_seller": {
"type": "boolean",
"description": "Allows the operator to use Hybrid pay-out PSP feature"
},
"no_reply_needed": {
"type": "boolean",
"description": "Allows to end order-related conversations when the last message sent from customer does not specifically require a reply"
},
"offer_prices_decimals": {
"type": "string",
"description": "Defines maximum number of decimals in offer prices"
},
"operator_csv_delimiter": {
"type": "string",
"description": "The delimiter used in the CSV files exported from the back office. COMMA: ',' delimiter. SEMICOLON: ';' delimiter.\n\nEnum: `\"COMMA\"`, `\"SEMICOLON\"`\n"
},
"order_conditions": {
"$ref": "#/components/schemas/PC01_Response_200_Features_OrderConditions",
"description": "Order conditions related features activated"
},
"order_tax_mode": {
"type": "string",
"description": "Prices with tax included or excluded in order-related APIs. TAX_INCLUDED: Prices with tax included. TAX_EXCLUDED: Prices with tax excluded.\n\nEnum: `\"TAX_INCLUDED\"`, `\"TAX_EXCLUDED\"`\n"
},
"order_workflows": {
"$ref": "#/components/schemas/PC01_Response_200_Features_OrderWorkflows",
"description": "Order workflows activated"
},
"payment_confirmation": {
"type": "boolean",
"description": "Allows the operator to mark an accounting document as \"Paid\" when the corresponding amount is confirmed to be paid to the seller"
},
"pricing": {
"$ref": "#/components/schemas/PC01_Response_200_Features_Pricing",
"description": "Pricing related features activated"
},
"product_data_validation_by_channel": {
"type": "boolean",
"deprecated": true,
"description": "Facilitates the management of attributes in a multilingual context
Moved in catalog section. Use catalog.product_data_validation_by_channel instead.
" }, "promotion": { "$ref": "#/components/schemas/PC01_Response_200_Features_Promotion", "description": "Promotion related features activated" }, "returns": { "$ref": "#/components/schemas/PC01_Response_200_Features_Returns", "description": "Returns management feature activated" }, "shipment": { "$ref": "#/components/schemas/PC01_Response_200_Features_Shipment", "description": "Shipment related features activated" }, "shop_tax_options": { "$ref": "#/components/schemas/PC01_Response_200_Features_ShopTaxOptions", "description": "Tax-related options for professional shops" }, "tax_collection": { "$ref": "#/components/schemas/PC01_Response_200_Features_TaxCollection", "description": "Allows the collection of information required to calculate taxes, with or without the tax connector" }, "tax_id_number": { "$ref": "#/components/schemas/PC01_Response_200_Features_TaxIdNumber", "description": "Unique identifier used to conduct tax-related formalities" }, "warehouses": { "$ref": "#/components/schemas/PC01_Response_200_Features_Warehouses", "description": "Allows operators to apply specific configuration on store account warehouses" } }, "required": [ "catalog", "circular_economy_data_collection", "competitive_pricing_tool", "direct_payment_customer_store", "disable_seller_alternative_carrier", "dropship", "kyc_status_per_seller", "lead_time_to_ship_by_sellers_enabled", "multi_currency", "multi_payout_psp_per_seller", "no_reply_needed", "offer_prices_decimals", "operator_csv_delimiter", "order_conditions", "order_tax_mode", "order_workflows", "payment_confirmation", "pricing", "product_data_validation_by_channel", "promotion", "returns", "shipment", "shop_tax_options", "tax_collection", "tax_id_number", "warehouses" ] }, "PC01_Response_200_Features_Catalog": { "type": "object", "properties": { "allow_shop_contribution_to_all_channels": { "type": "boolean", "description": "Allows shops to contribute data to all sales channels when enabled; otherwise, data can only be pushed to channels the shop belongs to" }, "exclude_invalid_products": { "type": "boolean", "description": "When enabled, products with validation errors will be excluded from product imports and won't be transmitted to MCM" }, "list_of_multiple_values_separator": { "type": "string", "description": "Character used to separate values in the 'Multiple Values List' type attributes" }, "product_acceptance_by_channel": { "type": "boolean", "description": "Allows operators to accept or reject products according to sales channels" }, "product_data_validation_by_channel": { "type": "boolean", "description": "Facilitates the management of attributes in a multilingual context" }, "product_import_only_on_leaf": { "type": "boolean", "description": "Prevents the import of products into non-leaf categories" } }, "required": [ "allow_shop_contribution_to_all_channels", "exclude_invalid_products", "list_of_multiple_values_separator", "product_acceptance_by_channel", "product_data_validation_by_channel", "product_import_only_on_leaf" ] }, "PC01_Response_200_Features_DirectPaymentCustomerStore": { "type": "object", "properties": { "activated": { "type": "boolean", "description": "Direct payment customer store activated" }, "refund_cancel_authorized": { "type": "boolean", "description": "Allows refund and cancelation for transactions taking place outside of Mirakl between customers and sellers" } }, "required": [ "activated", "refund_cancel_authorized" ] }, "PC01_Response_200_Features_Dropship": { "type": "object", "properties": { "retail_pricing_edition_enabled": { "type": "string", "description": "Retail pricing edition enabled\n\nEnum: `\"YES\"`, `\"NO\"`, `\"YES_PER_STORE\"`\n" }, "retail_pricing_enabled": { "type": "boolean", "description": "Retail pricing activated on dropship offers" } } }, "PC01_Response_200_Features_OrderConditions": { "type": "object", "properties": { "lead_time_to_ship": { "type": "boolean", "deprecated": true, "description": "Allows sellers to inform a lead time to ship on their offers
Use \"lead_time_to_ship_by_sellers_enabled\" attribute instead.
" }, "maximum_order_quantity": { "type": "boolean", "description": "Allows sellers to request for a maximum order quantity" }, "minimum_order_quantity": { "type": "boolean", "description": "Allows sellers to request for a minimum order quantity" }, "package_order_quantity": { "type": "boolean", "description": "Allows sellers to set an order quantity increment" } }, "required": [ "lead_time_to_ship", "maximum_order_quantity", "minimum_order_quantity", "package_order_quantity" ] }, "PC01_Response_200_Features_OrderWorkflows": { "type": "object", "properties": { "no_customer_payment_confirmation": { "type": "boolean", "description": "Allows seller payments to be completely separated from customer debits" }, "order_acceptance": { "type": "string", "description": "Indicate if shop accounts must accept new orders and take responsibility for the transaction. NOT_AUTOMATIC: All shop accounts must accept their orders manually. AUTOMATIC: Orders are automatically accepted. BOTH: AUTOMATIC or NOT_AUTOMATIC mode depending on the store account\n\nEnum: `\"AUTOMATIC\"`, `\"NOT_AUTOMATIC\"`, `\"BOTH\"`\n" }, "pause_debit_workflow": { "type": "boolean", "description": "Pause the order debit workflow when taxes must be recalculated" }, "pay_on_due_date": { "type": "boolean", "description": "Allows professionals to pay their orders after the receipt of the items or an explicit invoice" }, "pay_on_shipment": { "type": "boolean", "description": "Allows operators to debit orders before they have been fully shipped" }, "sellers_edit_shipping_origin": { "type": "boolean", "description": "Allow shop accounts to edit shipping origin to ensures accurate tax calculations with shipping origin data" }, "shipping_and_billing_details_before_acceptance": { "type": "boolean", "description": "Indicate if shipping and billing details are displayed before order acceptance" } }, "required": [ "no_customer_payment_confirmation", "order_acceptance", "pause_debit_workflow", "pay_on_due_date", "pay_on_shipment", "sellers_edit_shipping_origin", "shipping_and_billing_details_before_acceptance" ] }, "PC01_Response_200_Features_Pricing": { "type": "object", "properties": { "channel_pricing": { "type": "string", "description": "Allows sellers to create prices applicable on the operator’s different storefronts materialized as sales channels in Mirakl. DISABLED: No channel pricing. SINGLE: Allows sellers to create one price per channel. MULTI: Allows sellers to create multiple prices per channel.\n\nEnum: `\"MULTI\"`, `\"SINGLE\"`, `\"DISABLED\"`\n" }, "discount_period_required": { "type": "boolean", "description": "Requires sellers to set start and end dates when creating or updating discounts on default and specific prices." }, "discount_price_creation_in_the_past_blocked": { "type": "boolean", "description": "Prevents sellers from setting discount end dates in the past for their default and specific prices." }, "scheduled_pricing": { "type": "boolean", "description": "Allows sellers to set up multiple prices in advance" }, "volume_discount": { "type": "boolean", "description": "Allows discounts for bulk purchases" }, "volume_pricing": { "type": "boolean", "description": "Allows pricing for bulk purchases" } }, "required": [ "channel_pricing", "discount_period_required", "discount_price_creation_in_the_past_blocked", "scheduled_pricing", "volume_discount", "volume_pricing" ] }, "PC01_Response_200_Features_Promotion": { "type": "object", "properties": { "cart_promotion_campaign": { "type": "boolean", "description": "Allows the operator to create cart promotion campaigns." }, "discount_campaign": { "type": "boolean", "description": "Allows the operator to create discount campaigns." }, "seller_promotion": { "type": "boolean", "description": "Allows stores to create promotions." } }, "required": [ "cart_promotion_campaign", "discount_campaign", "seller_promotion" ] }, "PC01_Response_200_Features_Returns": { "type": "object", "properties": { "drop_ship": { "type": "boolean", "description": "Enables returns management in Drop ship" }, "marketplace": { "type": "boolean", "description": "Enables returns management in Marketplace" }, "one_creditor": { "type": "boolean", "description": "Enables returns management in One creditor" } } }, "PC01_Response_200_Features_Shipment": { "type": "object", "properties": { "multi_part_item_shipment": { "type": "boolean", "description": "Allows sellers to create several packages for a same item in an order" }, "multi_shipment": { "type": "boolean", "description": "Allows sellers to create several shipments for a same order" } }, "required": [ "multi_part_item_shipment", "multi_shipment" ] }, "PC01_Response_200_Features_ShopTaxOptions": { "type": "object", "properties": { "local_tax_number": { "$ref": "#/components/schemas/PC01_Response_200_Features_ShopTaxOptions_LocalTaxNumber", "description": "The VAT/GST number of a seller billing information and fiscal representative" }, "tax_identification_number": { "$ref": "#/components/schemas/PC01_Response_200_Features_ShopTaxOptions_TaxIdentificationNumber", "description": "The tax identification number of a seller billing information" } }, "required": [ "tax_identification_number" ] }, "PC01_Response_200_Features_ShopTaxOptions_LocalTaxNumber": { "type": "object", "properties": { "mandatory": { "type": "boolean", "description": "Defines if the VAT/GST number is mandatory" }, "validation_regex": { "type": "string", "description": "Regular expression that the VAT/GST number must match" } }, "required": [ "mandatory" ] }, "PC01_Response_200_Features_ShopTaxOptions_TaxIdentificationNumber": { "type": "object", "properties": { "mandatory": { "type": "boolean", "description": "Defines if the tax identification number is mandatory" }, "validation_regex": { "type": "string", "description": "Regular expression that the tax identification number must match" } }, "required": [ "mandatory" ] }, "PC01_Response_200_Features_TaxCollection": { "type": "object", "properties": { "activated": { "type": "string", "description": "Tax collection activated. NO: Not activated. YES: Activated for all stores. YES_PER_STORE: Activated for some stores.\n\nEnum: `\"YES\"`, `\"NO\"`, `\"YES_PER_STORE\"`\n" }, "product_tax_code_mandatory": { "type": "boolean", "description": "Product tax code mandatory at offer level" }, "tax_collection_by_operator": { "type": "boolean", "description": "Operator in charge of tax collection on behalf of sellers" } }, "required": [ "activated", "product_tax_code_mandatory", "tax_collection_by_operator" ] }, "PC01_Response_200_Features_TaxIdNumber": { "type": "object", "properties": { "mandatory": { "type": "boolean", "description": "Tax ID number mandatory" }, "validation_regex": { "type": "string", "description": "Regular expression to match for sellers tax number ID" } }, "required": [ "mandatory" ] }, "PC01_Response_200_Features_Warehouses": { "type": "object", "properties": { "geolocation": { "type": "boolean", "description": "Geolocation on warehouses activated" }, "restricted_countries": { "type": "array", "description": "The list of the restricted countries applying on warehouses. Format ISO 3166-1 alpha-3 code (3 letters country code). Possible values : AFG, ALA, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BEL, BLZ, BEN, BMU, BTN, BOL, BES, BIH, BWA, BVT, BRA, IOT, BRN, BGR, BFA, BDI, KHM, CMR, CAN, CPV, CYM, CAF, TCD, CHL, CHN, CXR, CCK, COL, COM, COG, COD, COK, CRI, CIV, HRV, CUB, CUW, CYP, CZE, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, ETH, FLK, FRO, FJI, FIN, FRA, GUF, PYF, ATF, GAB, GMB, GEO, DEU, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRQ, IRL, IMN, ISR, ITA, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MAC, MKD, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, REU, ROU, RUS, RWA, BLM, SHN, KNA, LCA, MAF, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SXM, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, ESP, LKA, SUR, SJM, SWZ, SWE, CHE, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, GBR, USA, UMI, URY, UZB, VUT, VEN, VNM, VGB, VIR, WLF, YEM, ZMB, ZWE", "items": { "type": "string", "description": "Enum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n" } } }, "required": [ "geolocation", "restricted_countries" ] }, "PC01_Response_200_Modules": { "type": "object", "properties": { "mirakl_catalog_integrator": { "type": "boolean", "description": "Mirakl Catalog integrator activated. Allows operator to manage catalog structure into Mirakl." }, "mirakl_catalog_manager": { "type": "boolean", "description": "Mirakl Catalog Manager activated. Allows operator to remove the complexity of integrating catalogs from multiple sources." }, "mirakl_catalog_transformer": { "type": "boolean", "description": "Mirakl Catalog Transformer activated." }, "mirakl_platform_services": { "type": "boolean", "description": "Mirakl Platform for Services activated. Specific module for services management: separated from the product management module." }, "offer_management": { "type": "boolean", "description": "Offer management available on the platform" }, "offer_management_mode": { "type": "string", "description": "Offer management mode on the platform: SIMPLE: All shops can push offers. HYBRID: The operator decides whether a shop can push offers on the platform." }, "order_management": { "type": "boolean", "description": "Order management available on the platform" }, "order_management_mode": { "type": "string", "description": "Order management mode on the platform: SIMPLE: All shops can process orders. HYBRID: The operator decides whether a shop can process orders on the platform." }, "promotions": { "type": "boolean", "deprecated": true, "description": "Deprecated: Promotion availability is now controlled by operator settings (cart_promotion_campaign and seller_promotion)." }, "quotes": { "type": "boolean", "description": "Quote module activated" }, "tax_manager": { "$ref": "#/components/schemas/PC01_Response_200_Modules_TaxManager", "deprecated": true, "description": "Allows operator to be connected with a tax calculation provider
The tax_manager feature is not supported anymore.
" } }, "required": [ "mirakl_catalog_integrator", "mirakl_catalog_manager", "mirakl_catalog_transformer", "mirakl_platform_services", "offer_management", "order_management", "promotions", "quotes", "tax_manager" ] }, "PC01_Response_200_Modules_TaxManager": { "type": "object", "deprecated": true, "properties": { "activated": { "type": "boolean", "description": "Tax Manager activated" }, "tax_provider": { "$ref": "#/components/schemas/PC01_Response_200_Modules_TaxManager_TaxProvider", "description": "The tax provider processing tax estimation" } }, "required": [ "activated", "tax_provider" ] }, "PC01_Response_200_Modules_TaxManager_TaxProvider": { "type": "object", "properties": { "avalara": { "type": "boolean", "description": "Avalara configured as tax provider" }, "vertex": { "type": "boolean", "description": "Vertex configured as tax provider" } }, "required": [ "avalara", "vertex" ] }, "PC01_Response_200_PlatformConfiguration": { "type": "object", "properties": { "customer_model": { "$ref": "#/components/schemas/PC01_Response_200_PlatformConfiguration_CustomerModel", "description": "The customer organization activation on the platform" }, "enhanced_seller_invoicing": { "$ref": "#/components/schemas/PC01_Response_200_PlatformConfiguration_EnhancedSellerInvoicing", "description": "Enhanced seller invoicing activation on the platform" }, "platform_model": { "$ref": "#/components/schemas/PC01_Response_200_PlatformConfiguration_PlatformModel", "description": "The platform models activated on the platform " } }, "required": [ "customer_model", "enhanced_seller_invoicing", "platform_model" ] }, "PC01_Response_200_PlatformConfiguration_CustomerModel": { "type": "object", "properties": { "b2b": { "type": "boolean", "description": "Customer model Business to Business is enabled: if true, customers can be linked to a customer organization" }, "b2c": { "type": "boolean", "description": "Customer model Business to Customer is enabled: if true, customers can be created without being linked to a customer organization" } }, "required": [ "b2b", "b2c" ] }, "PC01_Response_200_PlatformConfiguration_EnhancedSellerInvoicing": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enhanced seller invoicing activated." } }, "required": [ "enabled" ] }, "PC01_Response_200_PlatformConfiguration_PlatformModel": { "type": "object", "properties": { "drop_ship": { "type": "boolean", "description": "Drop ship platform model activated" }, "marketplace": { "type": "boolean", "description": "Marketplace platform model activated" }, "one_creditor": { "type": "boolean", "description": "One creditor platform model activated" } }, "required": [ "drop_ship", "marketplace", "one_creditor" ] }, "PC03_Response_200": { "type": "object", "properties": { "status": { "type": "string", "description": "Current status of the export\n\nEnum: `\"WAITING\"`, `\"QUEUED\"`, `\"RUNNING\"`, `\"COMPLETE\"`, `\"FAILED\"`\n" }, "urls": { "type": "array", "description": "List of generated urls to call to download platform configuration files", "items": { "type": "string" } } }, "required": [ "status" ] }, "PC06_Response_200": { "type": "object", "properties": { "status": { "type": "string", "description": "Current status of the import\n\nEnum: `\"WAITING_APPROVAL\"`, `\"WAITING\"`, `\"QUEUED\"`, `\"RUNNING\"`, `\"COMPLETE\"`, `\"FAILED\"`, `\"CANCELLED\"`\n" } }, "required": [ "status" ] }, "PM01_Request_MultipartFormData_File_Ext_FileStructure": { "type": "object", "properties": { "channels": { "type": "array", "description": "Channels to which the attribute will be linked", "items": { "type": "string" } }, "code": { "type": "string", "description": "Attribute code", "maxLength": 255, "minLength": 0 }, "default-value": { "type": "string", "deprecated": true, "description": "Default value for value list type attributes. This value is selected by default for the corresponding attribute when sellers create a product in their back office.
Use type-parameters instead
" }, "description": { "type": "string", "description": "Attribute description", "maxLength": 2000, "minLength": 0 }, "description[xx]": { "type": "string", "description": "Internationalized attribute description.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n", "maxLength": 2000, "minLength": 0 }, "example": { "type": "string", "description": "Attribute example to help sellers when they fill the product creation form", "maxLength": 2000, "minLength": 0 }, "hierarchy-code": { "type": "string", "description": "Attribute hierarchy (category) code" }, "label": { "type": "string", "description": "Attribute label", "maxLength": 255, "minLength": 0 }, "label[xx]": { "type": "string", "description": "Internationalized attribute label.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n", "maxLength": 255, "minLength": 0 }, "locale": { "type": "string", "description": "Attribute localization.\n\nThe language format can either be:\n- ISO-639 (E.g. \"en\")\n- ISO-639_ISO-3166 (E.g. \"en_US\")\n" }, "requirement-level": { "type": "string", "description": "Attribute requirement level.\n\nThe possible values are `REQUIRED`, `RECOMMENDED`, `OPTIONAL` and `DISABLED`.true\" if error report is available. Value is filled when the import is completed."
},
"import_status": {
"type": "string",
"description": "Status of the import\n\nEnum: `\"WAITING\"`, `\"QUEUED\"`, `\"RUNNING\"`, `\"COMPLETE\"`, `\"CANCELLED\"`, `\"FAILED\"`\n"
}
},
"required": [
"has_error_report",
"import_status"
]
},
"PM03_Response_200_TextCsv_Ext_FileStructure": {
"type": "object",
"description": "CSV output",
"properties": {
"channels": {
"type": "array",
"description": "Channels to which the attribute will be linked",
"items": {
"type": "string"
}
},
"code": {
"type": "string",
"description": "Attribute code",
"maxLength": 255,
"minLength": 0
},
"default-value": {
"type": "string",
"deprecated": true,
"description": "Default value for value list type attributes. This value is selected by default for the corresponding attribute when sellers create a product in their back office.
Use type-parameters instead
" }, "description": { "type": "string", "description": "Attribute description", "maxLength": 2000, "minLength": 0 }, "description[xx]": { "type": "string", "description": "Internationalized attribute description.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n", "maxLength": 2000, "minLength": 0 }, "error-line": { "type": "string", "description": "Number of the error line" }, "error-message": { "type": "string", "description": "Description of the error" }, "example": { "type": "string", "description": "Attribute example to help sellers when they fill the product creation form", "maxLength": 2000, "minLength": 0 }, "hierarchy-code": { "type": "string", "description": "Attribute hierarchy (category) code" }, "label": { "type": "string", "description": "Attribute label", "maxLength": 255, "minLength": 0 }, "label[xx]": { "type": "string", "description": "Internationalized attribute label.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n", "maxLength": 255, "minLength": 0 }, "locale": { "type": "string", "description": "Attribute localization.\n\nThe language format can either be:\n- ISO-639 (E.g. \"en\")\n- ISO-639_ISO-3166 (E.g. \"en_US\")\n" }, "requirement-level": { "type": "string", "description": "Attribute requirement level.\n\nThe possible values are `REQUIRED`, `RECOMMENDED`, `OPTIONAL` and `DISABLED`.Default value for value list type attributes
Use the \"type_parameters\" field for \"LIST\" attribute types to retrieve the default value.
" }, "description": { "type": "string", "description": "Attribute description" }, "description_translations": { "type": "array", "description": "Translations of the attribute description", "items": { "$ref": "#/components/schemas/PM11_Response_200_Attributes_DescriptionTranslations" } }, "example": { "type": "string", "description": "Attribute example to help sellers when they fill the product creation form" }, "hierarchy_code": { "type": "string", "description": "The code of the hierarchy (category) this attribute belongs to. If this field is empty, the attribute is shared among all hierarchies." }, "label": { "type": "string", "description": "Attribute label" }, "label_translations": { "type": "array", "description": "Translations of the attribute label", "items": { "$ref": "#/components/schemas/PM11_Response_200_Attributes_LabelTranslations" } }, "locale": { "type": "string", "description": "Attribute localization.\n\nThe language format can either be:\n- ISO-639 (E.g. \"en\")\n- ISO-639_ISO-3166 (E.g. \"en_US\")\n" }, "required": { "type": "boolean", "deprecated": true, "description": "Whether or not the attribute is required
This field is deprecated. Use the \"requirement_level\" field instead.
" }, "requirement_level": { "type": "string", "description": "Requirement level of the attribute\n\nEnum: `\"OPTIONAL\"`, `\"REQUIRED\"`, `\"RECOMMENDED\"`, `\"DISABLED\"`\n" }, "roles": { "type": "array", "description": "Attribute roles", "items": { "$ref": "#/components/schemas/PM11_Response_200_Attributes_Roles" } }, "transformations": { "type": "string", "description": "Transformations applied to the attribute (a list of transformations separated by commas)" }, "type": { "type": "string", "description": "Attribute type" }, "type_parameter": { "type": "string", "deprecated": true, "description": "Type parameter
This field is deprecated. Use the \"type_parameters\" field instead.
" }, "type_parameters": { "type": "array", "description": "Specificities of the attribute type, for example the date format, or the maximum size of a media", "items": { "$ref": "#/components/schemas/PM11_Response_200_Attributes_TypeParameters" } }, "unique_code": { "type": "string", "description": "Unique code of the attribute" }, "validations": { "type": "string", "description": "Validations applied to the attribute (a list of validations separated by commas)" }, "values": { "type": "array", "deprecated": true, "description": "A list of authorized values for this attribute", "items": { "$ref": "#/components/schemas/PM11_Response_200_Attributes_Values" } }, "values_list": { "type": "string", "deprecated": true, "description": "This code points to the list defining the authorized values for this attribute.
This API is deprecated. Use the \"type_parameter\" field for \"LIST\" attribute types to retrieve the value list code.
" }, "variant": { "type": "boolean", "description": "Whether or not the attribute is a variation axis. Possible values:true or false"
}
},
"required": [
"code",
"description_translations",
"label_translations",
"required",
"requirement_level",
"roles",
"type",
"type_parameter",
"variant"
]
},
"PM11_Response_200_Attributes_Channels": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Channel code"
}
},
"required": [
"code"
]
},
"PM11_Response_200_Attributes_DescriptionTranslations": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "Locale"
},
"value": {
"type": "string",
"description": "Translation"
}
},
"required": [
"locale",
"value"
]
},
"PM11_Response_200_Attributes_LabelTranslations": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "Locale"
},
"value": {
"type": "string",
"description": "Translation"
}
},
"required": [
"locale",
"value"
]
},
"PM11_Response_200_Attributes_Roles": {
"type": "object",
"properties": {
"parameters": {
"type": "array",
"description": "Attribute role parameters",
"items": {
"$ref": "#/components/schemas/PM11_Response_200_Attributes_Roles_Parameters"
}
},
"type": {
"type": "string",
"description": "Role type of the attribute"
}
},
"required": [
"parameters",
"type"
]
},
"PM11_Response_200_Attributes_Roles_Parameters": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter"
},
"value": {
"type": "string",
"description": "Value of the parameter"
}
},
"required": [
"name",
"value"
]
},
"PM11_Response_200_Attributes_TypeParameters": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter"
},
"value": {
"type": "string",
"description": "Value of the parameter"
}
},
"required": [
"name",
"value"
]
},
"PM11_Response_200_Attributes_Values": {
"type": "object",
"deprecated": true,
"properties": {
"code": {
"type": "string",
"description": "Value code
This API is deprecated. Use the \"type_parameter\" field for \"LIST\" attribute types to retrieve the value list code.
" } }, "required": [ "code" ] }, "PM11_Response_200_TextCsv_Ext_FileStructure": { "type": "object", "description": "CSV output", "properties": { "channels": { "type": "string", "description": "Channels (A list of codes separated by commas)" }, "code": { "type": "string", "description": "Attribute code" }, "default-value": { "type": "string", "deprecated": true, "description": "Default value for value list type attributes
Use the \"type_parameters\" field for \"LIST\" attribute types to retrieve the default value.
" }, "description": { "type": "string", "description": "Attribute description" }, "description[xx]": { "type": "string", "description": "The attribute description in a specific language. \"xx\" is replaced by the language code." }, "example": { "type": "string", "description": "Attribute example to help sellers when they fill the product creation form" }, "hierarchy-code": { "type": "string", "description": "The code of the hierarchy (category) this attribute belongs to. If this field is empty, the attribute is shared among all hierarchies." }, "label": { "type": "string", "description": "Attribute label" }, "label[xx]": { "type": "string", "description": "The attribute label in a specific language. \"xx\" is replaced by the language code." }, "locale": { "type": "string", "description": "Attribute localization.\n\nThe language format can either be:\n- ISO-639 (E.g. \"en\")\n- ISO-639_ISO-3166 (E.g. \"en_US\")\n" }, "required": { "type": "boolean", "deprecated": true, "description": "Whether or not the attribute is required
This field is deprecated. Use the \"requirement_level\" field instead.
" }, "requirement-level": { "type": "string", "description": "Requirement level of the attribute\n\nEnum: `\"OPTIONAL\"`, `\"REQUIRED\"`, `\"RECOMMENDED\"`, `\"DISABLED\"`\n" }, "roles": { "type": "string", "description": "Attribute roles (A list of roles separated by commas)" }, "transformations": { "type": "string", "description": "Transformations applied to the attribute (a list of transformations separated by commas)" }, "type": { "type": "string", "description": "Attribute type" }, "type-parameter": { "type": "string", "deprecated": true, "description": "Type parameter
This field is deprecated. Use the \"type-parameters\" field instead.
" }, "type-parameters": { "type": "string", "description": "Specificities of the attribute type, for example the date format, or the maximum size of a media (A list of 'name|value' separated by commas)" }, "unique-code": { "type": "string", "description": "Unique code of the attribute" }, "validations": { "type": "string", "description": "Validations applied to the attribute (a list of validations separated by commas)" }, "values": { "type": "string", "deprecated": true, "description": "A list of authorized values for this attribute" }, "values-list": { "type": "string", "deprecated": true, "description": "This code points to the list defining the authorized values for this attribute.
This API is deprecated. Use the \"type_parameter\" field for \"LIST\" attribute types to retrieve the value list code.
" }, "variant": { "type": "boolean", "description": "Whether or not the attribute is a variation axis. Possible values:true or false"
}
},
"required": [
"code",
"description[xx]",
"label[xx]",
"required",
"requirement-level",
"roles",
"type",
"type-parameter",
"variant"
]
},
"RO01_Response_200": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"description": "Operator role list",
"items": {
"$ref": "#/components/schemas/RO01_Response_200_Roles"
}
}
},
"required": [
"roles"
]
},
"RO01_Response_200_Roles": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Operator role code"
},
"description": {
"type": "string",
"description": "Operator role description "
}
},
"required": [
"code",
"description"
]
},
"RO02_Response_200": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RO02_Response_200_Roles"
}
}
}
},
"RO02_Response_200_Roles": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"S06_Request": {
"type": "object",
"properties": {
"shops": {
"type": "array",
"description": "Shops list",
"items": {
"$ref": "#/components/schemas/S06_Request_Shops"
}
}
},
"required": [
"shops"
]
},
"S06_Request_Shops": {
"type": "object",
"description": "Shops list",
"properties": {
"address": {
"$ref": "#/components/schemas/S06_Request_Shops_Address",
"description": "Shop address"
},
"assignees": {
"type": "array",
"description": "List of shop assignees",
"items": {
"$ref": "#/components/schemas/S06_Request_Shops_Assignees"
}
},
"channel_codes": {
"type": "array",
"description": "List of the channel codes associated to the shop",
"items": {
"type": "string",
"maxLength": 36
},
"maxLength": 36
},
"closed_from_date": {
"type": "string",
"format": "date-time",
"description": "Date: if defined, this shop will be closed on this date. Lower or equal to closed_to_date if not null"
},
"closed_to_date": {
"type": "string",
"format": "date-time",
"description": "Date: if defined, this shop will be reopened on this date. Greater or equal to closed_from_date if not null"
},
"currency_iso_code": {
"type": "string",
"description": "Shop currency\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n"
},
"description": {
"type": "string",
"description": "Shop description",
"maxLength": 3000
},
"domains": {
"type": "array",
"description": "Shop Domains",
"items": {
"type": "string",
"description": "Enum: `\"PRODUCT\"`, `\"SERVICE\"`\n"
}
},
"email": {
"type": "string",
"description": "Email",
"maxLength": 255
},
"existing_user": {
"$ref": "#/components/schemas/S06_Request_Shops_ExistingUser",
"description": "Existing user to link to the shop. Remove this field from the API request if new_user is specified."
},
"fax": {
"type": "string",
"description": "Fax",
"maxLength": 20
},
"immunity_date": {
"type": "string",
"format": "date-time",
"description": "Date until the shop is immunized from being suspended by the batch. Must be in the future."
},
"is_professional": {
"type": "boolean",
"description": "Whether or not the shop is professional. Default is false."
},
"model": {
"type": "string",
"description": "Platform model. Required in case of multiple configured models. Should be MARKETPLACE if domain is service.\n\nEnum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n"
},
"new_user": {
"$ref": "#/components/schemas/S06_Request_Shops_NewUser",
"description": "User to create and to link to the shop. Remove this field from the API request if existing_user is specified."
},
"operator_internal_id": {
"type": "string",
"description": "Operator internal id for the shop",
"maxLength": 255
},
"password": {
"type": "string",
"deprecated": true,
"description": "",
"maxLength": 255,
"minLength": 8
},
"payment_blocked": {
"type": "boolean",
"description": "Whether or not the shop payment should be suspended. Default is false."
},
"payment_info": {
"$ref": "#/components/schemas/S06_Request_Shops_PaymentInfo",
"description": "Payment information"
},
"payment_method_mandatory": {
"type": "boolean",
"description": "Payment method mandatory"
},
"permissions": {
"type": "array",
"description": "List of the shop permissions",
"items": {
"type": "string",
"description": "Enum: `\"PRODUCT_ACCESS\"`, `\"ORDER_ACCESS\"`, `\"OFFER_ACCESS\"`\n"
}
},
"pro_details": {
"$ref": "#/components/schemas/S06_Request_Shops_ProDetails",
"description": "Professional details. Required if shop is declared as professional."
},
"producer_identifiers": {
"type": "array",
"description": "List of shop’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection related to circular economy regulations is enabled.",
"items": {
"$ref": "#/components/schemas/S06_Request_Shops_ProducerIdentifiers"
},
"maxItems": 50,
"minItems": 0
},
"recycling_policy": {
"type": "string",
"description": "Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.",
"maxLength": 5000
},
"return_policy": {
"type": "string",
"description": "Return policy",
"maxLength": 60000,
"minLength": 0
},
"shipping_country": {
"type": "string",
"description": "Shipping country ISO 3166-1 code of the address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"shop_additional_fields": {
"type": "array",
"description": "Shop additional fields",
"items": {
"$ref": "#/components/schemas/S06_Request_Shops_ShopAdditionalFields"
}
},
"shop_name": {
"type": "string",
"description": "The name of the shop",
"maxLength": 255
},
"suspend": {
"type": "boolean",
"description": "Whether or not the shop should be created in 'SUSPENDED' state (will be created in 'OPEN' state if false). Default is false."
},
"tier": {
"type": "string",
"description": "The code of the tier of the shop"
},
"web_site": {
"type": "string",
"description": "Website of the shop",
"maxLength": 255
}
},
"required": [
"address",
"email",
"shop_name"
]
},
"S06_Request_Shops_Address": {
"type": "object",
"description": "Shop address",
"properties": {
"city": {
"type": "string",
"description": "City of the contact",
"maxLength": 255
},
"civility": {
"type": "string",
"description": "Civility of the contact (Mr, Mrs, Miss or Neutral)",
"maxLength": 20
},
"country": {
"type": "string",
"description": "Country ISO 3166-1 code of the address, used by Mirakl to format the address (back office, delivery bill, invoices...) and to adapt the address validation to the country (see zip_code field)",
"maxLength": 255
},
"firstname": {
"type": "string",
"description": "First name of the contact",
"maxLength": 255
},
"lastname": {
"type": "string",
"description": "Last name of the contact",
"maxLength": 255
},
"phone": {
"type": "string",
"description": "Phone",
"maxLength": 50
},
"phone_secondary": {
"type": "string",
"description": "Secondary phone",
"maxLength": 50
},
"state": {
"type": "string",
"description": "State (address) of the contact"
},
"street1": {
"type": "string",
"description": "First line of the address of the contact",
"maxLength": 255
},
"street2": {
"type": "string",
"description": "Second line of the address of the contact"
},
"zip_code": {
"type": "string",
"description": "Zip code of the address, mandatory (unless the country_iso_code corresponds to Chile, Peru, Hong-Kong, Qatar, Bahrain, Saudi Arabia, Oman, Kuwait, Egypt or United Arab Emirates)",
"maxLength": 255
}
},
"required": [
"city",
"civility",
"country",
"firstname",
"lastname",
"street1"
]
},
"S06_Request_Shops_Assignees": {
"type": "object",
"description": "List of shop assignees",
"properties": {
"email": {
"type": "string",
"description": "The email of the operator user assigned to shop"
},
"role": {
"type": "string",
"description": "The role assigned to the operator user\n\nEnum: `\"ACCOUNT_MANAGER\"`, `\"BUSINESS_DEVELOPER\"`, `\"ONBOARDING_MANAGER\"`, `\"CATALOG_MANAGER\"`, `\"FINANCE_OPERATIVE\"`, `\"QUALITY_MANAGER\"`, `\"SUPPORT_SPECIALIST\"`\n"
}
},
"required": [
"email",
"role"
]
},
"S06_Request_Shops_ExistingUser": {
"type": "object",
"description": "Existing user to link to the shop. Remove this field from the API request if new_user is specified.",
"properties": {
"email": {
"type": "string",
"description": "User email",
"maxLength": 255
},
"password": {
"type": "string",
"deprecated": true,
"description": "The user password for authentication. This value is required when called with role FRONT, and ignored when called with role OPERATOR.
The password will now be ignored for security reasons.
", "maxLength": 255, "minLength": 8 } }, "required": [ "email" ] }, "S06_Request_Shops_NewUser": { "type": "object", "description": "User to create and to link to the shop. Remove this field from the API request ifexisting_user is specified.",
"properties": {
"email": {
"type": "string",
"description": "User email",
"maxLength": 255
},
"locale": {
"type": "string",
"description": "The user locale for the new user. If not set, default platform locale will be used for the new user",
"maxLength": 255
},
"password": {
"type": "string",
"deprecated": true,
"description": "The user password for the new user. This value is required when called with role FRONT, and ignored when called with role OPERATOR.
The password will now be ignored for security reasons.
", "maxLength": 255, "minLength": 8 } }, "required": [ "email", "password" ] }, "S06_Request_Shops_PaymentInfo": { "type": "object", "description": "Payment information", "discriminator": { "mapping": { "ABA": "#/components/schemas/S06_Request_Shops_PaymentInfo_Aba", "AUBSB": "#/components/schemas/S06_Request_Shops_PaymentInfo_Aubsb", "BRAZILIAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Brazilian", "CANADIAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Canadian", "COLOMBIAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Colombian", "GUATEMALAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Guatemalan", "HK": "#/components/schemas/S06_Request_Shops_PaymentInfo_Hk", "IBAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Iban", "INDIAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Indian", "ISRAELI": "#/components/schemas/S06_Request_Shops_PaymentInfo_Israeli", "JAPANESE": "#/components/schemas/S06_Request_Shops_PaymentInfo_Japanese", "MEXICAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Mexican", "NUBAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Nuban", "NZBSB": "#/components/schemas/S06_Request_Shops_PaymentInfo_Nzbsb", "PAYOUT": "#/components/schemas/S06_Request_Shops_PaymentInfo_Payout", "PHILIPPINES": "#/components/schemas/S06_Request_Shops_PaymentInfo_Philippines", "SERBIAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Serbian", "SG": "#/components/schemas/S06_Request_Shops_PaymentInfo_Sg", "TAIWANESE": "#/components/schemas/S06_Request_Shops_PaymentInfo_Taiwanese", "THAI": "#/components/schemas/S06_Request_Shops_PaymentInfo_Thai", "UK": "#/components/schemas/S06_Request_Shops_PaymentInfo_Uk", "URUGUAYAN": "#/components/schemas/S06_Request_Shops_PaymentInfo_Uruguayan", "VIETNAMESE": "#/components/schemas/S06_Request_Shops_PaymentInfo_Vietnamese" }, "propertyName": "@type" }, "properties": { "@type": { "type": "string", "description": "Enum: `\"IBAN\"`, `\"NUBAN\"`, `\"AUBSB\"`, `\"NZBSB\"`, `\"ABA\"`, `\"HK\"`, `\"CANADIAN\"`, `\"MEXICAN\"`, `\"JAPANESE\"`, `\"BRAZILIAN\"`, `\"TAIWANESE\"`, `\"THAI\"`, `\"INDIAN\"`, `\"UK\"`, `\"URUGUAYAN\"`, `\"COLOMBIAN\"`, `\"GUATEMALAN\"`, `\"SG\"`, `\"ISRAELI\"`, `\"VIETNAMESE\"`, `\"SERBIAN\"`, `\"PHILIPPINES\"`, `\"PAYOUT\"`\n" }, "owner": { "type": "string", "description": "Name of the owner of the payment information", "maxLength": 100, "minLength": 1 } }, "required": [ "owner" ] }, "S06_Request_Shops_PaymentInfo_Aba": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Request_Shops_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 17, "minLength": 3, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_name": { "type": "string", "description": "Bank name", "maxLength": 255, "minLength": 0 }, "bank_street": { "type": "string", "description": "Bank street name", "maxLength": 100, "minLength": 3 }, "bank_zip": { "type": "string", "description": "Bank zip code", "maxLength": 255, "minLength": 0 }, "bic": { "type": "string", "description": "Bank account BIC code (aka Swift Code)" }, "routing_number": { "type": "string", "description": "Routing Number of the bank, (aka ABA code)", "pattern": "[0-9]+" } }, "required": [ "bank_account_number", "bank_name", "routing_number" ] }, "S06_Request_Shops_PaymentInfo_Aubsb": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Request_Shops_PaymentInfo" } ], "properties": { "auban": { "type": "string", "description": "Bank account number", "maxLength": 10, "minLength": 6, "pattern": "[0-9]+" }, "aubsb": { "type": "string", "description": "Bank state branch code", "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_name": { "type": "string", "description": "Bank name", "maxLength": 255, "minLength": 0 }, "bank_street": { "type": "string", "description": "Bank street name", "maxLength": 100, "minLength": 3 }, "bank_zip": { "type": "string", "description": "Bank zip code", "maxLength": 255, "minLength": 0 } }, "required": [ "auban", "aubsb", "bank_name" ] }, "S06_Request_Shops_PaymentInfo_Brazilian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Request_Shops_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 11, "minLength": 10, "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account typeC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Current accountP : Savings accountC : Checking accountP : Savings accountBanking information
Use “payment_info” attribute instead
" }, "channels": { "type": "array", "description": "List of the channel codes associated to the shop", "items": { "type": "string" }, "uniqueItems": true }, "closed_from": { "type": "string", "format": "date-time", "description": "The start date of the closing of the shop" }, "closed_to": { "type": "string", "format": "date-time", "description": "The end date of the closing of the shop" }, "contact_informations": { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ContactInformations", "description": "Contact information" }, "currency_iso_code": { "type": "string", "description": "The currency of the shop (iso format)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "date_created": { "type": "string", "format": "date-time", "description": "Creation date of the shop" }, "default_billing_information": { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation", "description": "The default billing information of the shop, used for invoicing and reporting purposes" }, "description": { "type": "string", "description": "The description of the shop, max length: 3000 characters." }, "domains": { "type": "array", "description": "Shop domains", "items": { "type": "string", "description": "Enum: `\"PRODUCT\"`, `\"SERVICE\"`\n" }, "uniqueItems": true }, "evaluations_count": { "type": "integer", "format": "int64", "description": "Number of evaluations for the shop" }, "free_shipping": { "type": "boolean", "description": "Whether or not this shop offers free shipping to customers" }, "grade": { "type": "number", "format": "with decimals", "description": "Global grade of the shop" }, "immunity_date": { "type": "string", "format": "date-time", "description": "Date until when the shop is immunized against suspension" }, "is_professional": { "type": "boolean", "description": "Whether or not the shop is professional" }, "kyc": { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Kyc", "description": "KYC information (only supported when KYC feature is enabled)" }, "last_updated_date": { "type": "string", "format": "date-time", "description": "The date of the last modification of the shop.\nNote: The following statistics fields do not update thelast_updated date:\norders_countoffers_countevaluations_countgradeapproval_rateapproval_delayorder_messages_response_delayMARKETPLACEDROPSHIPONE_CREDITORProfessional details
Use \"default_billing_information\" instead
" }, "producer_identifiers": { "type": "array", "description": "List of shop’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection related to circular economy regulations is enabled.", "items": { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ProducerIdentifiers" }, "uniqueItems": true }, "recycling_policy": { "type": "string", "description": "Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.", "maxLength": 5000 }, "return_policy": { "type": "string", "description": "Terms of restitution, max length: 60000 characters." }, "shipping": { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shipping", "description": "Shop shipping configuration" }, "shipping_country": { "type": "string", "description": "Code ISO 3166-1 alpha-3 of the shipping country" }, "shipping_types": { "type": "array", "deprecated": true, "description": "List of shipping types of the shop
Use “shippings” attributes instead
", "items": { "type": "string", "deprecated": true } }, "shipping_zones": { "type": "array", "deprecated": true, "description": "List of shipping zones of the shop
Use “shippings” attributes instead
", "items": { "type": "string", "deprecated": true } }, "shippings": { "type": "array", "description": "All the pair shipping zone / shipping type accepted by the shop", "items": { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings" } }, "shop_additional_fields": { "type": "array", "description": "List of additional fields", "items": { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } }, "shop_id": { "type": "integer", "format": "int64", "description": "The identifier of the shop" }, "shop_name": { "type": "string", "description": "The name of the shop" }, "shop_state": { "type": "string", "description": "The state of the shop\n\nEnum: `\"OPEN\"`, `\"CLOSE\"`, `\"SUSPENDED\"`, `\"TERMINATED\"`\n" }, "specific_billing_informations": { "type": "array", "description": "The list of specific billing information of the shop, used for invoicing and reporting purposes\nprofessional\n",
"items": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations"
}
},
"suspension_type": {
"type": "string",
"description": "Shop suspension type, current possible values:MANUAL: Shop account has been manually suspended in the back-officePENDING_APPROVAL: Shop account has been suspended at creationAUTOMATIC_SUSPENSION: Shop account has been suspended by Mirakl Quality ControlINCOMPLETE_PROFILE: Shop account is suspended because some mandatory fields are missing in its profileprofessional\n"
},
"default_language": {
"type": "string",
"description": "The default language of the shop, for invoicing purposes"
},
"fiscal_information": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_FiscalInformation",
"description": "The fiscal information of the shop.\nprofessional\n"
},
"fiscal_representative": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_FiscalRepresentative",
"description": "The fiscal representative associated to the billing information.\nprofessional\n"
},
"id": {
"type": "string",
"description": "The unique identifier of the default billing information."
},
"personal_information": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_PersonalInformation",
"description": "The personal information of the shop owner.\nnon professional or professional sole trader\n"
},
"registration_address": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_RegistrationAddress",
"description": "The complete registration address of the shop."
}
},
"required": [
"default_language",
"id",
"registration_address"
]
},
"S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_CorporateInformation": {
"type": "object",
"properties": {
"company_registration_name": {
"type": "string",
"description": "The name of the shop company, as registered in the business registry of the shop country"
},
"company_registration_number": {
"type": "string",
"description": "The unique code used to identify the shop company and verify its legal existence as an incorporated entity"
},
"complementary_information": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_CorporateInformation_ComplementaryInformation",
"description": "The complementary information of the shop, as requested by local regulations."
},
"electronic_address": {
"type": "string",
"description": "The electronic address (e-invoicing routing code) of the billing entity, used for e-invoice routing and transmission"
},
"phone_number": {
"type": "string",
"description": "The phone number of the billing entity, used for e-invoicing purposes"
}
}
},
"S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_CorporateInformation_ComplementaryInformation": {
"type": "object",
"properties": {
"business_activity_code": {
"type": "string",
"description": "The business activity code of the company, known as APE code in France.\nEU, and the seller is registered in France.\n"
},
"company_registration_city": {
"type": "string",
"description": "The city of the company's registry office.\nEU and the seller is registered in France or Luxembourg.\n"
},
"company_registration_province": {
"type": "string",
"description": "The initials of the company’s registry office province. Known as Ufficio in Italy.\nEU and the seller is registered in Italy.\n"
},
"company_shareholders": {
"type": "string",
"description": "Indicates if there is a single shareholder or several shareholders. Known as Socio Unico in Italy.\nEU and the seller is registered in Italy.\n\n\nEnum: `\"SINGLE\"`, `\"SEVERAL\"`\n"
},
"is_in_liquidation": {
"type": "boolean",
"description": "Indicates whether the company is in liquidation or not.\nEU\n"
},
"legal_form": {
"type": "string",
"description": "The legal form of the company.\nEU\n"
},
"share_capital": {
"type": "number",
"format": "with decimals",
"description": "The share capital of the company.\nEU\n"
},
"share_capital_currency": {
"type": "string",
"description": "The share capital currency of the company.\nEU\n\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n"
},
"sole_trader": {
"type": "boolean",
"description": "Defines if the shop is a sole trader. When this option is set to true, additional information is asked to the shop. Applies only when the operator is registered in the EU"
}
}
},
"S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_FiscalInformation": {
"type": "object",
"properties": {
"local_tax_number": {
"type": "string",
"description": "The VAT or GST number of the shop"
},
"tax_identification_country": {
"type": "string",
"description": "The country of issuance of the tax identification number\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"tax_identification_number": {
"type": "string",
"description": "The identifying number issued by the tax administration of the shop country"
}
}
},
"S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_FiscalRepresentative": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the fiscal representative is located."
},
"civility": {
"type": "string",
"description": "Civility of the fiscal representative"
},
"company_registration_name": {
"type": "string",
"description": "The name of the fiscal representative, as registered if the business registry of the fiscal representative's country"
},
"company_registration_number": {
"type": "string",
"description": "The unique code used to identify the fiscal representative and verify its legal existence as an incorporated entity"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO 3166-1 code of the fiscal representative address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"first_name": {
"type": "string",
"description": "First name of the fiscal representative"
},
"last_name": {
"type": "string",
"description": "Last name of the fiscal representative"
},
"local_tax_number": {
"type": "string",
"description": "The identifying number of the fiscal representative for VAT or GST purposes"
},
"state": {
"type": "string",
"description": "The state/province/region where the fiscal representative is located."
},
"street_1": {
"type": "string",
"description": "The first line of address of the fiscal representative"
},
"street_2": {
"type": "string",
"description": "The second line of address of the fiscal representative"
},
"zip_code": {
"type": "string",
"description": "The Zip/Postal code corresponding to the fiscal representative location"
}
},
"required": [
"city",
"civility",
"company_registration_name",
"company_registration_number",
"country_iso_code",
"first_name",
"last_name",
"street_1"
]
},
"S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_PersonalInformation": {
"type": "object",
"properties": {
"birth_city": {
"type": "string",
"description": "The city of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_country": {
"type": "string",
"description": "The country of birth of the shop owner.\nnon professional or professional sole trader.\n\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"birth_date": {
"type": "string",
"format": "date",
"description": "The birth date of the shop owner.\nnon professional or professional sole trader.\n"
},
"civility": {
"type": "string",
"description": "The civility of the shop owner.\nnon professional or professional sole trader.\n"
},
"first_name": {
"type": "string",
"description": "The first name of the shop owner.\nnon professional or professional sole trader.\n"
},
"last_name": {
"type": "string",
"description": "The last name of the shop owner.\nnon professional or professional sole trader.\n"
}
}
},
"S06_Response_200_ShopReturns_ShopCreated_DefaultBillingInformation_RegistrationAddress": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the shop company is located."
},
"country_iso_code": {
"type": "string",
"description": "Country ISO 3166-1 code of the shop company address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"state": {
"type": "string",
"description": "The state/province/region where the shop company is located."
},
"street_1": {
"type": "string",
"description": "The first line of the address of the shop company"
},
"street_2": {
"type": "string",
"description": "The second line of the address of the shop company"
},
"zip_code": {
"type": "string",
"description": "The Zip/Postal code corresponding to the shop company location"
}
},
"required": [
"city",
"country_iso_code",
"street_1"
]
},
"S06_Response_200_ShopReturns_ShopCreated_Kyc": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "KYC refusal reason"
},
"status": {
"type": "string",
"description": "KYC status\n\nEnum: `\"PENDING_SUBMISSION\"`, `\"PENDING_APPROVAL\"`, `\"REFUSED\"`, `\"APPROVED\"`, `\"NOT_REQUIRED\"`\n"
}
},
"required": [
"status"
]
},
"S06_Response_200_ShopReturns_ShopCreated_PaymentDetails": {
"type": "object",
"properties": {
"paid_balance": {
"type": "number",
"format": "with decimals",
"description": "Paid balance"
},
"pay_subscription": {
"type": "boolean",
"description": "Is the subscription to the marketplace charged to the shop"
},
"payable_balance": {
"type": "number",
"format": "with decimals",
"description": "Payable balance"
},
"payment_blocked": {
"type": "boolean",
"description": "Is the payment blocked by the operator"
},
"pending_balance": {
"type": "number",
"format": "with decimals",
"description": "Pending balance"
},
"reserve_balance": {
"type": "number",
"format": "with decimals",
"description": "Current reserve balance"
},
"reserve_target": {
"type": "number",
"format": "with decimals",
"description": "Configured reserve target"
},
"sub_balances": {
"type": "array",
"description": "Store sub-balances by pay-out PSP. Requires the feature Hybrid pay-out PSP to be enabled on the platform",
"items": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentDetails_SubBalances"
}
},
"subscription_free_from": {
"type": "string",
"format": "date-time",
"description": "Subscription is free from this date"
},
"subscription_free_to": {
"type": "string",
"format": "date-time",
"description": "Subscription is free until this date"
}
},
"required": [
"paid_balance",
"pay_subscription",
"payable_balance",
"payment_blocked",
"pending_balance"
]
},
"S06_Response_200_ShopReturns_ShopCreated_PaymentDetails_SubBalances": {
"type": "object",
"properties": {
"paid": {
"type": "number",
"format": "with decimals",
"description": "Paid balance"
},
"pay_out_psp_code": {
"type": "string",
"description": "Code of the Payment Service Provider (PSP)\n\nEnum: `\"NOT_SPECIFIED\"`, `\"MANGOPAY\"`, `\"MIRAKL_PAYOUT\"`, `\"OPERATOR\"`\n"
},
"payable": {
"type": "number",
"format": "with decimals",
"description": "Payable balance"
},
"pending": {
"type": "number",
"format": "with decimals",
"description": "Pending balance"
}
},
"required": [
"paid",
"pay_out_psp_code",
"payable",
"pending"
]
},
"S06_Response_200_ShopReturns_ShopCreated_PaymentInfo": {
"type": "object",
"discriminator": {
"mapping": {
"ABA": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Aba",
"AUBSB": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Aubsb",
"BRAZILIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Brazilian",
"CANADIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Canadian",
"COLOMBIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Colombian",
"GUATEMALAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Guatemalan",
"HK": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Hk",
"IBAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Iban",
"INDIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Indian",
"ISRAELI": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Israeli",
"JAPANESE": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Japanese",
"MEXICAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Mexican",
"NUBAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Nuban",
"NZBSB": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Nzbsb",
"PAYOUT": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Payout",
"PHILIPPINES": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Philippines",
"SERBIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Serbian",
"SG": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Sg",
"TAIWANESE": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Taiwanese",
"THAI": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Thai",
"UK": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Uk",
"URUGUAYAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Uruguayan",
"VIETNAMESE": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Vietnamese"
},
"propertyName": "@type"
},
"properties": {
"@type": {
"type": "string",
"description": "Enum: `\"IBAN\"`, `\"NUBAN\"`, `\"AUBSB\"`, `\"NZBSB\"`, `\"ABA\"`, `\"HK\"`, `\"CANADIAN\"`, `\"MEXICAN\"`, `\"JAPANESE\"`, `\"BRAZILIAN\"`, `\"TAIWANESE\"`, `\"THAI\"`, `\"INDIAN\"`, `\"UK\"`, `\"URUGUAYAN\"`, `\"COLOMBIAN\"`, `\"GUATEMALAN\"`, `\"SG\"`, `\"ISRAELI\"`, `\"VIETNAMESE\"`, `\"SERBIAN\"`, `\"PHILIPPINES\"`, `\"PAYOUT\"`\n"
},
"owner": {
"type": "string",
"description": "Name of the owner of the payment information",
"maxLength": 100,
"minLength": 1
}
},
"required": [
"owner"
]
},
"S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Aba": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo"
}
],
"properties": {
"bank_account_number": {
"type": "string",
"description": "Bank Account Number",
"maxLength": 17,
"minLength": 3,
"pattern": "[0-9]+"
},
"bank_city": {
"type": "string",
"description": "Bank city",
"maxLength": 100,
"minLength": 3
},
"bank_name": {
"type": "string",
"description": "Bank name",
"maxLength": 255,
"minLength": 0
},
"bank_street": {
"type": "string",
"description": "Bank street name",
"maxLength": 100,
"minLength": 3
},
"bank_zip": {
"type": "string",
"description": "Bank zip code",
"maxLength": 255,
"minLength": 0
},
"bic": {
"type": "string",
"description": "Bank account BIC code (aka Swift Code)"
},
"routing_number": {
"type": "string",
"description": "Routing Number of the bank, (aka ABA code)",
"pattern": "[0-9]+"
}
},
"required": [
"bank_account_number",
"bank_name",
"routing_number"
]
},
"S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Aubsb": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo"
}
],
"properties": {
"auban": {
"type": "string",
"description": "Bank account number",
"maxLength": 10,
"minLength": 6,
"pattern": "[0-9]+"
},
"aubsb": {
"type": "string",
"description": "Bank state branch code",
"pattern": "[0-9]+"
},
"bank_city": {
"type": "string",
"description": "Bank city",
"maxLength": 100,
"minLength": 3
},
"bank_name": {
"type": "string",
"description": "Bank name",
"maxLength": 255,
"minLength": 0
},
"bank_street": {
"type": "string",
"description": "Bank street name",
"maxLength": 100,
"minLength": 3
},
"bank_zip": {
"type": "string",
"description": "Bank zip code",
"maxLength": 255,
"minLength": 0
}
},
"required": [
"auban",
"aubsb",
"bank_name"
]
},
"S06_Response_200_ShopReturns_ShopCreated_PaymentInfo_Brazilian": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_PaymentInfo"
}
],
"properties": {
"account_number": {
"type": "string",
"description": "Account number",
"maxLength": 11,
"minLength": 10,
"pattern": "[0-9]+"
},
"bank_account_type": {
"type": "string",
"description": "Account typeC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Current accountP : Savings accountC : Checking accountP : Savings accountVAT Number (for taxes)
Use tax_identification_number instead
" }, "corporate_name": { "type": "string", "deprecated": true, "description": "Corporate name
Use \"default_billing_information.company_registration_name\" attribute instead
" }, "identification_number": { "type": "string", "deprecated": true, "description": "Identification number of the shop. For France it would be the SIRET
Use \"default_billing_information.company_registration_number\" attribute instead
" }, "tax_identification_number": { "type": "string", "deprecated": true, "description": "Tax identification number
Use \"default_billing_information.tax_identification_number\" attribute instead if the operator's tax number country is one of the following: Caribbean Netherlands, Cuba, Curaçao, Djibouti, Eritrea, Guam, South Korea, Liberia, Malaysia, Myanmar,PuertoRico, Solomon Islands, Somalia, South Sudan, Timor-Leste, Tuvalu, United States, or Yemen. Use \"default_billing_information.local_tax_number\" attribute instead otherwise
" } } }, "S06_Response_200_ShopReturns_ShopCreated_ProducerIdentifiers": { "type": "object", "properties": { "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\nEnum: `\"FR-AGROPACK\"`, `\"FR-ASL\"`, `\"FR-DASRIPAT\"`, `\"FR-DBPS\"`, `\"FR-DDS\"`, `\"FR-DEA\"`, `\"FR-DEEE\"`, `\"FR-DISPMED\"`, `\"FR-DIY\"`, `\"FR-EMBM\"`, `\"FR-GF\"`, `\"FR-JOUETS\"`, `\"FR-LUB\"`, `\"FR-MH\"`, `\"FR-MNU\"`, `\"FR-PA\"`, `\"FR-PAP\"`, `\"FR-PCHIM\"`, `\"FR-PMCB\"`, `\"FR-PNEU\"`, `\"FR-TABAC\"`, `\"FR-TLC\"`, `\"FR-VEHICULE\"`, `\"FR-VHU\"`, `\"DE-BATTG\"`, `\"DE-PACK\"`, `\"DE-WEEE\"`, `\"ES-PACK\"`, `\"ES-GPACK\"`, `\"ES-WEEE\"`\n", "maxLength": 255, "minLength": 0 }, "producer_id": { "type": "string", "description": "Shop producer identifier.", "maxLength": 255, "minLength": 0 } }, "required": [ "epr_category_code", "producer_id" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shipping": { "type": "object", "properties": { "lead_time_to_ship": { "type": "integer", "format": "int32", "description": "Default lead time to ship of the shop" } } }, "S06_Response_200_ShopReturns_ShopCreated_Shippings": { "type": "object", "properties": { "additional_fields": { "type": "array", "description": "List of custom shipping fields for this shipping zone and shipping method", "items": { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } }, "shipping_free_amount": { "type": "number", "format": "with decimals", "description": "Minimal amount for free shipping" }, "shipping_type_code": { "type": "string", "description": "The code of the shipping type" }, "shipping_type_label": { "type": "string", "description": "The label of the shipping type" }, "shipping_type_standard_code": { "type": "string", "description": "The code of the standard shipping type" }, "shipping_zone_code": { "type": "string", "description": "The code of the shipping zone" }, "shipping_zone_label": { "type": "string", "description": "The label of the shipping zone" } }, "required": [ "shipping_type_code", "shipping_type_label", "shipping_zone_code", "shipping_zone_label" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Boolean", "DATE": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Date", "LINK": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Link", "LIST": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Numeric", "REGEX": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Regex", "STRING": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_String", "TEXTAREA": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_Shippings_AdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Boolean", "DATE": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Date", "LINK": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Link", "LIST": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Numeric", "REGEX": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Regex", "STRING": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_String", "TEXTAREA": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_ShopAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations": { "type": "object", "properties": { "corporate_information": { "$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_CorporateInformation", "description": "The corporate information of the shop.\nprofessional\n"
},
"fiscal_information": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_FiscalInformation",
"description": "The fiscal information of the shop.\nprofessional\n"
},
"fiscal_representative": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_FiscalRepresentative",
"description": "The fiscal representative associated to the billing information.\nprofessional\n"
},
"id": {
"type": "string",
"description": "The unique identifier of the specific billing information."
},
"personal_information": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_PersonalInformation",
"description": "The personal information of the shop owner.\nnon professional or professional sole trader\n"
},
"registration_address": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_RegistrationAddress",
"description": "The complete registration address of the shop."
}
},
"required": [
"id",
"registration_address"
]
},
"S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_CorporateInformation": {
"type": "object",
"properties": {
"company_registration_name": {
"type": "string",
"description": "The name of the shop company, as registered in the business registry of the shop country"
},
"company_registration_number": {
"type": "string",
"description": "The unique code used to identify the shop company and verify its legal existence as an incorporated entity"
},
"complementary_information": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_CorporateInformation_ComplementaryInformation",
"description": "The complementary information of the shop, as requested by local regulations."
},
"electronic_address": {
"type": "string",
"description": "The electronic address (e-invoicing routing code) of the billing entity, used for e-invoice routing and transmission"
},
"phone_number": {
"type": "string",
"description": "The phone number of the billing entity, used for e-invoicing purposes"
}
}
},
"S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_CorporateInformation_ComplementaryInformation": {
"type": "object",
"properties": {
"business_activity_code": {
"type": "string",
"description": "The business activity code of the company, known as APE code in France.\nEU, and the seller is registered in France.\n"
},
"company_registration_city": {
"type": "string",
"description": "The city of the company's registry office.\nEU and the seller is registered in France or Luxembourg.\n"
},
"company_registration_province": {
"type": "string",
"description": "The initials of the company’s registry office province. Known as Ufficio in Italy.\nEU and the seller is registered in Italy.\n"
},
"company_shareholders": {
"type": "string",
"description": "Indicates if there is a single shareholder or several shareholders. Known as Socio Unico in Italy.\nEU and the seller is registered in Italy.\n\n\nEnum: `\"SINGLE\"`, `\"SEVERAL\"`\n"
},
"is_in_liquidation": {
"type": "boolean",
"description": "Indicates whether the company is in liquidation or not.\nEU\n"
},
"legal_form": {
"type": "string",
"description": "The legal form of the company.\nEU\n"
},
"share_capital": {
"type": "number",
"format": "with decimals",
"description": "The share capital of the company.\nEU\n"
},
"share_capital_currency": {
"type": "string",
"description": "The share capital currency of the company.\nEU\n\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n"
},
"sole_trader": {
"type": "boolean",
"description": "Defines if the shop is a sole trader. When this option is set to true, additional information is asked to the shop. Applies only when the operator is registered in the EU"
}
}
},
"S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_FiscalInformation": {
"type": "object",
"properties": {
"local_tax_number": {
"type": "string",
"description": "The VAT or GST number of the shop"
},
"tax_identification_country": {
"type": "string",
"description": "The country of issuance of the tax identification number\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"tax_identification_number": {
"type": "string",
"description": "The identifying number issued by the tax administration of the shop country"
}
}
},
"S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_FiscalRepresentative": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the fiscal representative is located."
},
"civility": {
"type": "string",
"description": "Civility of the fiscal representative"
},
"company_registration_name": {
"type": "string",
"description": "The name of the fiscal representative, as registered if the business registry of the fiscal representative's country"
},
"company_registration_number": {
"type": "string",
"description": "The unique code used to identify the fiscal representative and verify its legal existence as an incorporated entity"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO 3166-1 code of the fiscal representative address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"first_name": {
"type": "string",
"description": "First name of the fiscal representative"
},
"last_name": {
"type": "string",
"description": "Last name of the fiscal representative"
},
"local_tax_number": {
"type": "string",
"description": "The identifying number of the fiscal representative for VAT or GST purposes"
},
"state": {
"type": "string",
"description": "The state/province/region where the fiscal representative is located."
},
"street_1": {
"type": "string",
"description": "The first line of address of the fiscal representative"
},
"street_2": {
"type": "string",
"description": "The second line of address of the fiscal representative"
},
"zip_code": {
"type": "string",
"description": "The Zip/Postal code corresponding to the fiscal representative location"
}
},
"required": [
"city",
"civility",
"company_registration_name",
"company_registration_number",
"country_iso_code",
"first_name",
"last_name",
"street_1"
]
},
"S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_PersonalInformation": {
"type": "object",
"properties": {
"birth_city": {
"type": "string",
"description": "The city of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_country": {
"type": "string",
"description": "The country of birth of the shop owner.\nnon professional or professional sole trader.\n\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"birth_date": {
"type": "string",
"format": "date",
"description": "The birth date of the shop owner.\nnon professional or professional sole trader.\n"
},
"civility": {
"type": "string",
"description": "The civility of the shop owner.\nnon professional or professional sole trader.\n"
},
"first_name": {
"type": "string",
"description": "The first name of the shop owner.\nnon professional or professional sole trader.\n"
},
"last_name": {
"type": "string",
"description": "The last name of the shop owner.\nnon professional or professional sole trader.\n"
}
}
},
"S06_Response_200_ShopReturns_ShopCreated_SpecificBillingInformations_RegistrationAddress": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the shop company is located."
},
"country_iso_code": {
"type": "string",
"description": "Country ISO 3166-1 code of the shop company address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"state": {
"type": "string",
"description": "The state/province/region where the shop company is located."
},
"street_1": {
"type": "string",
"description": "The first line of the address of the shop company"
},
"street_2": {
"type": "string",
"description": "The second line of the address of the shop company"
},
"zip_code": {
"type": "string",
"description": "The Zip/Postal code corresponding to the shop company location"
}
},
"required": [
"city",
"country_iso_code",
"street_1"
]
},
"S06_Response_200_ShopReturns_ShopError": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "Errors about the input object",
"items": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Errors"
},
"uniqueItems": true
},
"input": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input",
"description": "Invalid shop that was received from caller."
}
},
"required": [
"errors"
]
},
"S06_Response_200_ShopReturns_ShopError_Errors": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"field": {
"type": "string",
"description": "Name of the field on the input object. Can be composed, e.g.: address.zip_code"
},
"message": {
"type": "string",
"description": "Error message"
}
},
"required": [
"code",
"field",
"message"
]
},
"S06_Response_200_ShopReturns_ShopError_Input": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_Address",
"description": "Shop address"
},
"assignees": {
"type": "array",
"description": "List of shop assignees",
"items": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_Assignees"
}
},
"channel_codes": {
"type": "array",
"description": "List of the channel codes associated to the shop",
"items": {
"type": "string",
"maxLength": 36
},
"maxLength": 36
},
"closed_from_date": {
"type": "string",
"format": "date-time",
"description": "Date: if defined, this shop will be closed on this date. Lower or equal to closed_to_date if not null"
},
"closed_to_date": {
"type": "string",
"format": "date-time",
"description": "Date: if defined, this shop will be reopened on this date. Greater or equal to closed_from_date if not null"
},
"currency_iso_code": {
"type": "string",
"description": "Shop currency\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n"
},
"description": {
"type": "string",
"description": "Shop description",
"maxLength": 3000
},
"domains": {
"type": "array",
"description": "Shop Domains",
"items": {
"type": "string",
"description": "Enum: `\"PRODUCT\"`, `\"SERVICE\"`\n"
}
},
"email": {
"type": "string",
"description": "Email",
"maxLength": 255
},
"existing_user": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_ExistingUser"
},
"fax": {
"type": "string",
"description": "Fax",
"maxLength": 20
},
"immunity_date": {
"type": "string",
"format": "date-time",
"description": "Date until the shop is immunized from being suspended by the batch. Must be in the future."
},
"is_professional": {
"type": "boolean",
"description": "Whether or not the shop is professional. Default is false."
},
"model": {
"type": "string",
"description": "Platform model. Required in case of multiple configured models. Should be MARKETPLACE if domain is service.\n\nEnum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n"
},
"new_user": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_NewUser"
},
"operator_internal_id": {
"type": "string",
"description": "Operator internal id for the shop",
"maxLength": 255
},
"password": {
"type": "string",
"deprecated": true,
"description": "",
"maxLength": 255,
"minLength": 8
},
"payment_blocked": {
"type": "boolean",
"description": "Whether or not the shop payment should be suspended. Default is false."
},
"payment_info": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo",
"description": "Payment information"
},
"payment_method_mandatory": {
"type": "boolean",
"description": "Payment method mandatory"
},
"permissions": {
"type": "array",
"description": "List of the shop permissions",
"items": {
"type": "string",
"description": "Enum: `\"PRODUCT_ACCESS\"`, `\"ORDER_ACCESS\"`, `\"OFFER_ACCESS\"`\n"
}
},
"pro_details": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_ProDetails",
"description": "Professional details. Required if shop is declared as professional."
},
"producer_identifiers": {
"type": "array",
"description": "List of shop’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection related to circular economy regulations is enabled.",
"items": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_ProducerIdentifiers"
},
"maxItems": 50,
"minItems": 0
},
"recycling_policy": {
"type": "string",
"description": "Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.",
"maxLength": 5000
},
"return_policy": {
"type": "string",
"description": "Return policy",
"maxLength": 60000,
"minLength": 0
},
"shipping_country": {
"type": "string",
"description": "Shipping country ISO 3166-1 code of the address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"shop_additional_fields": {
"type": "array",
"description": "Shop additional fields",
"items": {
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_ShopAdditionalFields"
}
},
"shop_name": {
"type": "string",
"description": "The name of the shop",
"maxLength": 255
},
"suspend": {
"type": "boolean",
"description": "Whether or not the shop should be created in 'SUSPENDED' state (will be created in 'OPEN' state if false). Default is false."
},
"tier": {
"type": "string",
"description": "The code of the tier of the shop"
},
"web_site": {
"type": "string",
"description": "Website of the shop",
"maxLength": 255
}
},
"required": [
"address",
"email",
"shop_name"
]
},
"S06_Response_200_ShopReturns_ShopError_Input_Address": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City of the contact",
"maxLength": 255
},
"civility": {
"type": "string",
"description": "Civility of the contact (Mr, Mrs, Miss or Neutral)",
"maxLength": 20
},
"country": {
"type": "string",
"description": "Country ISO 3166-1 code of the address, used by Mirakl to format the address (back office, delivery bill, invoices...) and to adapt the address validation to the country (see zip_code field)",
"maxLength": 255
},
"firstname": {
"type": "string",
"description": "First name of the contact",
"maxLength": 255
},
"lastname": {
"type": "string",
"description": "Last name of the contact",
"maxLength": 255
},
"phone": {
"type": "string",
"description": "Phone",
"maxLength": 50
},
"phone_secondary": {
"type": "string",
"description": "Secondary phone",
"maxLength": 50
},
"state": {
"type": "string",
"description": "State (address) of the contact"
},
"street1": {
"type": "string",
"description": "First line of the address of the contact",
"maxLength": 255
},
"street2": {
"type": "string",
"description": "Second line of the address of the contact"
},
"zip_code": {
"type": "string",
"description": "Zip code of the address, mandatory (unless the country_iso_code corresponds to Chile, Peru, Hong-Kong, Qatar, Bahrain, Saudi Arabia, Oman, Kuwait, Egypt or United Arab Emirates)",
"maxLength": 255
}
},
"required": [
"city",
"civility",
"country",
"firstname",
"lastname",
"street1"
]
},
"S06_Response_200_ShopReturns_ShopError_Input_Assignees": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the operator user assigned to shop"
},
"role": {
"type": "string",
"description": "The role assigned to the operator user\n\nEnum: `\"ACCOUNT_MANAGER\"`, `\"BUSINESS_DEVELOPER\"`, `\"ONBOARDING_MANAGER\"`, `\"CATALOG_MANAGER\"`, `\"FINANCE_OPERATIVE\"`, `\"QUALITY_MANAGER\"`, `\"SUPPORT_SPECIALIST\"`\n"
}
},
"required": [
"email",
"role"
]
},
"S06_Response_200_ShopReturns_ShopError_Input_ExistingUser": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "User email",
"maxLength": 255
}
},
"required": [
"email"
]
},
"S06_Response_200_ShopReturns_ShopError_Input_NewUser": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "User email",
"maxLength": 255
},
"locale": {
"type": "string",
"description": "The user locale for the new user. If not set, default platform locale will be used for the new user",
"maxLength": 255
}
},
"required": [
"email"
]
},
"S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo": {
"type": "object",
"discriminator": {
"mapping": {
"ABA": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Aba",
"AUBSB": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Aubsb",
"BRAZILIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Brazilian",
"CANADIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Canadian",
"COLOMBIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Colombian",
"GUATEMALAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Guatemalan",
"HK": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Hk",
"IBAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Iban",
"INDIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Indian",
"ISRAELI": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Israeli",
"JAPANESE": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Japanese",
"MEXICAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Mexican",
"NUBAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Nuban",
"NZBSB": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Nzbsb",
"PAYOUT": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Payout",
"PHILIPPINES": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Philippines",
"SERBIAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Serbian",
"SG": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Sg",
"TAIWANESE": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Taiwanese",
"THAI": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Thai",
"UK": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Uk",
"URUGUAYAN": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Uruguayan",
"VIETNAMESE": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Vietnamese"
},
"propertyName": "@type"
},
"properties": {
"@type": {
"type": "string",
"description": "Enum: `\"IBAN\"`, `\"NUBAN\"`, `\"AUBSB\"`, `\"NZBSB\"`, `\"ABA\"`, `\"HK\"`, `\"CANADIAN\"`, `\"MEXICAN\"`, `\"JAPANESE\"`, `\"BRAZILIAN\"`, `\"TAIWANESE\"`, `\"THAI\"`, `\"INDIAN\"`, `\"UK\"`, `\"URUGUAYAN\"`, `\"COLOMBIAN\"`, `\"GUATEMALAN\"`, `\"SG\"`, `\"ISRAELI\"`, `\"VIETNAMESE\"`, `\"SERBIAN\"`, `\"PHILIPPINES\"`, `\"PAYOUT\"`\n"
},
"owner": {
"type": "string",
"description": "Name of the owner of the payment information",
"maxLength": 100,
"minLength": 1
}
},
"required": [
"owner"
]
},
"S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Aba": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo"
}
],
"properties": {
"bank_account_number": {
"type": "string",
"description": "Bank Account Number",
"maxLength": 17,
"minLength": 3,
"pattern": "[0-9]+"
},
"bank_city": {
"type": "string",
"description": "Bank city",
"maxLength": 100,
"minLength": 3
},
"bank_name": {
"type": "string",
"description": "Bank name",
"maxLength": 255,
"minLength": 0
},
"bank_street": {
"type": "string",
"description": "Bank street name",
"maxLength": 100,
"minLength": 3
},
"bank_zip": {
"type": "string",
"description": "Bank zip code",
"maxLength": 255,
"minLength": 0
},
"bic": {
"type": "string",
"description": "Bank account BIC code (aka Swift Code)"
},
"routing_number": {
"type": "string",
"description": "Routing Number of the bank, (aka ABA code)",
"pattern": "[0-9]+"
}
},
"required": [
"bank_account_number",
"bank_name",
"routing_number"
]
},
"S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Aubsb": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo"
}
],
"properties": {
"auban": {
"type": "string",
"description": "Bank account number",
"maxLength": 10,
"minLength": 6,
"pattern": "[0-9]+"
},
"aubsb": {
"type": "string",
"description": "Bank state branch code",
"pattern": "[0-9]+"
},
"bank_city": {
"type": "string",
"description": "Bank city",
"maxLength": 100,
"minLength": 3
},
"bank_name": {
"type": "string",
"description": "Bank name",
"maxLength": 255,
"minLength": 0
},
"bank_street": {
"type": "string",
"description": "Bank street name",
"maxLength": 100,
"minLength": 3
},
"bank_zip": {
"type": "string",
"description": "Bank zip code",
"maxLength": 255,
"minLength": 0
}
},
"required": [
"auban",
"aubsb",
"bank_name"
]
},
"S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo_Brazilian": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/S06_Response_200_ShopReturns_ShopError_Input_PaymentInfo"
}
],
"properties": {
"account_number": {
"type": "string",
"description": "Account number",
"maxLength": 11,
"minLength": 10,
"pattern": "[0-9]+"
},
"bank_account_type": {
"type": "string",
"description": "Account typeC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Current accountP : Savings accountC : Checking accountP : Savings accountBanking information
Use “payment_info” attribute instead
" }, "channels": { "type": "array", "description": "List of the channel codes associated to the shop", "items": { "type": "string" }, "uniqueItems": true }, "closed_from": { "type": "string", "format": "date-time", "description": "The start date of the closing of the shop" }, "closed_to": { "type": "string", "format": "date-time", "description": "The end date of the closing of the shop" }, "commission": { "$ref": "#/components/schemas/S20_Response_200_Shops_Commission", "description": "The commission grid assigned to the shop. Not applicable to Dropship / Services shops." }, "contact_informations": { "$ref": "#/components/schemas/S20_Response_200_Shops_ContactInformations", "description": "Contact information" }, "currency_iso_code": { "type": "string", "description": "The currency of the shop (iso format)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "date_created": { "type": "string", "format": "date-time", "description": "Creation date of the shop" }, "default_billing_information": { "$ref": "#/components/schemas/S20_Response_200_Shops_DefaultBillingInformation", "description": "The default billing information of the shop, used for invoicing and reporting purposes" }, "description": { "type": "string", "description": "The description of the shop, max length: 3000 characters." }, "domains": { "type": "array", "description": "Shop domains", "items": { "type": "string", "description": "Enum: `\"PRODUCT\"`, `\"SERVICE\"`\n" }, "uniqueItems": true }, "evaluations_count": { "type": "integer", "format": "int64", "description": "Number of evaluations for the shop" }, "free_shipping": { "type": "boolean", "description": "Whether or not this shop offers free shipping to customers" }, "grade": { "type": "number", "format": "with decimals", "description": "Global grade of the shop" }, "immunity_date": { "type": "string", "format": "date-time", "description": "Date until when the shop is immunized against suspension" }, "is_professional": { "type": "boolean", "description": "Whether or not the shop is professional" }, "kyc": { "$ref": "#/components/schemas/S20_Response_200_Shops_Kyc", "description": "KYC information (only supported when KYC feature is enabled)" }, "last_updated_date": { "type": "string", "format": "date-time", "description": "The date of the last modification of the shop.\nNote: The following statistics fields do not update thelast_updated date:\norders_countoffers_countevaluations_countgradeapproval_rateapproval_delayorder_messages_response_delayMARKETPLACEDROPSHIPONE_CREDITORProfessional details
Use \"default_billing_information\" instead
" }, "producer_identifiers": { "type": "array", "description": "List of shop’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection related to circular economy regulations is enabled.", "items": { "$ref": "#/components/schemas/S20_Response_200_Shops_ProducerIdentifiers" }, "uniqueItems": true }, "recycling_policy": { "type": "string", "description": "Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.", "maxLength": 5000 }, "return_policy": { "type": "string", "description": "Terms of restitution, max length: 60000 characters." }, "shipping": { "$ref": "#/components/schemas/S20_Response_200_Shops_Shipping", "description": "Shop shipping configuration" }, "shipping_country": { "type": "string", "description": "Code ISO 3166-1 alpha-3 of the shipping country" }, "shipping_types": { "type": "array", "deprecated": true, "description": "List of shipping types of the shop
Use “shippings” attributes instead
", "items": { "type": "string", "deprecated": true } }, "shipping_zones": { "type": "array", "deprecated": true, "description": "List of shipping zones of the shop
Use “shippings” attributes instead
", "items": { "type": "string", "deprecated": true } }, "shippings": { "type": "array", "description": "All the pair shipping zone / shipping type accepted by the shop", "items": { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings" } }, "shop_additional_fields": { "type": "array", "description": "List of additional fields", "items": { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } }, "shop_id": { "type": "integer", "format": "int64", "description": "The identifier of the shop" }, "shop_name": { "type": "string", "description": "The name of the shop" }, "shop_state": { "type": "string", "description": "The state of the shop\n\nEnum: `\"OPEN\"`, `\"CLOSE\"`, `\"SUSPENDED\"`, `\"TERMINATED\"`\n" }, "specific_billing_informations": { "type": "array", "description": "The list of specific billing information of the shop, used for invoicing and reporting purposes\nprofessional\n",
"items": {
"$ref": "#/components/schemas/S20_Response_200_Shops_SpecificBillingInformations"
}
},
"suspension_type": {
"type": "string",
"description": "Shop suspension type, current possible values:MANUAL: Shop account has been manually suspended in the back-officePENDING_APPROVAL: Shop account has been suspended at creationAUTOMATIC_SUSPENSION: Shop account has been suspended by Mirakl Quality ControlINCOMPLETE_PROFILE: Shop account is suspended because some mandatory fields are missing in its profileprofessional\n"
},
"default_language": {
"type": "string",
"description": "The default language of the shop, for invoicing purposes"
},
"fiscal_information": {
"$ref": "#/components/schemas/S20_Response_200_Shops_DefaultBillingInformation_FiscalInformation",
"description": "The fiscal information of the shop.\nprofessional\n"
},
"fiscal_representative": {
"$ref": "#/components/schemas/S20_Response_200_Shops_DefaultBillingInformation_FiscalRepresentative",
"description": "The fiscal representative associated to the billing information.\nprofessional\n"
},
"id": {
"type": "string",
"description": "The unique identifier of the default billing information."
},
"personal_information": {
"$ref": "#/components/schemas/S20_Response_200_Shops_DefaultBillingInformation_PersonalInformation",
"description": "The personal information of the shop owner.\nnon professional or professional sole trader\n"
},
"registration_address": {
"$ref": "#/components/schemas/S20_Response_200_Shops_DefaultBillingInformation_RegistrationAddress",
"description": "The complete registration address of the shop."
}
},
"required": [
"default_language",
"id",
"registration_address"
]
},
"S20_Response_200_Shops_DefaultBillingInformation_CorporateInformation": {
"type": "object",
"properties": {
"company_registration_name": {
"type": "string",
"description": "The name of the shop company, as registered in the business registry of the shop country"
},
"company_registration_number": {
"type": "string",
"description": "The unique code used to identify the shop company and verify its legal existence as an incorporated entity"
},
"complementary_information": {
"$ref": "#/components/schemas/S20_Response_200_Shops_DefaultBillingInformation_CorporateInformation_ComplementaryInformation",
"description": "The complementary information of the shop, as requested by local regulations."
},
"electronic_address": {
"type": "string",
"description": "The electronic address (e-invoicing routing code) of the billing entity, used for e-invoice routing and transmission"
},
"phone_number": {
"type": "string",
"description": "The phone number of the billing entity, used for e-invoicing purposes"
}
}
},
"S20_Response_200_Shops_DefaultBillingInformation_CorporateInformation_ComplementaryInformation": {
"type": "object",
"properties": {
"business_activity_code": {
"type": "string",
"description": "The business activity code of the company, known as APE code in France.\nEU, and the seller is registered in France.\n"
},
"company_registration_city": {
"type": "string",
"description": "The city of the company's registry office.\nEU and the seller is registered in France or Luxembourg.\n"
},
"company_registration_province": {
"type": "string",
"description": "The initials of the company’s registry office province. Known as Ufficio in Italy.\nEU and the seller is registered in Italy.\n"
},
"company_shareholders": {
"type": "string",
"description": "Indicates if there is a single shareholder or several shareholders. Known as Socio Unico in Italy.\nEU and the seller is registered in Italy.\n\n\nEnum: `\"SINGLE\"`, `\"SEVERAL\"`\n"
},
"is_in_liquidation": {
"type": "boolean",
"description": "Indicates whether the company is in liquidation or not.\nEU\n"
},
"legal_form": {
"type": "string",
"description": "The legal form of the company.\nEU\n"
},
"share_capital": {
"type": "number",
"format": "with decimals",
"description": "The share capital of the company.\nEU\n"
},
"share_capital_currency": {
"type": "string",
"description": "The share capital currency of the company.\nEU\n\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n"
},
"sole_trader": {
"type": "boolean",
"description": "Defines if the shop is a sole trader. When this option is set to true, additional information is asked to the shop. Applies only when the operator is registered in the EU"
}
}
},
"S20_Response_200_Shops_DefaultBillingInformation_FiscalInformation": {
"type": "object",
"properties": {
"local_tax_number": {
"type": "string",
"description": "The VAT or GST number of the shop"
},
"tax_identification_country": {
"type": "string",
"description": "The country of issuance of the tax identification number\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"tax_identification_number": {
"type": "string",
"description": "The identifying number issued by the tax administration of the shop country"
}
}
},
"S20_Response_200_Shops_DefaultBillingInformation_FiscalRepresentative": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the fiscal representative is located."
},
"civility": {
"type": "string",
"description": "Civility of the fiscal representative"
},
"company_registration_name": {
"type": "string",
"description": "The name of the fiscal representative, as registered if the business registry of the fiscal representative's country"
},
"company_registration_number": {
"type": "string",
"description": "The unique code used to identify the fiscal representative and verify its legal existence as an incorporated entity"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO 3166-1 code of the fiscal representative address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"first_name": {
"type": "string",
"description": "First name of the fiscal representative"
},
"last_name": {
"type": "string",
"description": "Last name of the fiscal representative"
},
"local_tax_number": {
"type": "string",
"description": "The identifying number of the fiscal representative for VAT or GST purposes"
},
"state": {
"type": "string",
"description": "The state/province/region where the fiscal representative is located."
},
"street_1": {
"type": "string",
"description": "The first line of address of the fiscal representative"
},
"street_2": {
"type": "string",
"description": "The second line of address of the fiscal representative"
},
"zip_code": {
"type": "string",
"description": "The Zip/Postal code corresponding to the fiscal representative location"
}
},
"required": [
"city",
"civility",
"company_registration_name",
"company_registration_number",
"country_iso_code",
"first_name",
"last_name",
"street_1"
]
},
"S20_Response_200_Shops_DefaultBillingInformation_PersonalInformation": {
"type": "object",
"properties": {
"birth_city": {
"type": "string",
"description": "The city of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_country": {
"type": "string",
"description": "The country of birth of the shop owner.\nnon professional or professional sole trader.\n\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"birth_date": {
"type": "string",
"format": "date",
"description": "The birth date of the shop owner.\nnon professional or professional sole trader.\n"
},
"civility": {
"type": "string",
"description": "The civility of the shop owner.\nnon professional or professional sole trader.\n"
},
"first_name": {
"type": "string",
"description": "The first name of the shop owner.\nnon professional or professional sole trader.\n"
},
"last_name": {
"type": "string",
"description": "The last name of the shop owner.\nnon professional or professional sole trader.\n"
}
}
},
"S20_Response_200_Shops_DefaultBillingInformation_RegistrationAddress": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the shop company is located."
},
"country_iso_code": {
"type": "string",
"description": "Country ISO 3166-1 code of the shop company address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"state": {
"type": "string",
"description": "The state/province/region where the shop company is located."
},
"street_1": {
"type": "string",
"description": "The first line of the address of the shop company"
},
"street_2": {
"type": "string",
"description": "The second line of the address of the shop company"
},
"zip_code": {
"type": "string",
"description": "The Zip/Postal code corresponding to the shop company location"
}
},
"required": [
"city",
"country_iso_code",
"street_1"
]
},
"S20_Response_200_Shops_Kyc": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "KYC refusal reason"
},
"status": {
"type": "string",
"description": "KYC status\n\nEnum: `\"PENDING_SUBMISSION\"`, `\"PENDING_APPROVAL\"`, `\"REFUSED\"`, `\"APPROVED\"`, `\"NOT_REQUIRED\"`\n"
}
},
"required": [
"status"
]
},
"S20_Response_200_Shops_PaymentDetails": {
"type": "object",
"properties": {
"paid_balance": {
"type": "number",
"format": "with decimals",
"description": "Paid balance"
},
"pay_subscription": {
"type": "boolean",
"description": "Is the subscription to the marketplace charged to the shop"
},
"payable_balance": {
"type": "number",
"format": "with decimals",
"description": "Payable balance"
},
"payment_blocked": {
"type": "boolean",
"description": "Is the payment blocked by the operator"
},
"pending_balance": {
"type": "number",
"format": "with decimals",
"description": "Pending balance"
},
"reserve_balance": {
"type": "number",
"format": "with decimals",
"description": "Current reserve balance"
},
"reserve_target": {
"type": "number",
"format": "with decimals",
"description": "Configured reserve target"
},
"sub_balances": {
"type": "array",
"description": "Store sub-balances by pay-out PSP. Requires the feature Hybrid pay-out PSP to be enabled on the platform",
"items": {
"$ref": "#/components/schemas/S20_Response_200_Shops_PaymentDetails_SubBalances"
}
},
"subscription_free_from": {
"type": "string",
"format": "date-time",
"description": "Subscription is free from this date"
},
"subscription_free_to": {
"type": "string",
"format": "date-time",
"description": "Subscription is free until this date"
}
},
"required": [
"paid_balance",
"pay_subscription",
"payable_balance",
"payment_blocked",
"pending_balance"
]
},
"S20_Response_200_Shops_PaymentDetails_SubBalances": {
"type": "object",
"properties": {
"paid": {
"type": "number",
"format": "with decimals",
"description": "Paid balance"
},
"pay_out_psp_code": {
"type": "string",
"description": "Code of the Payment Service Provider (PSP)\n\nEnum: `\"NOT_SPECIFIED\"`, `\"MANGOPAY\"`, `\"MIRAKL_PAYOUT\"`, `\"OPERATOR\"`\n"
},
"payable": {
"type": "number",
"format": "with decimals",
"description": "Payable balance"
},
"pending": {
"type": "number",
"format": "with decimals",
"description": "Pending balance"
}
},
"required": [
"paid",
"pay_out_psp_code",
"payable",
"pending"
]
},
"S20_Response_200_Shops_PaymentInfo": {
"type": "object",
"discriminator": {
"mapping": {
"ABA": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Aba",
"AUBSB": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Aubsb",
"BRAZILIAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Brazilian",
"CANADIAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Canadian",
"COLOMBIAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Colombian",
"GUATEMALAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Guatemalan",
"HK": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Hk",
"IBAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Iban",
"INDIAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Indian",
"ISRAELI": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Israeli",
"JAPANESE": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Japanese",
"MEXICAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Mexican",
"NUBAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Nuban",
"NZBSB": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Nzbsb",
"PAYOUT": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Payout",
"PHILIPPINES": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Philippines",
"SERBIAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Serbian",
"SG": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Sg",
"TAIWANESE": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Taiwanese",
"THAI": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Thai",
"UK": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Uk",
"URUGUAYAN": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Uruguayan",
"VIETNAMESE": "#/components/schemas/S20_Response_200_Shops_PaymentInfo_Vietnamese"
},
"propertyName": "@type"
},
"properties": {
"@type": {
"type": "string",
"description": "Enum: `\"IBAN\"`, `\"NUBAN\"`, `\"AUBSB\"`, `\"NZBSB\"`, `\"ABA\"`, `\"HK\"`, `\"CANADIAN\"`, `\"MEXICAN\"`, `\"JAPANESE\"`, `\"BRAZILIAN\"`, `\"TAIWANESE\"`, `\"THAI\"`, `\"INDIAN\"`, `\"UK\"`, `\"URUGUAYAN\"`, `\"COLOMBIAN\"`, `\"GUATEMALAN\"`, `\"SG\"`, `\"ISRAELI\"`, `\"VIETNAMESE\"`, `\"SERBIAN\"`, `\"PHILIPPINES\"`, `\"PAYOUT\"`\n"
},
"owner": {
"type": "string",
"description": "Name of the owner of the payment information",
"maxLength": 100,
"minLength": 1
}
},
"required": [
"owner"
]
},
"S20_Response_200_Shops_PaymentInfo_Aba": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/S20_Response_200_Shops_PaymentInfo"
}
],
"properties": {
"bank_account_number": {
"type": "string",
"description": "Bank Account Number",
"maxLength": 17,
"minLength": 3,
"pattern": "[0-9]+"
},
"bank_city": {
"type": "string",
"description": "Bank city",
"maxLength": 100,
"minLength": 3
},
"bank_name": {
"type": "string",
"description": "Bank name",
"maxLength": 255,
"minLength": 0
},
"bank_street": {
"type": "string",
"description": "Bank street name",
"maxLength": 100,
"minLength": 3
},
"bank_zip": {
"type": "string",
"description": "Bank zip code",
"maxLength": 255,
"minLength": 0
},
"bic": {
"type": "string",
"description": "Bank account BIC code (aka Swift Code)"
},
"routing_number": {
"type": "string",
"description": "Routing Number of the bank, (aka ABA code)",
"pattern": "[0-9]+"
}
},
"required": [
"bank_account_number",
"bank_name",
"routing_number"
]
},
"S20_Response_200_Shops_PaymentInfo_Aubsb": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/S20_Response_200_Shops_PaymentInfo"
}
],
"properties": {
"auban": {
"type": "string",
"description": "Bank account number",
"maxLength": 10,
"minLength": 6,
"pattern": "[0-9]+"
},
"aubsb": {
"type": "string",
"description": "Bank state branch code",
"pattern": "[0-9]+"
},
"bank_city": {
"type": "string",
"description": "Bank city",
"maxLength": 100,
"minLength": 3
},
"bank_name": {
"type": "string",
"description": "Bank name",
"maxLength": 255,
"minLength": 0
},
"bank_street": {
"type": "string",
"description": "Bank street name",
"maxLength": 100,
"minLength": 3
},
"bank_zip": {
"type": "string",
"description": "Bank zip code",
"maxLength": 255,
"minLength": 0
}
},
"required": [
"auban",
"aubsb",
"bank_name"
]
},
"S20_Response_200_Shops_PaymentInfo_Brazilian": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/S20_Response_200_Shops_PaymentInfo"
}
],
"properties": {
"account_number": {
"type": "string",
"description": "Account number",
"maxLength": 11,
"minLength": 10,
"pattern": "[0-9]+"
},
"bank_account_type": {
"type": "string",
"description": "Account typeC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Checking accountP : Savings accountC : Current accountP : Savings accountC : Checking accountP : Savings accountVAT Number (for taxes)
Use tax_identification_number instead
" }, "corporate_name": { "type": "string", "deprecated": true, "description": "Corporate name
Use \"default_billing_information.company_registration_name\" attribute instead
" }, "identification_number": { "type": "string", "deprecated": true, "description": "Identification number of the shop. For France it would be the SIRET
Use \"default_billing_information.company_registration_number\" attribute instead
" }, "tax_identification_number": { "type": "string", "deprecated": true, "description": "Tax identification number
Use \"default_billing_information.tax_identification_number\" attribute instead if the operator's tax number country is one of the following: Caribbean Netherlands, Cuba, Curaçao, Djibouti, Eritrea, Guam, South Korea, Liberia, Malaysia, Myanmar,PuertoRico, Solomon Islands, Somalia, South Sudan, Timor-Leste, Tuvalu, United States, or Yemen. Use \"default_billing_information.local_tax_number\" attribute instead otherwise
" } } }, "S20_Response_200_Shops_ProducerIdentifiers": { "type": "object", "properties": { "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\nEnum: `\"FR-AGROPACK\"`, `\"FR-ASL\"`, `\"FR-DASRIPAT\"`, `\"FR-DBPS\"`, `\"FR-DDS\"`, `\"FR-DEA\"`, `\"FR-DEEE\"`, `\"FR-DISPMED\"`, `\"FR-DIY\"`, `\"FR-EMBM\"`, `\"FR-GF\"`, `\"FR-JOUETS\"`, `\"FR-LUB\"`, `\"FR-MH\"`, `\"FR-MNU\"`, `\"FR-PA\"`, `\"FR-PAP\"`, `\"FR-PCHIM\"`, `\"FR-PMCB\"`, `\"FR-PNEU\"`, `\"FR-TABAC\"`, `\"FR-TLC\"`, `\"FR-VEHICULE\"`, `\"FR-VHU\"`, `\"DE-BATTG\"`, `\"DE-PACK\"`, `\"DE-WEEE\"`, `\"ES-PACK\"`, `\"ES-GPACK\"`, `\"ES-WEEE\"`\n", "maxLength": 255, "minLength": 0 }, "producer_id": { "type": "string", "description": "Shop producer identifier.", "maxLength": 255, "minLength": 0 } }, "required": [ "epr_category_code", "producer_id" ] }, "S20_Response_200_Shops_Shipping": { "type": "object", "properties": { "lead_time_to_ship": { "type": "integer", "format": "int32", "description": "Default lead time to ship of the shop" } } }, "S20_Response_200_Shops_Shippings": { "type": "object", "properties": { "additional_fields": { "type": "array", "description": "List of custom shipping fields for this shipping zone and shipping method", "items": { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } }, "shipping_free_amount": { "type": "number", "format": "with decimals", "description": "Minimal amount for free shipping" }, "shipping_type_code": { "type": "string", "description": "The code of the shipping type" }, "shipping_type_label": { "type": "string", "description": "The label of the shipping type" }, "shipping_type_standard_code": { "type": "string", "description": "The code of the standard shipping type" }, "shipping_zone_code": { "type": "string", "description": "The code of the shipping zone" }, "shipping_zone_label": { "type": "string", "description": "The label of the shipping zone" } }, "required": [ "shipping_type_code", "shipping_type_label", "shipping_zone_code", "shipping_zone_label" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields_Boolean", "DATE": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields_Date", "LINK": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields_Link", "LIST": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields_Numeric", "REGEX": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields_Regex", "STRING": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields_String", "TEXTAREA": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_Shippings_AdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_Shippings_AdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_ShopAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields_Boolean", "DATE": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields_Date", "LINK": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields_Link", "LIST": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields_Numeric", "REGEX": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields_Regex", "STRING": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields_String", "TEXTAREA": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "S20_Response_200_Shops_ShopAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_ShopAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_ShopAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_ShopAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_ShopAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "S20_Response_200_Shops_ShopAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_ShopAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_ShopAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_ShopAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/S20_Response_200_Shops_ShopAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "S20_Response_200_Shops_SpecificBillingInformations": { "type": "object", "properties": { "corporate_information": { "$ref": "#/components/schemas/S20_Response_200_Shops_SpecificBillingInformations_CorporateInformation", "description": "The corporate information of the shop.\nprofessional\n"
},
"fiscal_information": {
"$ref": "#/components/schemas/S20_Response_200_Shops_SpecificBillingInformations_FiscalInformation",
"description": "The fiscal information of the shop.\nprofessional\n"
},
"fiscal_representative": {
"$ref": "#/components/schemas/S20_Response_200_Shops_SpecificBillingInformations_FiscalRepresentative",
"description": "The fiscal representative associated to the billing information.\nprofessional\n"
},
"id": {
"type": "string",
"description": "The unique identifier of the specific billing information."
},
"personal_information": {
"$ref": "#/components/schemas/S20_Response_200_Shops_SpecificBillingInformations_PersonalInformation",
"description": "The personal information of the shop owner.\nnon professional or professional sole trader\n"
},
"registration_address": {
"$ref": "#/components/schemas/S20_Response_200_Shops_SpecificBillingInformations_RegistrationAddress",
"description": "The complete registration address of the shop."
}
},
"required": [
"id",
"registration_address"
]
},
"S20_Response_200_Shops_SpecificBillingInformations_CorporateInformation": {
"type": "object",
"properties": {
"company_registration_name": {
"type": "string",
"description": "The name of the shop company, as registered in the business registry of the shop country"
},
"company_registration_number": {
"type": "string",
"description": "The unique code used to identify the shop company and verify its legal existence as an incorporated entity"
},
"complementary_information": {
"$ref": "#/components/schemas/S20_Response_200_Shops_SpecificBillingInformations_CorporateInformation_ComplementaryInformation",
"description": "The complementary information of the shop, as requested by local regulations."
},
"electronic_address": {
"type": "string",
"description": "The electronic address (e-invoicing routing code) of the billing entity, used for e-invoice routing and transmission"
},
"phone_number": {
"type": "string",
"description": "The phone number of the billing entity, used for e-invoicing purposes"
}
}
},
"S20_Response_200_Shops_SpecificBillingInformations_CorporateInformation_ComplementaryInformation": {
"type": "object",
"properties": {
"business_activity_code": {
"type": "string",
"description": "The business activity code of the company, known as APE code in France.\nEU, and the seller is registered in France.\n"
},
"company_registration_city": {
"type": "string",
"description": "The city of the company's registry office.\nEU and the seller is registered in France or Luxembourg.\n"
},
"company_registration_province": {
"type": "string",
"description": "The initials of the company’s registry office province. Known as Ufficio in Italy.\nEU and the seller is registered in Italy.\n"
},
"company_shareholders": {
"type": "string",
"description": "Indicates if there is a single shareholder or several shareholders. Known as Socio Unico in Italy.\nEU and the seller is registered in Italy.\n\n\nEnum: `\"SINGLE\"`, `\"SEVERAL\"`\n"
},
"is_in_liquidation": {
"type": "boolean",
"description": "Indicates whether the company is in liquidation or not.\nEU\n"
},
"legal_form": {
"type": "string",
"description": "The legal form of the company.\nEU\n"
},
"share_capital": {
"type": "number",
"format": "with decimals",
"description": "The share capital of the company.\nEU\n"
},
"share_capital_currency": {
"type": "string",
"description": "The share capital currency of the company.\nEU\n\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n"
},
"sole_trader": {
"type": "boolean",
"description": "Defines if the shop is a sole trader. When this option is set to true, additional information is asked to the shop. Applies only when the operator is registered in the EU"
}
}
},
"S20_Response_200_Shops_SpecificBillingInformations_FiscalInformation": {
"type": "object",
"properties": {
"local_tax_number": {
"type": "string",
"description": "The VAT or GST number of the shop"
},
"tax_identification_country": {
"type": "string",
"description": "The country of issuance of the tax identification number\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"tax_identification_number": {
"type": "string",
"description": "The identifying number issued by the tax administration of the shop country"
}
}
},
"S20_Response_200_Shops_SpecificBillingInformations_FiscalRepresentative": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the fiscal representative is located."
},
"civility": {
"type": "string",
"description": "Civility of the fiscal representative"
},
"company_registration_name": {
"type": "string",
"description": "The name of the fiscal representative, as registered if the business registry of the fiscal representative's country"
},
"company_registration_number": {
"type": "string",
"description": "The unique code used to identify the fiscal representative and verify its legal existence as an incorporated entity"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO 3166-1 code of the fiscal representative address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"first_name": {
"type": "string",
"description": "First name of the fiscal representative"
},
"last_name": {
"type": "string",
"description": "Last name of the fiscal representative"
},
"local_tax_number": {
"type": "string",
"description": "The identifying number of the fiscal representative for VAT or GST purposes"
},
"state": {
"type": "string",
"description": "The state/province/region where the fiscal representative is located."
},
"street_1": {
"type": "string",
"description": "The first line of address of the fiscal representative"
},
"street_2": {
"type": "string",
"description": "The second line of address of the fiscal representative"
},
"zip_code": {
"type": "string",
"description": "The Zip/Postal code corresponding to the fiscal representative location"
}
},
"required": [
"city",
"civility",
"company_registration_name",
"company_registration_number",
"country_iso_code",
"first_name",
"last_name",
"street_1"
]
},
"S20_Response_200_Shops_SpecificBillingInformations_PersonalInformation": {
"type": "object",
"properties": {
"birth_city": {
"type": "string",
"description": "The city of birth of the shop owner.\nnon professional or professional sole trader.\n"
},
"birth_country": {
"type": "string",
"description": "The country of birth of the shop owner.\nnon professional or professional sole trader.\n\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"birth_date": {
"type": "string",
"format": "date",
"description": "The birth date of the shop owner.\nnon professional or professional sole trader.\n"
},
"civility": {
"type": "string",
"description": "The civility of the shop owner.\nnon professional or professional sole trader.\n"
},
"first_name": {
"type": "string",
"description": "The first name of the shop owner.\nnon professional or professional sole trader.\n"
},
"last_name": {
"type": "string",
"description": "The last name of the shop owner.\nnon professional or professional sole trader.\n"
}
}
},
"S20_Response_200_Shops_SpecificBillingInformations_RegistrationAddress": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the shop company is located."
},
"country_iso_code": {
"type": "string",
"description": "Country ISO 3166-1 code of the shop company address\n\nEnum: `\"AFG\"`, `\"ALA\"`, `\"ALB\"`, `\"DZA\"`, `\"ASM\"`, `\"AND\"`, `\"AGO\"`, `\"AIA\"`, `\"ATA\"`, `\"ATG\"`, `\"ARG\"`, `\"ARM\"`, `\"ABW\"`, `\"AUS\"`, `\"AUT\"`, `\"AZE\"`, `\"BHS\"`, `\"BHR\"`, `\"BGD\"`, `\"BRB\"`, `\"BLR\"`, `\"BEL\"`, `\"BLZ\"`, `\"BEN\"`, `\"BMU\"`, `\"BTN\"`, `\"BOL\"`, `\"BES\"`, `\"BIH\"`, `\"BWA\"`, `\"BVT\"`, `\"BRA\"`, `\"IOT\"`, `\"BRN\"`, `\"BGR\"`, `\"BFA\"`, `\"BDI\"`, `\"KHM\"`, `\"CMR\"`, `\"CAN\"`, `\"CPV\"`, `\"CYM\"`, `\"CAF\"`, `\"TCD\"`, `\"CHL\"`, `\"CHN\"`, `\"CXR\"`, `\"CCK\"`, `\"COL\"`, `\"COM\"`, `\"COG\"`, `\"COD\"`, `\"COK\"`, `\"CRI\"`, `\"CIV\"`, `\"HRV\"`, `\"CUB\"`, `\"CUW\"`, `\"CYP\"`, `\"CZE\"`, `\"DNK\"`, `\"DJI\"`, `\"DMA\"`, `\"DOM\"`, `\"ECU\"`, `\"EGY\"`, `\"SLV\"`, `\"GNQ\"`, `\"ERI\"`, `\"EST\"`, `\"ETH\"`, `\"FLK\"`, `\"FRO\"`, `\"FJI\"`, `\"FIN\"`, `\"FRA\"`, `\"GUF\"`, `\"PYF\"`, `\"ATF\"`, `\"GAB\"`, `\"GMB\"`, `\"GEO\"`, `\"DEU\"`, `\"GHA\"`, `\"GIB\"`, `\"GRC\"`, `\"GRL\"`, `\"GRD\"`, `\"GLP\"`, `\"GUM\"`, `\"GTM\"`, `\"GGY\"`, `\"GIN\"`, `\"GNB\"`, `\"GUY\"`, `\"HTI\"`, `\"HMD\"`, `\"VAT\"`, `\"HND\"`, `\"HKG\"`, `\"HUN\"`, `\"ISL\"`, `\"IND\"`, `\"IDN\"`, `\"IRQ\"`, `\"IRL\"`, `\"IMN\"`, `\"ISR\"`, `\"ITA\"`, `\"JAM\"`, `\"JPN\"`, `\"JEY\"`, `\"JOR\"`, `\"KAZ\"`, `\"KEN\"`, `\"KIR\"`, `\"KOR\"`, `\"KWT\"`, `\"KGZ\"`, `\"LAO\"`, `\"LVA\"`, `\"LBN\"`, `\"LSO\"`, `\"LBR\"`, `\"LBY\"`, `\"LIE\"`, `\"LTU\"`, `\"LUX\"`, `\"MAC\"`, `\"MKD\"`, `\"MDG\"`, `\"MWI\"`, `\"MYS\"`, `\"MDV\"`, `\"MLI\"`, `\"MLT\"`, `\"MHL\"`, `\"MTQ\"`, `\"MRT\"`, `\"MUS\"`, `\"MYT\"`, `\"MEX\"`, `\"FSM\"`, `\"MDA\"`, `\"MCO\"`, `\"MNG\"`, `\"MNE\"`, `\"MSR\"`, `\"MAR\"`, `\"MOZ\"`, `\"MMR\"`, `\"NAM\"`, `\"NRU\"`, `\"NPL\"`, `\"NLD\"`, `\"NCL\"`, `\"NZL\"`, `\"NIC\"`, `\"NER\"`, `\"NGA\"`, `\"NIU\"`, `\"NFK\"`, `\"MNP\"`, `\"NOR\"`, `\"OMN\"`, `\"PAK\"`, `\"PLW\"`, `\"PSE\"`, `\"PAN\"`, `\"PNG\"`, `\"PRY\"`, `\"PER\"`, `\"PHL\"`, `\"PCN\"`, `\"POL\"`, `\"PRT\"`, `\"PRI\"`, `\"QAT\"`, `\"REU\"`, `\"ROU\"`, `\"RUS\"`, `\"RWA\"`, `\"BLM\"`, `\"SHN\"`, `\"KNA\"`, `\"LCA\"`, `\"MAF\"`, `\"SPM\"`, `\"VCT\"`, `\"WSM\"`, `\"SMR\"`, `\"STP\"`, `\"SAU\"`, `\"SEN\"`, `\"SRB\"`, `\"SYC\"`, `\"SLE\"`, `\"SGP\"`, `\"SXM\"`, `\"SVK\"`, `\"SVN\"`, `\"SLB\"`, `\"SOM\"`, `\"ZAF\"`, `\"SGS\"`, `\"SSD\"`, `\"ESP\"`, `\"LKA\"`, `\"SUR\"`, `\"SJM\"`, `\"SWZ\"`, `\"SWE\"`, `\"CHE\"`, `\"TWN\"`, `\"TJK\"`, `\"TZA\"`, `\"THA\"`, `\"TLS\"`, `\"TGO\"`, `\"TKL\"`, `\"TON\"`, `\"TTO\"`, `\"TUN\"`, `\"TUR\"`, `\"TKM\"`, `\"TCA\"`, `\"TUV\"`, `\"UGA\"`, `\"UKR\"`, `\"ARE\"`, `\"GBR\"`, `\"USA\"`, `\"UMI\"`, `\"URY\"`, `\"UZB\"`, `\"VUT\"`, `\"VEN\"`, `\"VNM\"`, `\"VGB\"`, `\"VIR\"`, `\"WLF\"`, `\"YEM\"`, `\"ZMB\"`, `\"ZWE\"`\n"
},
"state": {
"type": "string",
"description": "The state/province/region where the shop company is located."
},
"street_1": {
"type": "string",
"description": "The first line of the address of the shop company"
},
"street_2": {
"type": "string",
"description": "The second line of the address of the shop company"
},
"zip_code": {
"type": "string",
"description": "The Zip/Postal code corresponding to the shop company location"
}
},
"required": [
"city",
"country_iso_code",
"street_1"
]
},
"S30_Response_200": {
"type": "object",
"properties": {
"shop_documents": {
"type": "array",
"description": "The document details",
"items": {
"$ref": "#/components/schemas/S30_Response_200_ShopDocuments"
}
},
"total_count": {
"type": "integer",
"format": "int32",
"deprecated": true,
"description": "Total number of documents"
}
},
"required": [
"shop_documents"
]
},
"S30_Response_200_ShopDocuments": {
"type": "object",
"properties": {
"date_deleted": {
"type": "string",
"format": "date-time",
"description": "Document deleted date"
},
"date_uploaded": {
"type": "string",
"format": "date-time",
"description": "Document uploaded date"
},
"file_name": {
"type": "string",
"description": "Document file name"
},
"id": {
"type": "integer",
"format": "int64",
"description": "Document identifier"
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The id of the shop owning the document"
},
"type": {
"type": "string",
"description": "Document type code"
}
},
"required": [
"file_name",
"id",
"shop_id",
"type"
]
},
"S32_Request_MultipartFormData_ShopDocuments": {
"type": "object",
"properties": {
"shop_documents": {
"type": "array",
"description": "Shop documents",
"items": {
"$ref": "#/components/schemas/S32_Request_MultipartFormData_ShopDocuments_ShopDocuments"
}
}
},
"required": [
"shop_documents"
]
},
"S32_Request_MultipartFormData_ShopDocuments_ShopDocuments": {
"type": "object",
"description": "Shop documents",
"properties": {
"file_name": {
"type": "string",
"description": "File name"
},
"type_code": {
"type": "string",
"description": "Document type code"
}
},
"required": [
"file_name",
"type_code"
]
},
"S32_Response_200": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"description": "List of error reports associated to each document in an error state",
"items": {
"$ref": "#/components/schemas/S32_Response_200_Documents"
}
},
"errors_count": {
"type": "integer",
"format": "int32",
"description": "The number of documents in an error state"
}
},
"required": [
"documents"
]
},
"S32_Response_200_Documents": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "Errors about the input object",
"items": {
"$ref": "#/components/schemas/S32_Response_200_Documents_Errors"
},
"uniqueItems": true
}
},
"required": [
"errors"
]
},
"S32_Response_200_Documents_Errors": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"field": {
"type": "string",
"description": "Name of the field on the input object. Can be composed, e.g.: address.zip_code"
},
"message": {
"type": "string",
"description": "Error message"
}
},
"required": [
"code",
"field",
"message"
]
},
"S51_Response_200": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Page of data",
"items": {
"$ref": "#/components/schemas/S51_Response_200_Data"
}
},
"next_page_token": {
"type": "string",
"description": "Token to access the next page. Absent if the current page is the last one."
},
"previous_page_token": {
"type": "string",
"description": "Token to access the previous page. Absent if the current page is the first one."
}
},
"required": [
"data"
]
},
"S51_Response_200_Data": {
"type": "object",
"properties": {
"business_closing_days": {
"type": "array",
"description": "Business closing days",
"items": {
"$ref": "#/components/schemas/S51_Response_200_Data_BusinessClosingDays"
}
},
"business_days": {
"type": "array",
"description": "Business days",
"items": {
"type": "string",
"description": "Enum: `\"MONDAY\"`, `\"TUESDAY\"`, `\"WEDNESDAY\"`, `\"THURSDAY\"`, `\"FRIDAY\"`, `\"SATURDAY\"`, `\"SUNDAY\"`\n"
}
},
"business_hours": {
"$ref": "#/components/schemas/S51_Response_200_Data_BusinessHours",
"description": "Business hours expressed in platform timezone"
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the shop"
}
},
"required": [
"business_closing_days",
"business_days",
"shop_id"
]
},
"S51_Response_200_Data_BusinessClosingDays": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Operator code of the closing day"
},
"date": {
"type": "string",
"format": "date",
"description": "Date of the closing day"
},
"label": {
"type": "string",
"description": "Label of the closing day"
},
"recurring": {
"type": "boolean",
"description": "Indicates if this closing day is recurring yearly"
}
},
"required": [
"date"
]
},
"S51_Response_200_Data_BusinessHours": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "time",
"description": "Opening from hour"
},
"to": {
"type": "string",
"format": "time",
"description": "Open until hour"
}
},
"required": [
"from",
"to"
]
},
"US01_Request": {
"type": "object",
"properties": {
"access": {
"$ref": "#/components/schemas/US01_Request_Access",
"description": "The different access rights granted to the user"
},
"email": {
"type": "string",
"description": "Operator user email"
},
"locale": {
"type": "string",
"description": "Invitation locale"
}
},
"required": [
"email",
"locale"
]
},
"US01_Request_Access": {
"type": "object",
"description": "The different access rights granted to the user",
"properties": {
"channels": {
"type": "array",
"description": "Operator user assigned channels. If not precised, all channels are assigned. Ignored if segmentation per channels is not activated",
"items": {
"type": "string"
},
"uniqueItems": true
},
"platform_models": {
"type": "array",
"description": "Operator user assigned platform models. If not precised, all platform models are assigned. Ignored if segmentation per platform models is not activated",
"items": {
"type": "string",
"description": "Enum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n"
},
"uniqueItems": true
},
"roles": {
"type": "array",
"description": "Operator user assigned roles",
"items": {
"type": "string"
}
}
}
},
"US01_Response_201": {
"type": "object",
"properties": {
"access": {
"$ref": "#/components/schemas/US01_Response_201_Access",
"description": "The different access rights granted to the user"
},
"activity": {
"$ref": "#/components/schemas/US01_Response_201_Activity",
"description": "The different activity data related to the operator user"
},
"email": {
"type": "string",
"description": "Operator user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the operator user has generated an API key",
"readOnly": true
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created operator user",
"readOnly": true
},
"locale": {
"type": "string",
"description": "Operator user locale"
},
"status": {
"type": "string",
"description": "Operator user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n",
"readOnly": true
}
},
"required": [
"access",
"activity",
"email",
"has_api_key",
"id",
"locale",
"status"
]
},
"US01_Response_201_Access": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"description": "Operator user assigned channels. If not precised, all channels are assigned. Ignored if segmentation per channels is not activated",
"items": {
"type": "string"
},
"uniqueItems": true
},
"platform_models": {
"type": "array",
"description": "Operator user assigned platform models. If not precised, all platform models are assigned. Ignored if segmentation per platform models is not activated",
"items": {
"type": "string",
"description": "Enum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n"
},
"uniqueItems": true
},
"roles": {
"type": "array",
"description": "Operator user assigned roles",
"items": {
"type": "string"
}
}
},
"required": [
"channels",
"platform_models",
"roles"
]
},
"US01_Response_201_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Operator user creation date",
"readOnly": true
},
"last_login": {
"$ref": "#/components/schemas/US01_Response_201_Activity_LastLogin",
"description": "Operator user last logins to the platform"
}
},
"readOnly": true,
"required": [
"creation"
]
},
"US01_Response_201_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Operator last API call date",
"readOnly": true
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Operator last access date to the back office",
"readOnly": true
}
},
"readOnly": true
},
"US02_Request": {
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "The different access rights granted to the user",
"items": {
"$ref": "#/components/schemas/US02_Request_Access"
}
},
"email": {
"type": "string",
"description": "Shop user email"
},
"locale": {
"type": "string",
"description": "Shop user locale"
}
},
"required": [
"access",
"email",
"locale"
]
},
"US02_Request_Access": {
"type": "object",
"description": "The different access rights granted to the user",
"properties": {
"roles": {
"type": "array",
"description": "Shop user assigned roles. Shop role list is provided by RO02 API",
"items": {
"type": "string"
}
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the store the shop user will be a member of"
}
},
"required": [
"roles",
"shop_id"
]
},
"US02_Response_201": {
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "The different access rights granted to the user",
"items": {
"$ref": "#/components/schemas/US02_Response_201_Access"
}
},
"activity": {
"$ref": "#/components/schemas/US02_Response_201_Activity",
"description": "The different activity data related to the shop user"
},
"email": {
"type": "string",
"description": "Shop user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the shop user has generated an API key"
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created shop user"
},
"locale": {
"type": "string",
"description": "Shop user locale"
},
"status": {
"type": "string",
"description": "Shop user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n"
}
}
},
"US02_Response_201_Access": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"description": "Shop user assigned roles. Shop role list is provided by RO02 API",
"items": {
"type": "string"
}
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the store the shop user will be a member of"
}
},
"required": [
"roles",
"shop_id"
]
},
"US02_Response_201_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Shop user creation date"
},
"last_login": {
"$ref": "#/components/schemas/US02_Response_201_Activity_LastLogin",
"description": "Shop user last logins to the platform"
},
"last_update": {
"type": "string",
"format": "date-time",
"description": "Shop user last update"
}
}
},
"US02_Response_201_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Shop last API call date"
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Shop last access date to the back office"
}
}
},
"US03_Request": {
"type": "object",
"properties": {
"access": {
"$ref": "#/components/schemas/US03_Request_Access",
"description": "The different access rights granted to the user"
},
"email": {
"type": "string",
"description": "Operator user email"
}
},
"required": [
"email"
]
},
"US03_Request_Access": {
"type": "object",
"description": "The different access rights granted to the user",
"properties": {
"channels": {
"type": "array",
"description": "Operator user assigned channels.",
"items": {
"type": "string"
},
"uniqueItems": true
},
"platform_models": {
"type": "array",
"description": "Operator user assigned platform models.",
"items": {
"type": "string",
"description": "Enum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n"
},
"uniqueItems": true
},
"roles": {
"type": "array",
"description": "Operator user assigned roles",
"items": {
"type": "string"
}
}
}
},
"US03_Response_200": {
"type": "object",
"properties": {
"access": {
"$ref": "#/components/schemas/US03_Response_200_Access",
"description": "The different access rights granted to the user"
},
"activity": {
"$ref": "#/components/schemas/US03_Response_200_Activity",
"description": "The different activity data related to the operator user"
},
"email": {
"type": "string",
"description": "Operator user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the operator user has generated an API key",
"readOnly": true
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created operator user",
"readOnly": true
},
"locale": {
"type": "string",
"description": "Operator user locale"
},
"status": {
"type": "string",
"description": "Operator user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n",
"readOnly": true
}
},
"required": [
"access",
"activity",
"email",
"has_api_key",
"id",
"locale",
"status"
]
},
"US03_Response_200_Access": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"description": "Operator user assigned channels. If not precised, all channels are assigned. Ignored if segmentation per channels is not activated",
"items": {
"type": "string"
},
"uniqueItems": true
},
"platform_models": {
"type": "array",
"description": "Operator user assigned platform models. If not precised, all platform models are assigned. Ignored if segmentation per platform models is not activated",
"items": {
"type": "string",
"description": "Enum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n"
},
"uniqueItems": true
},
"roles": {
"type": "array",
"description": "Operator user assigned roles",
"items": {
"type": "string"
}
}
},
"required": [
"channels",
"platform_models",
"roles"
]
},
"US03_Response_200_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Operator user creation date",
"readOnly": true
},
"last_login": {
"$ref": "#/components/schemas/US03_Response_200_Activity_LastLogin",
"description": "Operator user last logins to the platform"
}
},
"readOnly": true,
"required": [
"creation"
]
},
"US03_Response_200_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Operator last API call date",
"readOnly": true
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Operator last access date to the back office",
"readOnly": true
}
},
"readOnly": true
},
"US04_Request": {
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/US04_Request_Users"
},
"maxItems": 100,
"minItems": 1
}
},
"required": [
"users"
]
},
"US04_Request_Users": {
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "The different access rights granted to the user",
"items": {
"$ref": "#/components/schemas/US04_Request_Users_Access"
}
},
"id": {
"type": "integer",
"format": "int64",
"description": "Shop user id"
}
},
"required": [
"id"
]
},
"US04_Request_Users_Access": {
"type": "object",
"description": "The different access rights granted to the user",
"properties": {
"roles": {
"type": "array",
"description": "Shop user assigned roles. Shop role list is provided by RO02 API",
"items": {
"type": "string"
}
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the store the shop user will be a member of"
}
},
"required": [
"roles",
"shop_id"
]
},
"US04_Response_200": {
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "The different access rights granted to the user",
"items": {
"$ref": "#/components/schemas/US04_Response_200_Access"
}
},
"activity": {
"$ref": "#/components/schemas/US04_Response_200_Activity",
"description": "The different activity data related to the shop user"
},
"email": {
"type": "string",
"description": "Shop user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the shop user has generated an API key"
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created shop user"
},
"locale": {
"type": "string",
"description": "Shop user locale"
},
"status": {
"type": "string",
"description": "Shop user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n"
}
}
},
"US04_Response_200_Access": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"description": "Shop user assigned roles. Shop role list is provided by RO02 API",
"items": {
"type": "string"
}
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the store the shop user will be a member of"
}
},
"required": [
"roles",
"shop_id"
]
},
"US04_Response_200_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Shop user creation date"
},
"last_login": {
"$ref": "#/components/schemas/US04_Response_200_Activity_LastLogin",
"description": "Shop user last logins to the platform"
},
"last_update": {
"type": "string",
"format": "date-time",
"description": "Shop user last update"
}
}
},
"US04_Response_200_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Shop last API call date"
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Shop last access date to the back office"
}
}
},
"US11_Response_200": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Page of data",
"items": {
"$ref": "#/components/schemas/US11_Response_200_Data"
}
},
"next_page_token": {
"type": "string",
"description": "Token to access the next page. Absent if the current page is the last one."
},
"previous_page_token": {
"type": "string",
"description": "Token to access the previous page. Absent if the current page is the first one."
}
},
"required": [
"data"
]
},
"US11_Response_200_Data": {
"type": "object",
"properties": {
"access": {
"$ref": "#/components/schemas/US11_Response_200_Data_Access",
"description": "The different access rights granted to the user"
},
"activity": {
"$ref": "#/components/schemas/US11_Response_200_Data_Activity",
"description": "The different activity data related to the operator user"
},
"email": {
"type": "string",
"description": "Operator user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the operator user has generated an API key",
"readOnly": true
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created operator user",
"readOnly": true
},
"locale": {
"type": "string",
"description": "Operator user locale"
},
"status": {
"type": "string",
"description": "Operator user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n",
"readOnly": true
}
},
"required": [
"access",
"activity",
"email",
"has_api_key",
"id",
"locale",
"status"
]
},
"US11_Response_200_Data_Access": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"description": "Operator user assigned channels. If not precised, all channels are assigned. Ignored if segmentation per channels is not activated",
"items": {
"type": "string"
},
"uniqueItems": true
},
"platform_models": {
"type": "array",
"description": "Operator user assigned platform models. If not precised, all platform models are assigned. Ignored if segmentation per platform models is not activated",
"items": {
"type": "string",
"description": "Enum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n"
},
"uniqueItems": true
},
"roles": {
"type": "array",
"description": "Operator user assigned roles",
"items": {
"type": "string"
}
}
},
"required": [
"channels",
"platform_models",
"roles"
]
},
"US11_Response_200_Data_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Operator user creation date",
"readOnly": true
},
"last_login": {
"$ref": "#/components/schemas/US11_Response_200_Data_Activity_LastLogin",
"description": "Operator user last logins to the platform"
}
},
"readOnly": true,
"required": [
"creation"
]
},
"US11_Response_200_Data_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Operator last API call date",
"readOnly": true
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Operator last access date to the back office",
"readOnly": true
}
},
"readOnly": true
},
"US12_Response_200": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Page of data",
"items": {
"$ref": "#/components/schemas/US12_Response_200_Data"
}
},
"next_page_token": {
"type": "string",
"description": "Token to access the next page. Absent if the current page is the last one."
},
"previous_page_token": {
"type": "string",
"description": "Token to access the previous page. Absent if the current page is the first one."
}
},
"required": [
"data"
]
},
"US12_Response_200_Data": {
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "The different access rights granted to the user",
"items": {
"$ref": "#/components/schemas/US12_Response_200_Data_Access"
}
},
"activity": {
"$ref": "#/components/schemas/US12_Response_200_Data_Activity",
"description": "The different activity data related to the shop user"
},
"email": {
"type": "string",
"description": "Shop user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the shop user has generated an API key"
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created shop user"
},
"locale": {
"type": "string",
"description": "Shop user locale"
},
"status": {
"type": "string",
"description": "Shop user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n"
}
}
},
"US12_Response_200_Data_Access": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"description": "Shop user assigned roles. Shop role list is provided by RO02 API",
"items": {
"type": "string"
}
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the store the shop user will be a member of"
}
},
"required": [
"roles",
"shop_id"
]
},
"US12_Response_200_Data_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Shop user creation date"
},
"last_login": {
"$ref": "#/components/schemas/US12_Response_200_Data_Activity_LastLogin",
"description": "Shop user last logins to the platform"
},
"last_update": {
"type": "string",
"format": "date-time",
"description": "Shop user last update"
}
}
},
"US12_Response_200_Data_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Shop last API call date"
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Shop last access date to the back office"
}
}
},
"US22_Request": {
"type": "object",
"properties": {
"shop_ids": {
"type": "array",
"description": "The identifier of the stores the shop user will be removed from",
"items": {
"type": "integer",
"format": "int64"
}
},
"user_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the shop user"
}
},
"required": [
"shop_ids",
"user_id"
]
},
"US22_Response_200": {
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "The different access rights granted to the user",
"items": {
"$ref": "#/components/schemas/US22_Response_200_Access"
}
},
"activity": {
"$ref": "#/components/schemas/US22_Response_200_Activity",
"description": "The different activity data related to the shop user"
},
"email": {
"type": "string",
"description": "Shop user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the shop user has generated an API key"
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created shop user"
},
"locale": {
"type": "string",
"description": "Shop user locale"
},
"status": {
"type": "string",
"description": "Shop user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n"
}
}
},
"US22_Response_200_Access": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"description": "Shop user assigned roles. Shop role list is provided by RO02 API",
"items": {
"type": "string"
}
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the store the shop user will be a member of"
}
},
"required": [
"roles",
"shop_id"
]
},
"US22_Response_200_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Shop user creation date"
},
"last_login": {
"$ref": "#/components/schemas/US22_Response_200_Activity_LastLogin",
"description": "Shop user last logins to the platform"
},
"last_update": {
"type": "string",
"format": "date-time",
"description": "Shop user last update"
}
}
},
"US22_Response_200_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Shop last API call date"
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Shop last access date to the back office"
}
}
},
"US22_Response_400": {
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "The different access rights granted to the user",
"items": {
"$ref": "#/components/schemas/US22_Response_400_Access"
}
},
"activity": {
"$ref": "#/components/schemas/US22_Response_400_Activity",
"description": "The different activity data related to the shop user"
},
"email": {
"type": "string",
"description": "Shop user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the shop user has generated an API key"
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created shop user"
},
"locale": {
"type": "string",
"description": "Shop user locale"
},
"status": {
"type": "string",
"description": "Shop user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n"
}
}
},
"US22_Response_400_Access": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"description": "Shop user assigned roles. Shop role list is provided by RO02 API",
"items": {
"type": "string"
}
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the store the shop user will be a member of"
}
},
"required": [
"roles",
"shop_id"
]
},
"US22_Response_400_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Shop user creation date"
},
"last_login": {
"$ref": "#/components/schemas/US22_Response_400_Activity_LastLogin",
"description": "Shop user last logins to the platform"
},
"last_update": {
"type": "string",
"format": "date-time",
"description": "Shop user last update"
}
}
},
"US22_Response_400_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Shop last API call date"
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Shop last access date to the back office"
}
}
},
"US22_Response_404": {
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "The different access rights granted to the user",
"items": {
"$ref": "#/components/schemas/US22_Response_404_Access"
}
},
"activity": {
"$ref": "#/components/schemas/US22_Response_404_Activity",
"description": "The different activity data related to the shop user"
},
"email": {
"type": "string",
"description": "Shop user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the shop user has generated an API key"
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created shop user"
},
"locale": {
"type": "string",
"description": "Shop user locale"
},
"status": {
"type": "string",
"description": "Shop user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n"
}
}
},
"US22_Response_404_Access": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"description": "Shop user assigned roles. Shop role list is provided by RO02 API",
"items": {
"type": "string"
}
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the store the shop user will be a member of"
}
},
"required": [
"roles",
"shop_id"
]
},
"US22_Response_404_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Shop user creation date"
},
"last_login": {
"$ref": "#/components/schemas/US22_Response_404_Activity_LastLogin",
"description": "Shop user last logins to the platform"
},
"last_update": {
"type": "string",
"format": "date-time",
"description": "Shop user last update"
}
}
},
"US22_Response_404_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Shop last API call date"
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Shop last access date to the back office"
}
}
},
"US23_Request": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "New operator user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`\n"
},
"user_ids": {
"type": "array",
"description": "Operator user ids",
"items": {
"type": "integer",
"format": "int64"
},
"maxItems": 100,
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"status",
"user_ids"
]
},
"US23_Response_200": {
"type": "object",
"description": "Result of a bulk operator status update",
"properties": {
"user_status_update_errors": {
"type": "array",
"description": "Users who could not be updated.",
"items": {
"$ref": "#/components/schemas/US23_Response_200_UserStatusUpdateErrors"
}
},
"user_status_update_success": {
"$ref": "#/components/schemas/US23_Response_200_UserStatusUpdateSuccess",
"description": "Users who have been updated."
}
}
},
"US23_Response_200_UserStatusUpdateErrors": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The cause of the failure."
},
"user_ids": {
"type": "array",
"description": "Users who could not be updated.",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"required": [
"message",
"user_ids"
]
},
"US23_Response_200_UserStatusUpdateSuccess": {
"type": "object",
"properties": {
"new_status": {
"type": "string",
"description": "The updated status.\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`\n"
},
"user_ids": {
"type": "array",
"description": "Users who have updated.",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"required": [
"new_status",
"user_ids"
]
},
"US24_Request": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "New status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`\n"
},
"user_ids": {
"type": "array",
"description": "Shop users to change the status of",
"items": {
"type": "integer",
"format": "int64"
},
"maxItems": 100,
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"status",
"user_ids"
]
},
"US24_Response_200": {
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "The different access rights granted to the user",
"items": {
"$ref": "#/components/schemas/US24_Response_200_Access"
}
},
"activity": {
"$ref": "#/components/schemas/US24_Response_200_Activity",
"description": "The different activity data related to the shop user"
},
"email": {
"type": "string",
"description": "Shop user email"
},
"has_api_key": {
"type": "boolean",
"description": "Returns true if the shop user has generated an API key"
},
"id": {
"type": "integer",
"format": "int64",
"description": "The identifier of created shop user"
},
"locale": {
"type": "string",
"description": "Shop user locale"
},
"status": {
"type": "string",
"description": "Shop user status\n\nEnum: `\"ENABLED\"`, `\"DISABLED\"`, `\"INVITED\"`\n"
}
}
},
"US24_Response_200_Access": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"description": "Shop user assigned roles. Shop role list is provided by RO02 API",
"items": {
"type": "string"
}
},
"shop_id": {
"type": "integer",
"format": "int64",
"description": "The identifier of the store the shop user will be a member of"
}
},
"required": [
"roles",
"shop_id"
]
},
"US24_Response_200_Activity": {
"type": "object",
"properties": {
"creation": {
"type": "string",
"format": "date-time",
"description": "Shop user creation date"
},
"last_login": {
"$ref": "#/components/schemas/US24_Response_200_Activity_LastLogin",
"description": "Shop user last logins to the platform"
},
"last_update": {
"type": "string",
"format": "date-time",
"description": "Shop user last update"
}
}
},
"US24_Response_200_Activity_LastLogin": {
"type": "object",
"properties": {
"api": {
"type": "string",
"format": "date-time",
"description": "Shop last API call date"
},
"bo": {
"type": "string",
"format": "date-time",
"description": "Shop last access date to the back office"
}
}
},
"VL01_Request_MultipartFormData_File_Ext_FileStructure": {
"type": "object",
"description": "CSV input",
"properties": {
"list-code": {
"type": "string",
"description": "Code of the value list",
"maxLength": 255,
"minLength": 0
},
"list-label": {
"type": "string",
"description": "Label of the value list",
"maxLength": 255,
"minLength": 0
},
"list-label[xx]": {
"type": "string",
"description": "Label of the value list in a specific language.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n",
"maxLength": 255,
"minLength": 0
},
"value-code": {
"type": "string",
"description": "Code of the value",
"maxLength": 255,
"minLength": 0
},
"value-label": {
"type": "string",
"description": "Label of the value",
"maxLength": 255,
"minLength": 0
},
"value-label[xx]": {
"type": "string",
"description": "Label of the value in a specific language.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n",
"maxLength": 255,
"minLength": 0
}
},
"required": [
"list-code",
"value-code"
]
},
"VL01_Response_201": {
"type": "object",
"properties": {
"values_lists_import_id": {
"type": "integer",
"format": "int64",
"description": "Import identifier"
}
},
"required": [
"values_lists_import_id"
]
},
"VL02_Response_200": {
"type": "object",
"properties": {
"has_error_report": {
"type": "boolean",
"description": "Returns \"true\" if error report is available. Value is filled when the import is completed."
},
"import_status": {
"type": "string",
"description": "Import status\n\nEnum: `\"WAITING\"`, `\"QUEUED\"`, `\"RUNNING\"`, `\"COMPLETE\"`, `\"CANCELLED\"`, `\"FAILED\"`\n"
}
},
"required": [
"has_error_report",
"import_status"
]
},
"VL03_Response_200_TextCsv_Ext_FileStructure": {
"type": "object",
"description": "CSV output",
"properties": {
"error-line": {
"type": "string",
"description": "Number of the error line"
},
"error-message": {
"type": "string",
"description": "Description of the error"
},
"list-code": {
"type": "string",
"description": "Code of the value list",
"maxLength": 255,
"minLength": 0
},
"list-label": {
"type": "string",
"description": "Label of the value list",
"maxLength": 255,
"minLength": 0
},
"list-label[xx]": {
"type": "string",
"description": "Label of the value list in a specific language.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n",
"maxLength": 255,
"minLength": 0
},
"value-code": {
"type": "string",
"description": "Code of the value",
"maxLength": 255,
"minLength": 0
},
"value-label": {
"type": "string",
"description": "Label of the value",
"maxLength": 255,
"minLength": 0
},
"value-label[xx]": {
"type": "string",
"description": "Label of the value in a specific language.\n\nThe language format can either be:\n- [ISO-639] (E.g. \"[en]\")\n- [ISO-639_ISO-3166] (E.g. \"[en_US]\")\n",
"maxLength": 255,
"minLength": 0
}
},
"required": [
"error-line",
"error-message",
"list-code",
"value-code"
]
},
"VL11_Response_200": {
"type": "object",
"properties": {
"values_lists": {
"type": "array",
"description": "List of values list",
"items": {
"$ref": "#/components/schemas/VL11_Response_200_ValuesLists"
}
}
}
},
"VL11_Response_200_ValuesLists": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Value list code"
},
"label": {
"type": "string",
"description": "Value list label"
},
"label_translations": {
"type": "array",
"description": "Value list translations",
"items": {
"$ref": "#/components/schemas/VL11_Response_200_ValuesLists_LabelTranslations"
}
},
"values": {
"type": "array",
"description": "Value list's of value list",
"items": {
"$ref": "#/components/schemas/VL11_Response_200_ValuesLists_Values"
}
}
},
"required": [
"code",
"label_translations"
]
},
"VL11_Response_200_ValuesLists_LabelTranslations": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "Locale"
},
"value": {
"type": "string",
"description": "Translation"
}
}
},
"VL11_Response_200_ValuesLists_Values": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Value code"
},
"label": {
"type": "string",
"description": "Value label"
},
"label_translations": {
"type": "array",
"description": "Value label translation",
"items": {
"$ref": "#/components/schemas/VL11_Response_200_ValuesLists_Values_LabelTranslations"
}
}
},
"required": [
"code",
"label_translations"
]
},
"VL11_Response_200_ValuesLists_Values_LabelTranslations": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "Locale"
},
"value": {
"type": "string",
"description": "Translation"
}
}
}
},
"securitySchemes": {
"Front-Bearer-Token": {
"bearerFormat": "JWT",
"scheme": "bearer",
"type": "http",
"x-authorization": "{{FRONT_BEARER_TOKEN}}"
},
"OAuth-2": {
"description": "For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partners_integration/authentication_system.htm)",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://auth.mirakl.net/authorize",
"refreshUrl": "https://auth.mirakl.net/oauth/token",
"scopes": {},
"tokenUrl": "https://auth.mirakl.net/oauth/token"
}
},
"type": "oauth2"
}
}
},
"info": {
"description": "{% partial file=\"/partial-content/product/mcm/rest/front/openapi-description.md\" /%}",
"title": "Mirakl Catalog Manager APIs",
"version": ""
},
"openapi": "3.1.0",
"paths": {
"/api/additional_fields": {
"get": {
"description": "This resource supports locale parameter (see documentation)
Localized output fields will be highlighted with an icon:
OFFER, SHOP, ORDER and ORDER_LINE. Ex: OFFER,SHOP.",
"explode": true,
"in": "query",
"name": "entities",
"required": false,
"schema": {
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"application/json-0": {
"summary": "Example with business values (application/json)",
"value": {
"additional_fields": [
{
"code": "ecotax",
"description": "The amount of the price to be collected as Eco tax.",
"entity": "OFFER",
"label": "Eco tax",
"required": false,
"type": "NUMERIC"
},
{
"code": "gift-message",
"description": "Message to send with the order.",
"entity": "ORDER_LINE",
"label": "Gift Message",
"required": false,
"shop_permission": "READ_WRITE",
"type": "STRING"
},
{
"channels": [
"US",
"FR"
],
"code": "customer-care-phone",
"description": "Phone number to contact customer care service.",
"entity": "SHOP",
"label": "Customer care phone number",
"models": [
"MARKETPLACE"
],
"required": false,
"shop_permission": "READ_WRITE",
"type": "STRING"
},
{
"accepted_values": [
"Opt-In",
"Headhunted",
"Contact-Form"
],
"code": "recruitment",
"description": "How the shop has been recruited on the platform.",
"entity": "SHOP",
"label": "Recruitment Method",
"required": false,
"shop_permission": "READ_WRITE",
"type": "LIST"
}
]
}
},
"application/json-auto": {
"summary": "Complete example with value types (application/json)",
"value": {
"additional_fields": [
{
"accepted_values": [
"string"
],
"channels": [
"string"
],
"code": "string",
"default_value": "string",
"description": "string",
"entity": "SHOP",
"label": "string",
"models": [
"MARKETPLACE"
],
"personal_data": true,
"regex": "string",
"required": true,
"shop_permission": "INVISIBLE",
"type": "STRING"
}
],
"total_count": 0
}
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/AF01_Response_200"
}
}
},
"description": "OK"
}
},
"security": [
{
"Front-Bearer-Token": []
},
{
"OAuth-2": []
}
],
"summary": "AF01 - List all custom fields",
"tags": [
"Platform Settings"
]
}
},
"/api/channels": {
"get": {
"description": "This resource supports locale parameter (see documentation)
Localized output fields will be highlighted with an icon:
This resource supports locale parameter (see documentation)
Localized output fields will be highlighted with an icon:
This resource supports locale parameter (see documentation)
Localized output fields will be highlighted with an icon:
ORDER, SHOP. Ex: ORDER,SHOP",
"explode": true,
"in": "query",
"name": "entities",
"required": false,
"schema": {
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"application/json-0": {
"summary": "Example with business values (application/json)",
"value": {
"documents": [
{
"code": "SYSTEM_DELIVERY_BILL",
"description": "Delivery slip",
"entity": "ORDER",
"label": "Delivery slip"
},
{
"code": "CUSTOMER_INVOICE",
"description": "Invoice",
"entity": "ORDER",
"label": "Invoice"
},
{
"code": "LEGAL_DOC",
"description": "Legal documents",
"entity": "SHOP",
"label": "Legal documents",
"models": [
"MARKETPLACE"
]
},
{
"code": "ID_CARD",
"description": "General Manager ID card",
"entity": "SHOP",
"label": "General Manager ID card",
"models": [
"MARKETPLACE"
]
}
]
}
},
"application/json-auto": {
"summary": "Complete example with value types (application/json)",
"value": {
"documents": [
{
"code": "string",
"description": "string",
"entity": "ORDER",
"label": "string",
"mime_types": [
"string"
],
"models": [
"MARKETPLACE"
]
}
]
}
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/DO01_Response_200"
}
}
},
"description": "OK"
}
},
"security": [
{
"Front-Bearer-Token": []
},
{
"OAuth-2": []
}
],
"summary": "DO01 - List all document types",
"tags": [
"Platform Settings"
]
}
},
"/api/hierarchies": {
"get": {
"description": "AI_CONVERTER"
},
"conversion_type": {
"type": "string",
"description": "Product file conversion type. If Catalog Transformer is enabled but the conversionType is not specified, then the default configuration from the shop settings will be used\n\nEnum: `\"AI_CONVERTER\"`, `\"STANDARD\"`\n"
},
"file": {
"type": "string",
"format": "binary",
"description": "Import file (CSV or XML or XLSX) to upload. Use multipart/form-data with name file"
},
"operator_format": {
"type": "boolean",
"default": false,
"description": "Force the use of the operator product format"
},
"shop": {
"type": "integer",
"format": "int64",
"description": "Shop identifier"
}
},
"required": [
"file",
"shop"
]
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"application/json-0": {
"summary": "Example with business values (application/json)",
"value": {
"import_id": 2035
}
},
"application/json-auto": {
"summary": "Complete example with value types (application/json)",
"value": {
"import_id": 0
}
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/P41_Response_201"
}
}
},
"description": "Created",
"headers": {
"Location": {
"description": "Pre-calculated URL to call to get the import status",
"explode": false,
"schema": {},
"style": "simple"
}
}
}
},
"security": [
{
"Front-Bearer-Token": []
},
{
"OAuth-2": []
}
],
"summary": "P41 - Import products to the operator information system",
"tags": [
"Products"
],
"x-codeSamples": [
{
"lang": "cURL",
"source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/products/imports \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'conversion_options=\"{\\\"ai_enrichment\\\":{\\\"status\\\":\\\"ENABLED\\\"},\\\"ai_rewrite\\\":{\\\"status\\\":\\\"ENABLED\\\"},\\\"ai_translation\\\":{\\\"status\\\":\\\"ENABLED\\\"}}\";type=application/json' \\\n -F 'conversion_type=\"\\\"AI_CONVERTER\\\"\";type=application/json' \\\n -F 'file=@path/to/file' \\\n -F 'operator_format=\"true\";type=application/json' \\\n -F 'shop=\"0\";type=application/json'\n"
}
]
},
"get": {
"description": "This resource supports offset pagination (see documentation)
\n\nsort field can have the following values:CANCELLED, WAITING, RUNNING, SENT, COMPLETE, FAILED",
"explode": true,
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"description": "If true returns only product import trackings with transformed file",
"explode": true,
"in": "query",
"name": "has_transformed_file",
"required": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"description": "Shop identifier",
"explode": true,
"in": "query",
"name": "shop_id",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"application/json-0": {
"summary": "Example with business values (application/json)",
"value": {
"product_import_trackings": [
{
"date_created": "2019-04-05T13:13:06Z",
"has_error_report": true,
"has_new_product_report": true,
"has_transformation_error_report": true,
"has_transformed_file": false,
"import_id": 2008,
"import_status": "COMPLETE",
"shop_id": 2000,
"transform_lines_in_error": 5,
"transform_lines_in_success": 0,
"transform_lines_read": 5,
"transform_lines_with_warning": 0
},
{
"date_created": "2019-04-05T13:13:25Z",
"has_error_report": false,
"has_new_product_report": false,
"has_transformation_error_report": false,
"has_transformed_file": true,
"import_id": 2009,
"import_status": "SENT",
"shop_id": 2000,
"transform_lines_in_error": 0,
"transform_lines_in_success": 1,
"transform_lines_read": 1,
"transform_lines_with_warning": 0
}
],
"total_count": 2
}
},
"application/json-auto": {
"summary": "Complete example with value types (application/json)",
"value": {
"product_import_trackings": [
{
"conversion_options": {
"ai_enrichment": {
"status": "ENABLED"
},
"ai_rewrite": {
"status": "ENABLED"
},
"ai_translation": {
"status": "ENABLED"
}
},
"conversion_type": "AI_CONVERTER",
"date_created": "2023-03-28T09:34:42Z",
"has_error_report": true,
"has_new_product_report": true,
"has_transformation_error_report": true,
"has_transformed_file": true,
"import_id": 0,
"import_status": "TRANSFORMATION_WAITING",
"integration_details": {
"invalid_products": 0,
"products_not_accepted_in_time": 0,
"products_not_synchronized_in_time": 0,
"products_reimported": 0,
"products_successfully_synchronized": 0,
"products_with_synchronization_issues": 0,
"products_with_wrong_identifiers": 0,
"rejected_products": 0
},
"reason_status": "string",
"shop_id": 0,
"transform_lines_in_error": 0,
"transform_lines_in_success": 0,
"transform_lines_read": 0,
"transform_lines_with_warning": 0
}
],
"total_count": 0
}
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/P51_Response_200"
}
}
},
"description": "OK"
}
},
"security": [
{
"Front-Bearer-Token": []
},
{
"OAuth-2": []
}
],
"summary": "P51 - Get information about product import statuses",
"tags": [
"Products"
]
}
},
"/api/products/imports/{import}": {
"get": {
"description": "true\" to get only the attributes that have roles.",
"explode": true,
"in": "query",
"name": "with_roles",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"application/json-0": {
"summary": "Example with business values (application/json)",
"value": {
"attributes": [
{
"channels": [
{
"code": "WEBSITE_EN"
}
],
"code": "washingInstructions3",
"default_value": null,
"description": "How do you wash the product",
"description_translations": [
{
"locale": "en",
"value": "How do you wash the product"
}
],
"example": null,
"hierarchy_code": "3012",
"label": "Washing Instructions",
"label_translations": [
{
"locale": "en",
"value": "Washing Instructions"
}
],
"locale": "en_US",
"requirement_level": "OPTIONAL",
"roles": [],
"transformations": "CAMEL_CASE",
"type": "TEXT",
"type_parameter": null,
"validations": "MIN_LENGTH|10",
"variant": false
},
{
"channels": [
{
"code": "WEBSITE_FR"
},
{
"code": "WEBSITE_EN"
}
],
"code": "toolsIncluded3",
"default_value": null,
"description": "Are tools included for the assembly of this product",
"description_translations": [
{
"locale": "en",
"value": "Are tools included for the assembly of this product"
}
],
"example": null,
"hierarchy_code": "5610102",
"label": "Tools Included",
"label_translations": [
{
"locale": "en",
"value": "Tools Included"
}
],
"requirement_level": "OPTIONAL",
"roles": [],
"type": "LIST",
"type_parameter": "Boolean",
"variant": false
}
]
}
},
"application/json-auto": {
"summary": "Complete example with value types (application/json)",
"value": {
"attributes": [
{
"channels": [
{
"code": "string"
}
],
"code": "string",
"default_value": "string",
"description": "string",
"description_translations": [
{
"locale": "string",
"value": "string"
}
],
"example": "string",
"hierarchy_code": "string",
"label": "string",
"label_translations": [
{
"locale": "string",
"value": "string"
}
],
"locale": "string",
"required": true,
"requirement_level": "OPTIONAL",
"roles": [
{
"parameters": [
{
"name": "string",
"value": "string"
}
],
"type": "string"
}
],
"transformations": "string",
"type": "string",
"type_parameter": "string",
"type_parameters": [
{
"name": "string",
"value": "string"
}
],
"unique_code": "string",
"validations": "string",
"values": [
{
"code": "string"
}
],
"values_list": "string",
"variant": true
}
]
}
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/PM11_Response_200"
}
},
"text/csv": {
"examples": {
"text/csv-1": {
"summary": "Example with business values (text/csv)",
"value": "code;label;label[en];hierarchy-code;description;description[en];example;requirement-level;type;type-parameter;variant;default-value;transformations;validations;roles;type-parameters;channels;locale\nwashingInstructions3;Washing Instructions;Washing Instructions;3012;How do you wash the product;How do you wash the product;;OPTIONAL;TEXT;;false;;CAMEL_CASE;MIN_LENGTH|10;;;WEBSITE_EN;en_US\ntoolsIncluded3;Tools Included;Tools Included;5610102;Are tools included for the assembly of this product;Are tools included for the assembly of this product;;OPTIONAL;LIST;Boolean;false;;;;;LIST_CODE|Boolean;WEBSITE_FR,WEBSITE_EN;\n"
},
"text/csv-auto": {
"summary": "Complete example with value types (text/csv)",
"value": "string"
}
},
"schema": {
"type": "object",
"format": "binary",
"$ref": "#/components/schemas/PM11_Response_200_TextCsv_Ext_FileStructure"
}
}
},
"description": "Export success"
}
},
"security": [
{
"Front-Bearer-Token": []
},
{
"OAuth-2": []
}
],
"summary": "PM11 - Get the product attribute configuration",
"tags": [
"Products"
]
}
},
"/api/users/shops/roles": {
"get": {
"description": "shop_ids, updated_since\n\nshop_ids or the document_ids.When documents are retrieved, they're wrapped into a ZIP archive except when only one document id is specified. The tree structure of this archive is as follow:
\ndocuments-timestamp.zip\n|\n|__ shop_id_x/\n| |__ foo.txt\n| |__ bar.txt\n| |__ baz.pdf\n|\n|__ shop_id_y/\n| |__ image.png\n| |__ image(1).png\n
Returns a 404 if at least one document id, one shop id or one document type code is invalid
shop_ids or the document_ids",
"explode": true,
"in": "query",
"name": "shop_ids",
"required": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"description": "A list of document identifiers (separated by a comma). It is mandatory to specify either the shop_ids or the document_ids",
"explode": true,
"in": "query",
"name": "document_ids",
"required": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"description": "A list of document type codes (separated by a comma)",
"explode": true,
"in": "query",
"name": "type_codes",
"required": false,
"schema": {
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/octet-stream": {
"examples": {
"application/octet-stream-auto": {
"summary": "Complete example with value types (application/octet-stream)",
"value": "string"
}
},
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": "OK"
}
},
"security": [
{
"Front-Bearer-Token": []
},
{
"OAuth-2": []
}
],
"summary": "S31 - Download documents for one or multiple shops",
"tags": [
"Stores"
]
}
},
"/api/shops/documents/{document_id}": {
"delete": {
"description": "