{
"components" : {
"schemas" : {
"DeleteProductBindings_Request" : {
"type" : "object",
"description" : "Request to delete product bindings",
"properties" : {
"entries" : {
"type" : "array",
"description" : "The entries to delete",
"items" : {
"$ref" : "#/components/schemas/DeleteProductBindings_Request_Entries"
}
}
}
},
"DeleteProductBindings_Request_Entries" : {
"type" : "object",
"description" : "A delete instruction for a product binding",
"properties" : {
"identifierType" : {
"type" : "string",
"description" : "The type of identifier used to find the binding to delete"
},
"value" : {
"type" : "string",
"description" : "The value of the identifier"
}
}
},
"DeleteProductBindings_Response_200" : {
"type" : "object",
"description" : "Response from deleting product bindings",
"properties" : {
"deletedBaseProducts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of base product bindings deleted"
},
"deletedVariants" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of variant bindings deleted"
},
"errors" : {
"type" : "array",
"description" : "Errors that occurred during deletion",
"items" : {
"$ref" : "#/components/schemas/DeleteProductBindings_Response_200_Errors"
}
}
}
},
"DeleteProductBindings_Response_200_Errors" : {
"type" : "object",
"description" : "An error that occurred during product binding deletion",
"properties" : {
"identifierType" : {
"type" : "string",
"description" : "The identifier type of the entry that caused the error"
},
"message" : {
"type" : "string",
"description" : "The error message"
},
"value" : {
"type" : "string",
"description" : "The identifier value"
}
}
},
"GetConnection_Response_200" : {
"type" : "object",
"description" : "Environment response",
"properties" : {
"createdAt" : {
"type" : "string",
"format" : "date-time",
"description" : "The creation date of the environment"
},
"enabled" : {
"type" : "boolean",
"description" : "Enabled status of the environment"
},
"id" : {
"type" : "string",
"description" : "Unique identifier for the environment"
},
"miraklApiEndpoint" : {
"type" : "string",
"description" : "Mirakl API endpoint"
},
"miraklTenant" : {
"type" : "string",
"description" : "The Mirakl tenant identifier"
},
"shopifyShopDomain" : {
"type" : "string",
"description" : "The domain of the Shopify shop"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time",
"description" : "The last update date of the environment"
}
}
},
"GetCustomCarrierRates_Request" : {
"type" : "object",
"properties" : {
"rate" : {
"$ref" : "#/components/schemas/GetCustomCarrierRates_Request_Rate",
"description" : "Shipping rate request"
}
}
},
"GetCustomCarrierRates_Request_Rate" : {
"type" : "object",
"description" : "Shipping rate request",
"properties" : {
"currency" : {
"type" : "string",
"description" : "Currency of the shipment"
},
"destination" : {
"$ref" : "#/components/schemas/GetCustomCarrierRates_Request_Rate_Destination",
"description" : "Destination address of the shipment"
},
"items" : {
"type" : "array",
"description" : "Items in the shipment",
"items" : {
"$ref" : "#/components/schemas/GetCustomCarrierRates_Request_Rate_Items"
}
},
"locale" : {
"type" : "string",
"description" : "Locale of the shipment"
},
"origin" : {
"$ref" : "#/components/schemas/GetCustomCarrierRates_Request_Rate_Origin",
"description" : "Origin address of the shipment"
}
}
},
"GetCustomCarrierRates_Request_Rate_Destination" : {
"type" : "object",
"description" : "Destination address of the shipment",
"properties" : {
"address1" : {
"type" : "string",
"description" : "The first line of the address"
},
"address2" : {
"type" : "string",
"description" : "The second line of the address"
},
"city" : {
"type" : "string",
"description" : "The city"
},
"country" : {
"type" : "string",
"description" : "The country"
},
"email" : {
"type" : "string",
"description" : "The email"
},
"latitude" : {
"type" : "string",
"description" : "The latitude"
},
"longitude" : {
"type" : "string",
"description" : "The longitude"
},
"name" : {
"type" : "string",
"description" : "The address name"
},
"phone" : {
"type" : "string",
"description" : "The phone number"
},
"postalCode" : {
"type" : "string",
"description" : "The postal code"
},
"province" : {
"type" : "string",
"description" : "The province"
}
}
},
"GetCustomCarrierRates_Request_Rate_Items" : {
"type" : "object",
"description" : "Items in the shipment",
"properties" : {
"fulfillmentService" : {
"type" : "string",
"description" : "The fulfillment service"
},
"grams" : {
"type" : "integer",
"format" : "int32",
"description" : "The weight of the item in grams"
},
"name" : {
"type" : "string",
"description" : "The name of the item"
},
"price" : {
"type" : "integer",
"format" : "int32",
"description" : "The price of the item (x100)"
},
"productId" : {
"type" : "string",
"description" : "The product ID"
},
"properties" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
},
"description" : "Custom attributes of the item"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The quantity of the item"
},
"requiresShipping" : {
"type" : "boolean",
"description" : "If the item requires shipping"
},
"sku" : {
"type" : "string",
"description" : "The SKU of the item"
},
"taxable" : {
"type" : "boolean",
"description" : "If the item is taxable"
},
"variantId" : {
"type" : "string",
"description" : "The variant ID"
},
"vendor" : {
"type" : "string",
"description" : "The vendor of the item"
}
}
},
"GetCustomCarrierRates_Request_Rate_Origin" : {
"type" : "object",
"description" : "Destination address of the shipment",
"properties" : {
"address1" : {
"type" : "string",
"description" : "The first line of the address"
},
"address2" : {
"type" : "string",
"description" : "The second line of the address"
},
"city" : {
"type" : "string",
"description" : "The city"
},
"country" : {
"type" : "string",
"description" : "The country"
},
"email" : {
"type" : "string",
"description" : "The email"
},
"latitude" : {
"type" : "string",
"description" : "The latitude"
},
"longitude" : {
"type" : "string",
"description" : "The longitude"
},
"name" : {
"type" : "string",
"description" : "The address name"
},
"phone" : {
"type" : "string",
"description" : "The phone number"
},
"postalCode" : {
"type" : "string",
"description" : "The postal code"
},
"province" : {
"type" : "string",
"description" : "The province"
}
}
},
"GetCustomCarrierRates_Response_200" : {
"type" : "object",
"properties" : {
"rates" : {
"type" : "array",
"description" : "Shipping rates response",
"items" : {
"$ref" : "#/components/schemas/GetCustomCarrierRates_Response_200_Rates"
}
}
}
},
"GetCustomCarrierRates_Response_200_Rates" : {
"type" : "object",
"properties" : {
"currency" : {
"type" : "string",
"description" : "The currency of the shipment with this carrier"
},
"description" : {
"type" : "string",
"description" : "The description of the carrier"
},
"serviceCode" : {
"type" : "string",
"description" : "The code of the carrier"
},
"serviceName" : {
"type" : "string",
"description" : "The name of the carrier"
},
"totalPrice" : {
"type" : "integer",
"format" : "int32",
"description" : "The total price of the shipment with this carrier"
}
}
},
"GetEvaluationsAssessments_Response_200" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Assessment code"
},
"label" : {
"type" : "string",
"description" : "Assessment label"
},
"type" : {
"type" : "string",
"description" : "Assessment type"
}
}
},
"GetItemsToReturn_Response_200" : {
"type" : "object",
"description" : "Items available for return",
"properties" : {
"itemsToReturn" : {
"type" : "array",
"description" : "List of items available for return",
"items" : {
"$ref" : "#/components/schemas/GetItemsToReturn_Response_200_ItemsToReturn"
}
}
}
},
"GetItemsToReturn_Response_200_ItemsToReturn" : {
"type" : "object",
"description" : "Item available for return",
"properties" : {
"availableReturnMethods" : {
"type" : "array",
"description" : "Available return methods to return items",
"items" : {
"type" : "string"
}
},
"availableReturnReasons" : {
"type" : "array",
"description" : "Available return reasons to return items",
"items" : {
"type" : "string"
}
},
"orderCommercialId" : {
"type" : "string",
"description" : "Order commercial id"
},
"orderLineId" : {
"type" : "string",
"description" : "Order line id"
},
"returnWindow" : {
"type" : "integer",
"format" : "int32",
"description" : "Items must be returned during the return window"
},
"returnableQuantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Item quantity available to be returned"
}
}
},
"GetOfferRecoverableError_Response_200" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/GetOfferRecoverableError_Response_200_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"GetOfferRecoverableError_Response_200_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"GetOperatorReturnConfigurations_Response_200" : {
"type" : "object",
"description" : "Configuration for returns for an operator",
"properties" : {
"configurations" : {
"type" : "array",
"description" : "Operator returns' configuration",
"items" : {
"$ref" : "#/components/schemas/GetOperatorReturnConfigurations_Response_200_Configurations"
}
}
}
},
"GetOperatorReturnConfigurations_Response_200_Configurations" : {
"type" : "object",
"description" : "Configuration for returns for an operator",
"properties" : {
"availableRejectionReasons" : {
"type" : "array",
"description" : "Available rejection reasons",
"items" : {
"type" : "string"
}
},
"availableReturnMethods" : {
"type" : "array",
"description" : "Available return methods",
"items" : {
"type" : "string"
}
},
"availableReturnReasons" : {
"type" : "array",
"description" : "Available return reasons",
"items" : {
"type" : "string"
}
},
"enabled" : {
"type" : "boolean",
"description" : "The 'Returns' feature is activated on a platform model"
},
"handler" : {
"type" : "string",
"description" : "Determine who is responsible to handle returns"
},
"platformModel" : {
"type" : "string",
"description" : "Platform model"
},
"returnAddress" : {
"$ref" : "#/components/schemas/GetOperatorReturnConfigurations_Response_200_Configurations_ReturnAddress",
"description" : "Return address"
},
"returnPolicy" : {
"type" : "string",
"description" : "Return policy"
},
"returnWindow" : {
"type" : "integer",
"format" : "int32",
"description" : "Return window in days"
},
"shopsCanOverrideReturnMethod" : {
"type" : "boolean",
"description" : "Shops can override return methods"
},
"shopsCanOverrideReturnPolicy" : {
"type" : "boolean",
"description" : "Shops can override the return policy"
}
}
},
"GetOperatorReturnConfigurations_Response_200_Configurations_ReturnAddress" : {
"type" : "object",
"description" : "Return address",
"properties" : {
"city" : {
"type" : "string",
"description" : "City"
},
"countryIsoCode" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State"
},
"street1" : {
"type" : "string",
"description" : "First line of the return address"
},
"street2" : {
"type" : "string",
"description" : "Second line of the return address"
},
"zipCode" : {
"type" : "string",
"description" : "Zip code"
}
}
},
"GetOrderRecoverableError_Response_200" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/GetOrderRecoverableError_Response_200_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"GetOrderRecoverableError_Response_200_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"GetProductRecoverableError_Response_200" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/GetProductRecoverableError_Response_200_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"GetProductRecoverableError_Response_200_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"GetReturnRecoverableError_Response_200" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/GetReturnRecoverableError_Response_200_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"GetReturnRecoverableError_Response_200_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"GetReturns_Response_200" : {
"type" : "object",
"description" : "List of returns",
"properties" : {
"returns" : {
"type" : "array",
"description" : "List of returns",
"items" : {
"$ref" : "#/components/schemas/GetReturns_Response_200_Returns"
}
}
}
},
"GetReturns_Response_200_Returns" : {
"type" : "object",
"description" : "Return details",
"properties" : {
"dateCreated" : {
"type" : "string",
"format" : "date-time",
"description" : "Return creation date"
},
"description" : {
"type" : "string",
"description" : "Description"
},
"documents" : {
"type" : "array",
"description" : "Return documents",
"items" : {
"$ref" : "#/components/schemas/GetReturns_Response_200_Returns_Documents"
}
},
"id" : {
"type" : "string",
"description" : "Return id"
},
"labelUrl" : {
"type" : "string",
"description" : "Label URL"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time",
"description" : "Return last updated date"
},
"methodCode" : {
"type" : "string",
"description" : "Return method code"
},
"orderCommercialId" : {
"type" : "string",
"description" : "Order commercial id"
},
"orderId" : {
"type" : "string",
"description" : "Order id"
},
"reasonCode" : {
"type" : "string",
"description" : "Return reason code"
},
"rejectionReasonCode" : {
"type" : "string",
"description" : "Return rejection reason code"
},
"returnAddress" : {
"$ref" : "#/components/schemas/GetReturns_Response_200_Returns_ReturnAddress",
"description" : "The address where items must be returned"
},
"returnLines" : {
"type" : "array",
"description" : "Return lines",
"items" : {
"$ref" : "#/components/schemas/GetReturns_Response_200_Returns_ReturnLines"
}
},
"rma" : {
"type" : "string",
"description" : "Return RMA"
},
"state" : {
"type" : "string",
"description" : "Return state"
},
"tracking" : {
"$ref" : "#/components/schemas/GetReturns_Response_200_Returns_Tracking",
"description" : "Return tracking details"
}
}
},
"GetReturns_Response_200_Returns_Documents" : {
"type" : "object",
"description" : "Return document",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32",
"description" : "Return document id"
},
"type" : {
"type" : "string",
"description" : "Return document type"
}
}
},
"GetReturns_Response_200_Returns_ReturnAddress" : {
"type" : "object",
"description" : "Return address",
"properties" : {
"city" : {
"type" : "string",
"description" : "City"
},
"countryIsoCode" : {
"type" : "string",
"description" : "Country ISO code"
},
"state" : {
"type" : "string",
"description" : "State"
},
"street1" : {
"type" : "string",
"description" : "First line of the return address"
},
"street2" : {
"type" : "string",
"description" : "Second line of the return address"
},
"zipCode" : {
"type" : "string",
"description" : "Zip code"
}
}
},
"GetReturns_Response_200_Returns_ReturnLines" : {
"type" : "object",
"description" : "Return line details",
"properties" : {
"compliance" : {
"type" : "array",
"description" : "Compliance",
"items" : {
"$ref" : "#/components/schemas/GetReturns_Response_200_Returns_ReturnLines_Compliance"
}
},
"orderLineId" : {
"type" : "string",
"description" : "Order line id"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity"
}
}
},
"GetReturns_Response_200_Returns_ReturnLines_Compliance" : {
"type" : "object",
"description" : "Return line compliance details",
"properties" : {
"compliant" : {
"type" : "boolean",
"description" : "Compliant"
},
"nonCompliantAdditionalInfo" : {
"type" : "string",
"description" : "Non compliance additional info"
},
"nonCompliantReasonCode" : {
"type" : "string",
"description" : "Non compliance reason code"
}
}
},
"GetReturns_Response_200_Returns_Tracking" : {
"type" : "object",
"description" : "Return tracking details",
"properties" : {
"carrierCode" : {
"type" : "string",
"description" : "Carrier code"
},
"carrierName" : {
"type" : "string",
"description" : "Carrier name"
},
"carrierStandardCode" : {
"type" : "string",
"description" : "Carrier standard code"
},
"trackingNumber" : {
"type" : "string",
"description" : "Tracking number"
},
"trackingUrl" : {
"type" : "string",
"description" : "Return tracking URL"
}
}
},
"GetShipmentRecoverableError_Response_200" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/GetShipmentRecoverableError_Response_200_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"GetShipmentRecoverableError_Response_200_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"GetShipment_Response_200" : {
"type" : "object",
"properties" : {
"canMarkAsReceived" : {
"type" : "boolean",
"description" : "Boolean indicating if the shipment can be marked as received"
},
"logisticOrderId" : {
"type" : "string",
"description" : "The logistic order ID"
},
"miraklShipmentId" : {
"type" : "string",
"description" : "The Mirakl shipment ID"
},
"shopifyFulfillmentId" : {
"type" : "string",
"description" : "The shopify fulfillment ID"
},
"status" : {
"type" : "string",
"description" : "The Mirakl status of the shipment"
}
}
},
"GetShippingFees_Request" : {
"type" : "object",
"description" : "Request object to retrieve shipping fees",
"properties" : {
"cart_lines" : {
"type" : "array",
"description" : "A list of lines containing information about the items the customer intends to purchase",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines"
}
},
"locale" : {
"type" : "string",
"description" : "The locale of the customer. Must be an activated locale in Mirakl. (optional)"
},
"shipping_address" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_ShippingAddress",
"description" : "The proposed customer shipping address. An address value is only present if delivery is required"
}
}
},
"GetShippingFees_Request_CartLines" : {
"type" : "object",
"description" : "The line containing information about the items the customer intends to purchase",
"properties" : {
"attributes" : {
"type" : "array",
"description" : "The line item additional custom attributes",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_Attributes"
}
},
"cost" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_Cost",
"description" : "The details about the cost components attributed to the cart line"
},
"discount_allocations" : {
"type" : "array",
"description" : "Discounts applied to the cart line",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_DiscountAllocations"
}
},
"id" : {
"type" : "string",
"description" : "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to applyCartLinesChange because you'll need the ID to create a CartLineChange object"
},
"line_components" : {
"type" : "array",
"description" : "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_LineComponents"
}
},
"merchandise" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_Merchandise",
"description" : "The merchandise being purchased"
},
"quantity" : {
"type" : "number",
"format" : "double",
"description" : "The quantity of the merchandise being purchased"
}
}
},
"GetShippingFees_Request_CartLines_Attributes" : {
"type" : "object",
"description" : "The custom attribute",
"properties" : {
"key" : {
"type" : "string",
"description" : "The key for the attribute"
},
"value" : {
"type" : "string",
"description" : "The value for the attribute"
}
}
},
"GetShippingFees_Request_CartLines_Cost" : {
"type" : "object",
"description" : "The details about the cost components attributed to the cart line",
"properties" : {
"total_amount" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_Cost_TotalAmount",
"description" : "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line"
}
}
},
"GetShippingFees_Request_CartLines_Cost_TotalAmount" : {
"type" : "object",
"description" : "The monetary value with currency",
"properties" : {
"amount" : {
"type" : "number",
"format" : "double",
"description" : "The price amount"
},
"currency_code" : {
"type" : "string",
"description" : "The ISO 4217 format for the currency"
}
}
},
"GetShippingFees_Request_CartLines_DiscountAllocations" : {
"type" : "object",
"description" : "The discounts applied to the cart line",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code for the discount"
},
"discounted_amount" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_DiscountAllocations_DiscountedAmount",
"description" : "The money amount that has been discounted from the order"
},
"title" : {
"type" : "string",
"description" : "The title of the discount"
},
"type" : {
"type" : "string",
"description" : "The type of the discount"
}
}
},
"GetShippingFees_Request_CartLines_DiscountAllocations_DiscountedAmount" : {
"type" : "object",
"description" : "The monetary value with currency",
"properties" : {
"amount" : {
"type" : "number",
"format" : "double",
"description" : "The price amount"
},
"currency_code" : {
"type" : "string",
"description" : "The ISO 4217 format for the currency"
}
}
},
"GetShippingFees_Request_CartLines_LineComponents" : {
"type" : "object",
"description" : "The sub lines of the merchandise line",
"properties" : {
"attributes" : {
"type" : "array",
"description" : "Additional custom attributes for the bundle line component",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_LineComponents_Attributes"
}
},
"cost" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_LineComponents_Cost",
"description" : "The cost attributed to this bundle line component"
},
"id" : {
"type" : "string",
"description" : "A unique identifier for the bundle line component. This ID is not stable. If an operation updates the line items in any way, all IDs could change"
},
"merchandise" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_LineComponents_Merchandise",
"description" : "The merchandise of this bundle line component"
},
"quantity" : {
"type" : "number",
"format" : "double",
"description" : "The quantity of merchandise being purchased"
},
"type" : {
"type" : "string",
"description" : "Always \"bundle\""
}
}
},
"GetShippingFees_Request_CartLines_LineComponents_Attributes" : {
"type" : "object",
"description" : "The custom attribute",
"properties" : {
"key" : {
"type" : "string",
"description" : "The key for the attribute"
},
"value" : {
"type" : "string",
"description" : "The value for the attribute"
}
}
},
"GetShippingFees_Request_CartLines_LineComponents_Cost" : {
"type" : "object",
"description" : "The details about the cost components attributed to the cart line",
"properties" : {
"total_amount" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_LineComponents_Cost_TotalAmount",
"description" : "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line"
}
}
},
"GetShippingFees_Request_CartLines_LineComponents_Cost_TotalAmount" : {
"type" : "object",
"description" : "The monetary value with currency",
"properties" : {
"amount" : {
"type" : "number",
"format" : "double",
"description" : "The price amount"
},
"currency_code" : {
"type" : "string",
"description" : "The ISO 4217 format for the currency"
}
}
},
"GetShippingFees_Request_CartLines_LineComponents_Merchandise" : {
"type" : "object",
"description" : "The merchandise",
"properties" : {
"id" : {
"type" : "string",
"description" : "A globally-unique identifier"
},
"image" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_LineComponents_Merchandise_Image",
"description" : "Image associated with the product variant. This field falls back to the product image if no image is available"
},
"product" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_LineComponents_Merchandise_Product",
"description" : "The product object that the product variant belongs to"
},
"requires_shipping" : {
"type" : "boolean",
"description" : "Whether or not the product requires shipping"
},
"selected_options" : {
"type" : "array",
"description" : "List of product options applied to the variant",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_LineComponents_Merchandise_SelectedOptions"
}
},
"selling_plan" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_LineComponents_Merchandise_SellingPlan",
"description" : "The selling plan associated with the merchandise"
},
"sku" : {
"type" : "string",
"description" : "The product variant's sku"
},
"subtitle" : {
"type" : "string",
"description" : "The product variant's subtitle"
},
"title" : {
"type" : "string",
"description" : "The product variant’s title"
},
"type" : {
"type" : "string",
"description" : "Always \"variant\""
}
}
},
"GetShippingFees_Request_CartLines_LineComponents_Merchandise_Image" : {
"type" : "object",
"description" : "The image details",
"properties" : {
"alt_text" : {
"type" : "string",
"description" : "The alternative text for the image"
},
"url" : {
"type" : "string",
"description" : "The image URL"
}
}
},
"GetShippingFees_Request_CartLines_LineComponents_Merchandise_Product" : {
"type" : "object",
"description" : "The product object",
"properties" : {
"id" : {
"type" : "string",
"description" : "A globally-unique identifier"
},
"product_type" : {
"type" : "string",
"description" : "A categorization that a product can be tagged with, commonly used for filtering and searching"
},
"vendor" : {
"type" : "string",
"description" : "The product’s vendor name"
}
}
},
"GetShippingFees_Request_CartLines_LineComponents_Merchandise_SelectedOptions" : {
"type" : "object",
"description" : "A product option applied to the variant",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the merchandise option"
},
"value" : {
"type" : "string",
"description" : "The value of the merchandise option"
}
}
},
"GetShippingFees_Request_CartLines_LineComponents_Merchandise_SellingPlan" : {
"type" : "object",
"description" : "The selling plan",
"properties" : {
"id" : {
"type" : "string",
"description" : "A globally-unique identifier"
}
}
},
"GetShippingFees_Request_CartLines_Merchandise" : {
"type" : "object",
"description" : "The merchandise",
"properties" : {
"id" : {
"type" : "string",
"description" : "A globally-unique identifier"
},
"image" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_Merchandise_Image",
"description" : "Image associated with the product variant. This field falls back to the product image if no image is available"
},
"product" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_Merchandise_Product",
"description" : "The product object that the product variant belongs to"
},
"requires_shipping" : {
"type" : "boolean",
"description" : "Whether or not the product requires shipping"
},
"selected_options" : {
"type" : "array",
"description" : "List of product options applied to the variant",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_Merchandise_SelectedOptions"
}
},
"selling_plan" : {
"$ref" : "#/components/schemas/GetShippingFees_Request_CartLines_Merchandise_SellingPlan",
"description" : "The selling plan associated with the merchandise"
},
"sku" : {
"type" : "string",
"description" : "The product variant's sku"
},
"subtitle" : {
"type" : "string",
"description" : "The product variant's subtitle"
},
"title" : {
"type" : "string",
"description" : "The product variant’s title"
},
"type" : {
"type" : "string",
"description" : "Always \"variant\""
}
}
},
"GetShippingFees_Request_CartLines_Merchandise_Image" : {
"type" : "object",
"description" : "The image details",
"properties" : {
"alt_text" : {
"type" : "string",
"description" : "The alternative text for the image"
},
"url" : {
"type" : "string",
"description" : "The image URL"
}
}
},
"GetShippingFees_Request_CartLines_Merchandise_Product" : {
"type" : "object",
"description" : "The product object",
"properties" : {
"id" : {
"type" : "string",
"description" : "A globally-unique identifier"
},
"product_type" : {
"type" : "string",
"description" : "A categorization that a product can be tagged with, commonly used for filtering and searching"
},
"vendor" : {
"type" : "string",
"description" : "The product’s vendor name"
}
}
},
"GetShippingFees_Request_CartLines_Merchandise_SelectedOptions" : {
"type" : "object",
"description" : "A product option applied to the variant",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the merchandise option"
},
"value" : {
"type" : "string",
"description" : "The value of the merchandise option"
}
}
},
"GetShippingFees_Request_CartLines_Merchandise_SellingPlan" : {
"type" : "object",
"description" : "The selling plan",
"properties" : {
"id" : {
"type" : "string",
"description" : "A globally-unique identifier"
}
}
},
"GetShippingFees_Request_ShippingAddress" : {
"type" : "object",
"description" : "The shipping address",
"properties" : {
"address1" : {
"type" : "string",
"description" : "The first line of the buyer's address, including street name and number"
},
"address2" : {
"type" : "string",
"description" : "The second line of the buyer's address, like apartment number, suite, etc"
},
"city" : {
"type" : "string",
"description" : "The buyer's city"
},
"company" : {
"type" : "string",
"description" : "The buyer's company name"
},
"country_code" : {
"type" : "string",
"description" : "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html"
},
"first_name" : {
"type" : "string",
"description" : "The buyer's first name"
},
"last_name" : {
"type" : "string",
"description" : "The buyer's last name"
},
"name" : {
"type" : "string",
"description" : "The buyer's full name"
},
"one_time_use" : {
"type" : "boolean",
"description" : "Specifies whether the address should be saved to the buyer's account"
},
"phone" : {
"type" : "string",
"description" : "The buyer's phone number"
},
"province_code" : {
"type" : "string",
"description" : "The buyer's province code, such as state, province, prefecture, or region"
},
"zip" : {
"type" : "string",
"description" : "The buyer's postal or ZIP code"
}
}
},
"GetShippingFees_Response_200" : {
"type" : "object",
"description" : "Shipping charges per seller",
"properties" : {
"errors" : {
"type" : "array",
"description" : "Errors",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Response_200_Errors"
}
},
"fees" : {
"type" : "array",
"description" : "Seller fees",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Response_200_Fees"
}
}
}
},
"GetShippingFees_Response_200_Errors" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The error code. One of: SHIPPING_ZONE_NOT_ALLOWED, SHIPPING_TYPE_NOT_ALLOWED, OFFER_NOT_FOUND, INSUFFICIENT_QUANTITY"
},
"offer_id" : {
"type" : "string",
"description" : "The offer identifier"
}
}
},
"GetShippingFees_Response_200_Fees" : {
"type" : "object",
"description" : "Shipping charges per seller",
"properties" : {
"choices" : {
"type" : "array",
"description" : "List of Shipping methods",
"items" : {
"$ref" : "#/components/schemas/GetShippingFees_Response_200_Fees_Choices"
}
},
"offer_ids" : {
"type" : "array",
"description" : "List of offer identifiers",
"items" : {
"type" : "string"
}
},
"selected_method" : {
"type" : "string",
"description" : "Selected Shipping method"
},
"seller_id" : {
"type" : "string",
"description" : "Shop identifier"
},
"seller_name" : {
"type" : "string",
"description" : "Shop name"
}
}
},
"GetShippingFees_Response_200_Fees_Choices" : {
"type" : "object",
"description" : "Shipping method",
"properties" : {
"code" : {
"type" : "string",
"description" : "Shipping method code"
},
"currency_iso_code" : {
"type" : "string",
"description" : "Shipping method currency ISO code"
},
"delivery_estimate" : {
"$ref" : "#/components/schemas/GetShippingFees_Response_200_Fees_Choices_DeliveryEstimate",
"description" : "Shipping method delivery estimate"
},
"label" : {
"type" : "string",
"description" : "Shipping method label"
},
"price" : {
"type" : "number",
"description" : "Shipping method price"
}
}
},
"GetShippingFees_Response_200_Fees_Choices_DeliveryEstimate" : {
"type" : "object",
"description" : "Expected delivery time",
"properties" : {
"earliest_days" : {
"type" : "integer",
"format" : "int32",
"description" : "Earliest delivery time"
},
"earliest_delivery_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Earliest delivery date"
},
"latest_days" : {
"type" : "integer",
"format" : "int32",
"description" : "Latest delivery time"
},
"latest_delivery_date" : {
"type" : "string",
"format" : "date-time",
"description" : "Latest delivery date"
}
}
},
"GetShopRecoverableError_Response_200" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/GetShopRecoverableError_Response_200_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"GetShopRecoverableError_Response_200_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"ImportProductBindings_Request" : {
"type" : "object",
"description" : "Request to import product bindings",
"properties" : {
"products" : {
"type" : "array",
"description" : "The products to import",
"items" : {
"$ref" : "#/components/schemas/ImportProductBindings_Request_Products"
}
}
}
},
"ImportProductBindings_Request_Products" : {
"type" : "object",
"description" : "A product and its variants to import as product bindings",
"properties" : {
"operatorManaged" : {
"type" : "boolean",
"description" : "Whether the product/variant is operator-managed. Defaults to true when not specified"
},
"shopifyProductGid" : {
"type" : "string",
"description" : "The Shopify GID of the product"
},
"variantGroupCode" : {
"type" : "string",
"description" : "The variant group code linking variants to their parent product"
},
"variants" : {
"type" : "array",
"description" : "The variants of this product",
"items" : {
"$ref" : "#/components/schemas/ImportProductBindings_Request_Products_Variants"
}
}
}
},
"ImportProductBindings_Request_Products_Variants" : {
"type" : "object",
"description" : "A variant to import as a variant binding",
"properties" : {
"inventoryItemGid" : {
"type" : "string",
"description" : "The Shopify GID of the inventory item"
},
"operatorManaged" : {
"type" : "boolean",
"description" : "Whether the variant is operator-managed. Defaults to true when not specified"
},
"shopifyVariantGid" : {
"type" : "string",
"description" : "The Shopify GID of the product variant"
},
"sku" : {
"type" : "string",
"description" : "The SKU of the variant in Mirakl"
}
}
},
"ImportProductBindings_Response_200" : {
"type" : "object",
"description" : "Response from importing product bindings",
"properties" : {
"createdBaseProducts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of base product bindings created"
},
"createdVariants" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of variant bindings created"
},
"errors" : {
"type" : "array",
"description" : "Errors that occurred during import",
"items" : {
"$ref" : "#/components/schemas/ImportProductBindings_Response_200_Errors"
}
}
}
},
"ImportProductBindings_Response_200_Errors" : {
"type" : "object",
"description" : "An error that occurred during product binding import",
"properties" : {
"message" : {
"type" : "string",
"description" : "The error message"
},
"shopifyProductGid" : {
"type" : "string",
"description" : "The Shopify GID of the product that caused the error"
},
"shopifyVariantGid" : {
"type" : "string",
"description" : "The Shopify GID of the product variant that caused the error, null for base product-level errors"
},
"sku" : {
"type" : "string",
"description" : "The SKU that caused the error, null for base product-level errors"
},
"variantGroupCode" : {
"type" : "string",
"description" : "The variant group code of the product entry that caused the error"
}
}
},
"ListAccountingOrdersDocuments_Response_200" : {
"type" : "object",
"properties" : {
"documents" : {
"type" : "array",
"description" : "List of order documents",
"items" : {
"$ref" : "#/components/schemas/ListAccountingOrdersDocuments_Response_200_Documents"
}
}
}
},
"ListAccountingOrdersDocuments_Response_200_Documents" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"description" : "The file name of the document"
},
"id" : {
"type" : "string",
"description" : "Unique identifier for the document"
},
"type" : {
"type" : "string",
"description" : "Document type as defined in Mirakl document type configuration"
},
"uploadedDate" : {
"type" : "string",
"format" : "date-time",
"description" : "The uploaded date of the document"
},
"url" : {
"type" : "string",
"description" : "Secure download URL for the document. This URL includes a unique hash for security, and is generated specifically for the document."
}
}
},
"ListOfferRecoverableErrors_Response_200" : {
"type" : "object",
"description" : "Response representing all the recoverable error details",
"properties" : {
"recoverableErrors" : {
"type" : "array",
"description" : "List of recoverable error details",
"items" : {
"$ref" : "#/components/schemas/ListOfferRecoverableErrors_Response_200_RecoverableErrors"
}
}
}
},
"ListOfferRecoverableErrors_Response_200_RecoverableErrors" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/ListOfferRecoverableErrors_Response_200_RecoverableErrors_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"ListOfferRecoverableErrors_Response_200_RecoverableErrors_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"ListOrderRecoverableErrors_Response_200" : {
"type" : "object",
"description" : "Response representing all the recoverable error details",
"properties" : {
"recoverableErrors" : {
"type" : "array",
"description" : "List of recoverable error details",
"items" : {
"$ref" : "#/components/schemas/ListOrderRecoverableErrors_Response_200_RecoverableErrors"
}
}
}
},
"ListOrderRecoverableErrors_Response_200_RecoverableErrors" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/ListOrderRecoverableErrors_Response_200_RecoverableErrors_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"ListOrderRecoverableErrors_Response_200_RecoverableErrors_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"ListOrderReturnMappings_Response_200" : {
"type" : "object",
"description" : "Mirakl marketplace return associated with a Shopify order",
"properties" : {
"createdAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Return creation date in UTC"
},
"id" : {
"type" : "string",
"description" : "Internal identifier of the return mapping (stable React key)"
},
"miraklOrderCommercialId" : {
"type" : "string",
"description" : "Mirakl commercial identifier (= Shopify Order ID)"
},
"miraklOrderId" : {
"type" : "string",
"description" : "Mirakl Order ID the return is attached to"
},
"miraklOrderUrl" : {
"type" : "string",
"description" : "Direct URL to the Mirakl order the return is attached to"
},
"miraklReturnId" : {
"type" : "string",
"description" : "Mirakl return identifier"
},
"miraklReturnReasonCode" : {
"type" : "string",
"description" : "Raw Mirakl return reason code (label resolution is done client-side)"
},
"miraklState" : {
"type" : "string",
"description" : "Mirakl-side state of the return, null when the stored value is not a known Mirakl return state"
},
"returnLines" : {
"type" : "array",
"description" : "Order lines targeted by the return",
"items" : {
"$ref" : "#/components/schemas/ListOrderReturnMappings_Response_200_ReturnLines"
}
},
"shopifyReturnId" : {
"type" : "string",
"description" : "Shopify Return identifier (raw id, gid:// prefix stripped), null when not yet synced to Shopify"
},
"shopifyState" : {
"type" : "string",
"description" : "Shopify-side state of the return, null when not yet synced or when the stored value is not a known Shopify return state"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Return last update date in UTC"
}
}
},
"ListOrderReturnMappings_Response_200_ReturnLines" : {
"type" : "object",
"description" : "Order line targeted by a Mirakl return",
"properties" : {
"orderLineId" : {
"type" : "string",
"description" : "Raw Shopify LineItem identifier targeted by the return"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Quantity of the order line included in the return"
}
}
},
"ListOrderTransactionMappings_Response_200" : {
"type" : "object",
"description" : "Mirakl transaction (debit/refund/refusal/cancellation/items-not-shippable) associated with a Shopify order",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Transaction amount in the order currency"
},
"createdAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Transaction creation date in UTC"
},
"id" : {
"type" : "string",
"description" : "Internal identifier of the transaction mapping (stable React key)"
},
"miraklCommercialId" : {
"type" : "string",
"description" : "Mirakl commercial identifier (= Shopify Order ID), used as fallback when miraklOrderId cannot be resolved"
},
"miraklEntityId" : {
"type" : "string",
"description" : "Raw Mirakl entity identifier (Mirakl Order ID for DEBIT, Refund ID for REFUND, cancellation/refusal/event ID for the other types)"
},
"miraklOrderId" : {
"type" : "string",
"description" : "Resolved Mirakl logistic Order ID when identifiable: read from the persisted transaction when available, otherwise resolved from legacy data (DEBIT, or REFUND with unambiguous parent), null otherwise"
},
"miraklOrderUrl" : {
"type" : "string",
"description" : "Direct URL to the Mirakl order when miraklOrderId is known, otherwise URL to a Mirakl search page filtered by miraklCommercialId"
},
"miraklSellerId" : {
"type" : "string",
"description" : "Mirakl seller (= shop) identifier"
},
"miraklSellerUrl" : {
"type" : "string",
"description" : "URL to the Mirakl shop (= seller) page, null when no seller is associated"
},
"miraklStatus" : {
"type" : "string",
"description" : "Mirakl-side status of the transaction"
},
"paymentId" : {
"type" : "string",
"description" : "Shopify payment identifier when known"
},
"shopifyGateway" : {
"type" : "string",
"description" : "Shopify payment gateway (PSP) name (Stripe, Mollie, Bogus, etc.)"
},
"shopifyParentTransactionId" : {
"type" : "string",
"description" : "Identifier of the Shopify OrderTransaction this one is linked to (raw id, gid:// prefix stripped)"
},
"shopifyStatus" : {
"type" : "string",
"description" : "Shopify-side status of the transaction"
},
"shopifyTransactionId" : {
"type" : "string",
"description" : "Shopify OrderTransaction identifier (raw id, gid:// prefix stripped)"
},
"type" : {
"type" : "string",
"description" : "Mirakl transaction type"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Transaction last update date in UTC"
}
}
},
"ListOrdersDocuments_Response_200" : {
"type" : "object",
"properties" : {
"documents" : {
"type" : "array",
"description" : "List of order documents",
"items" : {
"$ref" : "#/components/schemas/ListOrdersDocuments_Response_200_Documents"
}
}
}
},
"ListOrdersDocuments_Response_200_Documents" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"description" : "The file name of the document"
},
"id" : {
"type" : "string",
"description" : "Unique identifier for the document"
},
"type" : {
"type" : "string",
"description" : "Document type as defined in Mirakl document type configuration"
},
"uploadedDate" : {
"type" : "string",
"format" : "date-time",
"description" : "The uploaded date of the document"
},
"url" : {
"type" : "string",
"description" : "Secure download URL for the document. This URL includes a unique hash for security, and is generated specifically for the document."
}
}
},
"ListProductBindings_Response_200" : {
"type" : "object",
"description" : "Paginated list of product bindings",
"properties" : {
"bindings" : {
"type" : "array",
"description" : "The product bindings",
"items" : {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings"
}
},
"totalCount" : {
"type" : "integer",
"format" : "int64",
"description" : "Total number of matching entries"
}
}
},
"ListProductBindings_Response_200_Bindings" : {
"type" : "object",
"description" : "A product binding entry",
"discriminator" : {
"mapping" : {
"BASE_PRODUCT" : "#/components/schemas/ListProductBindings_Response_200_Bindings_BaseProduct",
"VARIANT" : "#/components/schemas/ListProductBindings_Response_200_Bindings_Variant"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string"
}
}
},
"ListProductBindings_Response_200_Bindings_BaseProduct" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings"
} ],
"description" : "A base product binding entry",
"properties" : {
"attributeBindings" : {
"type" : "array",
"description" : "Attribute bindings",
"items" : {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_BaseProduct_AttributeBindings"
}
},
"createdAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Creation timestamp"
},
"masterMiraklProductId" : {
"type" : "string",
"description" : "The master Mirakl product ID"
},
"operatorManaged" : {
"type" : "boolean",
"description" : "Whether the binding is operator-managed"
},
"productOptionBindings" : {
"type" : "array",
"description" : "Product option bindings",
"items" : {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_BaseProduct_ProductOptionBindings"
}
},
"publicationGids" : {
"type" : "array",
"description" : "Publication GIDs",
"items" : {
"type" : "string"
}
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify GID"
},
"shopifySortedMedia" : {
"type" : "boolean",
"description" : "Whether Shopify media is sorted"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Last update timestamp"
},
"variantGroupCode" : {
"type" : "string",
"description" : "The variant group code"
}
}
},
"ListProductBindings_Response_200_Bindings_BaseProduct_AttributeBindings" : {
"type" : "object",
"description" : "An attribute binding",
"discriminator" : {
"mapping" : {
"MEDIA" : "#/components/schemas/ListProductBindings_Response_200_Bindings_BaseProduct_AttributeBindings_Media",
"METAFIELD" : "#/components/schemas/ListProductBindings_Response_200_Bindings_BaseProduct_AttributeBindings_Metafield"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string"
}
}
},
"ListProductBindings_Response_200_Bindings_BaseProduct_AttributeBindings_Media" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_BaseProduct_AttributeBindings"
} ],
"description" : "A media attribute binding",
"properties" : {
"attributeCode" : {
"type" : "string",
"description" : "The Mirakl attribute code"
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify media GID"
},
"url" : {
"type" : "string",
"description" : "The media URL"
}
}
},
"ListProductBindings_Response_200_Bindings_BaseProduct_AttributeBindings_Metafield" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_BaseProduct_AttributeBindings"
} ],
"description" : "A metafield attribute binding",
"properties" : {
"attributeCode" : {
"type" : "string",
"description" : "The Mirakl attribute code"
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify metafield GID"
}
}
},
"ListProductBindings_Response_200_Bindings_BaseProduct_ProductOptionBindings" : {
"type" : "object",
"description" : "A product option binding",
"properties" : {
"miraklAttributeCode" : {
"type" : "string",
"description" : "The Mirakl attribute code"
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify option GID"
},
"values" : {
"type" : "array",
"description" : "The option value bindings",
"items" : {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_BaseProduct_ProductOptionBindings_Values"
}
}
}
},
"ListProductBindings_Response_200_Bindings_BaseProduct_ProductOptionBindings_Values" : {
"type" : "object",
"description" : "A product option value binding",
"properties" : {
"miraklValueCode" : {
"type" : "string",
"description" : "The Mirakl value code"
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify option value GID"
}
}
},
"ListProductBindings_Response_200_Bindings_Variant" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings"
} ],
"description" : "A variant binding entry",
"properties" : {
"activatedInventoryLocationGids" : {
"type" : "array",
"description" : "Activated inventory location IDs",
"items" : {
"type" : "string"
}
},
"attributeBindings" : {
"type" : "array",
"description" : "Attribute bindings",
"items" : {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_Variant_AttributeBindings"
}
},
"bestOffer" : {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_Variant_BestOffer",
"description" : "Best offer data"
},
"createdAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Creation timestamp"
},
"currenciesInStock" : {
"type" : "array",
"description" : "Currencies where product is in stock",
"items" : {
"type" : "string"
}
},
"inventoryItemGid" : {
"type" : "string",
"description" : "The inventory item ID"
},
"miraklProductId" : {
"type" : "string",
"description" : "The Mirakl product ID"
},
"operatorManaged" : {
"type" : "boolean",
"description" : "Whether the binding is operator-managed"
},
"productOptionBindings" : {
"type" : "array",
"description" : "Product option bindings",
"items" : {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_Variant_ProductOptionBindings"
}
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify GID"
},
"sku" : {
"type" : "string",
"description" : "The SKU"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Last update timestamp"
},
"variantGroupCode" : {
"type" : "string",
"description" : "The variant group code"
}
}
},
"ListProductBindings_Response_200_Bindings_Variant_AttributeBindings" : {
"type" : "object",
"description" : "An attribute binding",
"discriminator" : {
"mapping" : {
"MEDIA" : "#/components/schemas/ListProductBindings_Response_200_Bindings_Variant_AttributeBindings_Media",
"METAFIELD" : "#/components/schemas/ListProductBindings_Response_200_Bindings_Variant_AttributeBindings_Metafield"
},
"propertyName" : "type"
},
"properties" : {
"type" : {
"type" : "string"
}
}
},
"ListProductBindings_Response_200_Bindings_Variant_AttributeBindings_Media" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_Variant_AttributeBindings"
} ],
"description" : "A media attribute binding",
"properties" : {
"attributeCode" : {
"type" : "string",
"description" : "The Mirakl attribute code"
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify media GID"
},
"url" : {
"type" : "string",
"description" : "The media URL"
}
}
},
"ListProductBindings_Response_200_Bindings_Variant_AttributeBindings_Metafield" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_Variant_AttributeBindings"
} ],
"description" : "A metafield attribute binding",
"properties" : {
"attributeCode" : {
"type" : "string",
"description" : "The Mirakl attribute code"
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify metafield GID"
}
}
},
"ListProductBindings_Response_200_Bindings_Variant_BestOffer" : {
"type" : "object",
"description" : "Best offer data",
"properties" : {
"compareAtPrice" : {
"type" : "number",
"description" : "The compare-at price in the marketplace operator's currency"
},
"offerId" : {
"type" : "string",
"description" : "The offer ID"
},
"price" : {
"type" : "number",
"description" : "The price in the marketplace operator's currency"
}
}
},
"ListProductBindings_Response_200_Bindings_Variant_ProductOptionBindings" : {
"type" : "object",
"description" : "A product option binding",
"properties" : {
"miraklAttributeCode" : {
"type" : "string",
"description" : "The Mirakl attribute code"
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify option GID"
},
"values" : {
"type" : "array",
"description" : "The option value bindings",
"items" : {
"$ref" : "#/components/schemas/ListProductBindings_Response_200_Bindings_Variant_ProductOptionBindings_Values"
}
}
}
},
"ListProductBindings_Response_200_Bindings_Variant_ProductOptionBindings_Values" : {
"type" : "object",
"description" : "A product option value binding",
"properties" : {
"miraklValueCode" : {
"type" : "string",
"description" : "The Mirakl value code"
},
"shopifyGid" : {
"type" : "string",
"description" : "The Shopify option value GID"
}
}
},
"ListProductOffers_Response_200" : {
"type" : "object",
"properties" : {
"products" : {
"type" : "array",
"description" : "List of products information with their offers",
"items" : {
"$ref" : "#/components/schemas/ListProductOffers_Response_200_Products"
}
}
}
},
"ListProductOffers_Response_200_Products" : {
"type" : "object",
"properties" : {
"offers" : {
"type" : "array",
"description" : "List of offers for the product",
"items" : {
"$ref" : "#/components/schemas/ListProductOffers_Response_200_Products_Offers"
}
},
"productSku" : {
"type" : "string",
"description" : "SKU of the product"
}
}
},
"ListProductOffers_Response_200_Products_Offers" : {
"type" : "object",
"properties" : {
"allowQuoteRequests" : {
"type" : "boolean",
"description" : "Whether the offer is eligible for quotation"
},
"currencyIsoCode" : {
"type" : "string",
"description" : "The currency of the shop (iso format)"
},
"description" : {
"type" : "string",
"description" : "Offer description"
},
"ecoContributions" : {
"type" : "array",
"description" : "Eco-contributions of the offer - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.",
"items" : {
"$ref" : "#/components/schemas/ListProductOffers_Response_200_Products_Offers_EcoContributions"
}
},
"favoriteRank" : {
"type" : "integer",
"format" : "int32",
"description" : "Favorite rank for the offer, when the favorite feature is enabled and the offer is a favorite"
},
"fulfillment" : {
"$ref" : "#/components/schemas/ListProductOffers_Response_200_Products_Offers_Fulfillment",
"description" : "Fulfillment information"
},
"maxOrderQuantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The highest quantity of product items per order"
},
"minOrderQuantity" : {
"type" : "integer",
"format" : "int32",
"description" : "The lowest quantity of product items per order"
},
"minQuantityAlert" : {
"type" : "integer",
"format" : "int32",
"description" : "Minimum quantity of the offer"
},
"minShippingPrice" : {
"type" : "number",
"description" : "Unit price of the minimum shipping rate"
},
"minShippingPriceAdditional" : {
"type" : "number",
"description" : "Additional unit price associated to the minimum shipping rate"
},
"minShippingType" : {
"type" : "string",
"description" : "Code of the shipping type associated to the minimum shipping rate"
},
"minShippingZone" : {
"type" : "string",
"description" : "Code of the shipping zone associated to the minimum shipping rate"
},
"model" : {
"type" : "string",
"description" : "Shop platform model, current possible values :\n\nMARKETPLACE\nDROPSHIP\nONE_CREDITOR"
},
"nbEvaluation" : {
"type" : "integer",
"format" : "int64",
"description" : "Number of customers evaluations"
},
"offerId" : {
"type" : "string",
"description" : "Identifier of the offer"
},
"packageQuantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Indivisible quantity of the same product"
},
"price" : {
"type" : "number",
"description" : "Price of the offer\n\nFor Dropship specifically: the purchasing price of the offer, also referred to as cost or wholesale price"
},
"quantity" : {
"type" : "integer",
"format" : "int32",
"description" : "Available quantity of the offer"
},
"shippingDeadline" : {
"type" : "string",
"format" : "date-time",
"description" : "Estimated shipping date, that includes business closing days and cut-off configured on the platform. Add the earliest and latest delivery times to calculate the estimated delivery date to customers"
},
"shippingTypes" : {
"type" : "array",
"description" : "List of shipping types compatible with the given offer",
"items" : {
"$ref" : "#/components/schemas/ListProductOffers_Response_200_Products_Offers_ShippingTypes"
}
},
"shopGrade" : {
"type" : "number",
"description" : "Grade of the shop which proposes the offer"
},
"shopId" : {
"type" : "string",
"description" : "Identifier of the shop which proposes the offer"
},
"shopName" : {
"type" : "string",
"description" : "Name of the shop which proposes the offer"
},
"stateCode" : {
"type" : "string",
"description" : "Offer condition"
},
"totalPrice" : {
"type" : "number",
"description" : "Total price of the offer (price + minimum shipping rate)\n\nFor Dropship specifically: the purchasing price of the offer + minimum shipping rate"
}
}
},
"ListProductOffers_Response_200_Products_Offers_EcoContributions" : {
"type" : "object",
"properties" : {
"ecoContributionAmount" : {
"type" : "number",
"description" : "Amount of the eco-contribution."
},
"eprCategoryCode" : {
"type" : "string",
"description" : "Extended Producer Responsibility (EPR) category code."
},
"producerId" : {
"type" : "string",
"description" : "Producer identifier of the eco-contribution."
}
}
},
"ListProductOffers_Response_200_Products_Offers_Fulfillment" : {
"type" : "object",
"properties" : {
"center" : {
"$ref" : "#/components/schemas/ListProductOffers_Response_200_Products_Offers_Fulfillment_Center",
"description" : "Fulfillment center code"
}
}
},
"ListProductOffers_Response_200_Products_Offers_Fulfillment_Center" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Center code"
}
}
},
"ListProductOffers_Response_200_Products_Offers_ShippingTypes" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Shipping type code"
},
"cutOffNextDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Next cutoff date"
},
"cutOffTime" : {
"type" : "string",
"description" : "Shipping type Cutoff time"
},
"deliveryTime" : {
"$ref" : "#/components/schemas/ListProductOffers_Response_200_Products_Offers_ShippingTypes_DeliveryTime",
"description" : "Expected delivery time"
},
"label" : {
"type" : "string",
"description" : "Shipping type label"
},
"shippingDeadline" : {
"type" : "string",
"format" : "date-time",
"description" : "Estimated shipping date, that includes business closing days and cut-off configured on the platform. Add the earliest and latest delivery times to calculate the estimated delivery date to customers"
},
"shippingPriceType" : {
"type" : "string",
"description" : "Shipping price type of the offer for a given zone method"
},
"shippingPriceUnit" : {
"type" : "number",
"description" : "Shipping price of the offer"
},
"shippingZoneCode" : {
"type" : "string",
"description" : "Shipping zone code"
},
"shippingZoneLabel" : {
"type" : "string",
"description" : "Shipping zone label"
},
"standardCode" : {
"type" : "string",
"description" : "Shipping type standard code"
}
}
},
"ListProductOffers_Response_200_Products_Offers_ShippingTypes_DeliveryTime" : {
"type" : "object",
"properties" : {
"earliestDays" : {
"type" : "integer",
"format" : "int32",
"description" : "Earliest order delivery time"
},
"earliestDeliveryDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Earliest order delivery date"
},
"latestDays" : {
"type" : "integer",
"format" : "int32",
"description" : "Latest order delivery time"
},
"latestDeliveryDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Latest order delivery date"
}
}
},
"ListProductRecoverableErrors_Response_200" : {
"type" : "object",
"description" : "Response representing all the recoverable error details",
"properties" : {
"recoverableErrors" : {
"type" : "array",
"description" : "List of recoverable error details",
"items" : {
"$ref" : "#/components/schemas/ListProductRecoverableErrors_Response_200_RecoverableErrors"
}
}
}
},
"ListProductRecoverableErrors_Response_200_RecoverableErrors" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/ListProductRecoverableErrors_Response_200_RecoverableErrors_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"ListProductRecoverableErrors_Response_200_RecoverableErrors_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"ListReturnRecoverableErrors_Response_200" : {
"type" : "object",
"description" : "Response representing all the recoverable error details",
"properties" : {
"recoverableErrors" : {
"type" : "array",
"description" : "List of recoverable error details",
"items" : {
"$ref" : "#/components/schemas/ListReturnRecoverableErrors_Response_200_RecoverableErrors"
}
}
}
},
"ListReturnRecoverableErrors_Response_200_RecoverableErrors" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/ListReturnRecoverableErrors_Response_200_RecoverableErrors_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"ListReturnRecoverableErrors_Response_200_RecoverableErrors_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"ListSettings_Response_200" : {
"type" : "object",
"description" : "Environment settings response",
"properties" : {
"additionalLocales" : {
"type" : "array",
"description" : "Additional locales configuration, aside the primary language of the store",
"items" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_AdditionalLocales"
}
},
"categories" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Categories",
"description" : "Configuration for category filtering during taxonomy export"
},
"customAppClientSecret" : {
"type" : "string",
"description" : "Client secret used to verify the signature of JWT tokens send in CustomerUI API call"
},
"customCarrierDescription" : {
"type" : "string",
"description" : "Description for the custom carrier"
},
"customCarrierTitle" : {
"type" : "string",
"description" : "Title for the custom carrier"
},
"fraudCheck" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_FraudCheck",
"description" : "Fraud check"
},
"imageAttributes" : {
"type" : "array",
"description" : "List of image attributes exported when taxonomy is synchronized in Mirakl",
"items" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_ImageAttributes"
}
},
"jobs" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Jobs"
},
"description" : "The job settings"
},
"lastDeletedMiraklProductSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last synchronization of Mirakl deleted products to Shopify"
},
"lastMiraklToShopifyProductSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last Mirakl to Shopify product synchronization"
},
"lastMiraklToShopifyShipmentSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last Mirakl to Shopify shipment synchronization"
},
"lastOfferSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last offer synchronization"
},
"lastOrderSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last order synchronization"
},
"lastReturnSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last return synchronization"
},
"lastShopSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last shop synchronization"
},
"lastShopifyToMiraklProductSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last Shopify to Mirakl product synchronization"
},
"miraklMasterMode" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_MiraklMasterMode",
"description" : "Mirakl Master Mode settings"
},
"miraklPayout" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_MiraklPayout",
"description" : "Mirakl payout settings"
},
"offer" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Offer",
"description" : "Offer settings"
},
"order" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Order",
"description" : "Order settings"
},
"payment" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Payment",
"description" : "Payment settings"
},
"product" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Product",
"description" : "Product settings"
},
"publicationIds" : {
"type" : "array",
"description" : "The Shopify publication ids in which the third-party products and collections will be published",
"items" : {
"type" : "string"
}
},
"rootAttributes" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_RootAttributes"
},
"description" : "Settings of the root attributes and their Mirakl attribute codes. Only relevant when miraklMasterMode is enabled. If empty, defaults to preset values."
},
"shippingZoneMapping" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_ShippingZoneMapping",
"description" : "Mapping to compute Mirakl shipping zone code from customer address"
},
"shop" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Shop",
"description" : "Shop settings"
},
"syncMiraklToShopifyProductWithTags" : {
"type" : "array",
"description" : "List of all tags used to mark Mirakl products imported into Shopify.",
"items" : {
"type" : "string"
}
},
"syncShopifyToMiraklProductWithTags" : {
"type" : "array",
"description" : "List of all tags used to synchronize Shopify products to Mirakl. No product are exported if null or empty",
"items" : {
"type" : "string"
}
},
"taxonomyMetafields" : {
"type" : "array",
"description" : "List of all Shopify Metafields exported when taxonomy is synchronized in Mirakl",
"items" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_TaxonomyMetafields"
}
},
"vendorAsValueList" : {
"type" : "boolean",
"description" : "Export Shopify vendor attribute as a LIST attribute instead of TEXT"
}
}
},
"ListSettings_Response_200_AdditionalLocales" : {
"type" : "object",
"description" : "Configuration of an additional locale, aside the primary language of the store",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Locale code, language without region (e.g., 'fr', 'de', 'es')",
"example" : "fr"
}
}
},
"ListSettings_Response_200_Categories" : {
"type" : "object",
"description" : "Response object for category configuration during taxonomy export",
"properties" : {
"excludes" : {
"type" : "array",
"description" : "List of category IDs to exclude from the export (excludes all subcategories automatically)",
"items" : {
"type" : "string"
}
},
"includes" : {
"type" : "array",
"description" : "List of category IDs to include in the export (includes all subcategories automatically)",
"items" : {
"type" : "string"
}
}
}
},
"ListSettings_Response_200_FraudCheck" : {
"type" : "object",
"properties" : {
"analysisFactDescription" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
},
"ListSettings_Response_200_ImageAttributes" : {
"type" : "object",
"description" : "Image attribute response",
"properties" : {
"code" : {
"type" : "string",
"description" : "The unique code for the image attribute"
},
"isMainImage" : {
"type" : "boolean",
"description" : "Indicates if this is the main image"
},
"label" : {
"type" : "string",
"description" : "The label describing the image attribute"
}
}
},
"ListSettings_Response_200_Jobs" : {
"type" : "object",
"properties" : {
"scheduled" : {
"type" : "boolean",
"description" : "Indicates if the job is scheduled"
}
}
},
"ListSettings_Response_200_MiraklMasterMode" : {
"type" : "object",
"properties" : {
"enabled" : {
"type" : "boolean",
"description" : "Indicates if Mirakl is master on the taxonomy."
},
"useShopifyCategories" : {
"type" : "boolean",
"description" : "Indicates if Shopify categories should be used when Mirakl is master on the taxonomy."
}
}
},
"ListSettings_Response_200_MiraklPayout" : {
"type" : "object",
"description" : "Payment settings response",
"properties" : {
"payinPspId" : {
"type" : "string",
"description" : "Pay-in PSP to use to process payments"
}
}
},
"ListSettings_Response_200_Offer" : {
"type" : "object",
"description" : "Offer metafield mapping response",
"properties" : {
"synchronizeAdvancedPricing" : {
"type" : "boolean",
"description" : "Enabled status of the advanced pricing synchronization"
}
}
},
"ListSettings_Response_200_Order" : {
"type" : "object",
"description" : "Order sync settings response",
"properties" : {
"miraklExportCustomerOrganization" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Order_MiraklExportCustomerOrganization",
"description" : "Settings for exporting customer organization data to Mirakl"
},
"orderMetafields" : {
"type" : "array",
"description" : "List of order metafield mappings",
"items" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Order_OrderMetafields"
}
}
}
},
"ListSettings_Response_200_Order_MiraklExportCustomerOrganization" : {
"type" : "object",
"description" : "Mirakl export customer organization response",
"properties" : {
"mode" : {
"type" : "string",
"description" : "The mode for exporting customer organization data to Mirakl (Default: INACTIVE)"
}
}
},
"ListSettings_Response_200_Order_OrderMetafields" : {
"type" : "object",
"description" : "Order metafield mapping response",
"properties" : {
"miraklCustomFieldCode" : {
"type" : "string",
"description" : "The Mirakl custom field code"
},
"shopifyKey" : {
"type" : "string",
"description" : "The Shopify metafield key"
},
"shopifyNamespace" : {
"type" : "string",
"description" : "The Shopify metafield namespace"
}
}
},
"ListSettings_Response_200_Payment" : {
"type" : "object",
"description" : "Payment settings response",
"properties" : {
"confirmCaptureToMirakl" : {
"type" : "boolean",
"description" : "Whether to confirm captures to Mirakl"
},
"confirmRefundToMirakl" : {
"type" : "boolean",
"description" : "Whether to confirm refunds to Mirakl"
},
"create3PCaptureInShopify" : {
"type" : "boolean",
"description" : "Whether to create third-party captures in Shopify"
},
"create3PRefundInShopify" : {
"type" : "boolean",
"description" : "Whether to create third-party refunds in Shopify"
},
"miraklPaymentWorkflow" : {
"type" : "string",
"description" : "Workflow for handling order payments"
},
"pspTransactionReferenceSource" : {
"type" : "string",
"description" : "Metafield value path to write as imprint number in Mirakl"
},
"useMiraklPayout" : {
"type" : "boolean",
"description" : "Whether to use Mirakl payout"
},
"useTransactionNumberForCaptureFromMetafield" : {
"type" : "boolean",
"description" : "Whether to use transaction number from order metafield for capture"
},
"useTransactionNumberForRefundFromMetafield" : {
"type" : "boolean",
"description" : "Whether to use transaction number from order metafield for refund"
}
}
},
"ListSettings_Response_200_Product" : {
"type" : "object",
"description" : "Product settings response",
"properties" : {
"skuGenerations" : {
"type" : "array",
"description" : "Ordered list of SKU generation strategies",
"items" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Product_SkuGenerations"
}
}
}
},
"ListSettings_Response_200_Product_SkuGenerations" : {
"type" : "object",
"description" : "SKU generation settings response",
"discriminator" : {
"mapping" : {
"MIRAKL_PRODUCT_ID_BASED" : "#/components/schemas/ListSettings_Response_200_Product_SkuGenerations_MiraklProductIdBased",
"UNIQUE_IDENTIFIER_BASED" : "#/components/schemas/ListSettings_Response_200_Product_SkuGenerations_UniqueIdentifierBased"
},
"propertyName" : "strategy"
},
"properties" : {
"strategy" : {
"type" : "string"
}
}
},
"ListSettings_Response_200_Product_SkuGenerations_MiraklProductIdBased" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ListSettings_Response_200_Product_SkuGenerations"
} ],
"description" : "SKU generation response using Mirakl product ID with a prefix",
"properties" : {
"prefix" : {
"type" : "string",
"description" : "Prefix to prepend to the Mirakl product ID"
}
}
},
"ListSettings_Response_200_Product_SkuGenerations_UniqueIdentifierBased" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/ListSettings_Response_200_Product_SkuGenerations"
} ],
"description" : "SKU generation response using a unique identifier attribute",
"properties" : {
"attributeCode" : {
"type" : "string",
"description" : "Mirakl attribute code with UNIQUE_IDENTIFIER role"
}
}
},
"ListSettings_Response_200_RootAttributes" : {
"type" : "object",
"description" : "Response object for Shopify root attribute",
"properties" : {
"code" : {
"type" : "string",
"description" : "The Shopify root attribute code"
}
}
},
"ListSettings_Response_200_ShippingZoneMapping" : {
"type" : "object",
"description" : "Shipping zone mapping response",
"properties" : {
"countries" : {
"type" : "array",
"description" : "List of countries who override the default shipping zone code",
"items" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_ShippingZoneMapping_Countries"
}
},
"shippingZone" : {
"type" : "string",
"description" : "The default shipping zone code"
}
}
},
"ListSettings_Response_200_ShippingZoneMapping_Countries" : {
"type" : "object",
"properties" : {
"iso2Code" : {
"type" : "string",
"description" : "The ISO 2 code for the country"
},
"provinces" : {
"type" : "array",
"description" : "List of province who override the shipping zone code (not checked if override is found in zips list)",
"items" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_ShippingZoneMapping_Countries_Provinces"
}
},
"shippingZone" : {
"type" : "string",
"description" : "The shipping zone for the country"
},
"zips" : {
"type" : "array",
"description" : "List of zip who override the shipping zone code. The code must match the beginning of customer the zip code (ex: `K2` and `K2P` will match the customer zip code `K2P-2L8` but `K2P` will be prioritized)",
"items" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_ShippingZoneMapping_Countries_Zips"
}
}
}
},
"ListSettings_Response_200_ShippingZoneMapping_Countries_Provinces" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code"
},
"shippingZone" : {
"type" : "string",
"description" : "The shipping zone code"
}
}
},
"ListSettings_Response_200_ShippingZoneMapping_Countries_Zips" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code"
},
"shippingZone" : {
"type" : "string",
"description" : "The shipping zone code"
}
}
},
"ListSettings_Response_200_Shop" : {
"type" : "object",
"description" : "Shop settings response",
"properties" : {
"shopMiraklCustomFields" : {
"type" : "array",
"description" : "List of Mirakl shop custom attributes to map",
"items" : {
"$ref" : "#/components/schemas/ListSettings_Response_200_Shop_ShopMiraklCustomFields"
}
}
}
},
"ListSettings_Response_200_Shop_ShopMiraklCustomFields" : {
"type" : "object",
"description" : "Mirakl shop custom field response",
"properties" : {
"code" : {
"type" : "string",
"description" : "The Mirakl custom field code"
}
}
},
"ListSettings_Response_200_TaxonomyMetafields" : {
"type" : "object",
"description" : "Taxonomy metafield response",
"properties" : {
"key" : {
"type" : "string",
"description" : "The unique identifier for the metafield definition within its namespace"
},
"localizable" : {
"type" : "boolean",
"description" : "Whether this metafield can be translated"
},
"namespace" : {
"type" : "string",
"description" : "The namespace for the metafield definition"
},
"ownerType" : {
"type" : "string",
"description" : "The resource type that the metafield definition is attached to (PRODUCT or PRODUCTVARIANT)"
}
}
},
"ListShipmentRecoverableErrors_Response_200" : {
"type" : "object",
"description" : "Response representing all the recoverable error details",
"properties" : {
"recoverableErrors" : {
"type" : "array",
"description" : "List of recoverable error details",
"items" : {
"$ref" : "#/components/schemas/ListShipmentRecoverableErrors_Response_200_RecoverableErrors"
}
}
}
},
"ListShipmentRecoverableErrors_Response_200_RecoverableErrors" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/ListShipmentRecoverableErrors_Response_200_RecoverableErrors_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"ListShipmentRecoverableErrors_Response_200_RecoverableErrors_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"ListShopEvaluations_Response_200" : {
"type" : "object",
"properties" : {
"evaluations" : {
"type" : "array",
"description" : "Evaluations list",
"items" : {
"$ref" : "#/components/schemas/ListShopEvaluations_Response_200_Evaluations"
}
},
"totalCount" : {
"type" : "integer",
"format" : "int64",
"description" : "Total count of elements returned by the query"
}
}
},
"ListShopEvaluations_Response_200_Evaluations" : {
"type" : "object",
"properties" : {
"assessments" : {
"type" : "array",
"description" : "List of assessments",
"items" : {
"$ref" : "#/components/schemas/ListShopEvaluations_Response_200_Evaluations_Assessments"
}
},
"comment" : {
"type" : "string",
"description" : "Evaluation comment"
},
"createdAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Evaluation creation date"
},
"customerId" : {
"type" : "string",
"description" : "Identifier of the customer who posted the evaluation"
},
"entity" : {
"$ref" : "#/components/schemas/ListShopEvaluations_Response_200_Evaluations_Entity",
"description" : "Entity the rating is about"
},
"firstname" : {
"type" : "string",
"description" : "First name of the customer who posted the evaluation"
},
"grade" : {
"type" : "integer",
"format" : "int32",
"description" : "Evaluation grade"
},
"lastname" : {
"type" : "string",
"description" : "Last name of the customer who posted the evaluation"
},
"reply" : {
"$ref" : "#/components/schemas/ListShopEvaluations_Response_200_Evaluations_Reply",
"description" : "Reply of a shop or operator on an evaluation"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time",
"description" : "Evaluation last updated date"
}
}
},
"ListShopEvaluations_Response_200_Evaluations_Assessments" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "Assessment code"
},
"label" : {
"type" : "string",
"description" : "Assessment label"
},
"response" : {
"type" : "string",
"description" : "Response associated with the assessment"
}
}
},
"ListShopEvaluations_Response_200_Evaluations_Entity" : {
"type" : "object",
"properties" : {
"createdAt" : {
"type" : "string",
"format" : "date-time",
"description" : "The creation date of the entity"
},
"id" : {
"type" : "string",
"description" : "Id of the entity"
},
"type" : {
"type" : "string",
"description" : "Type of the entity"
}
}
},
"ListShopEvaluations_Response_200_Evaluations_Reply" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "string",
"description" : "Text of the reply",
"maxLength" : 1000,
"minLength" : 1
},
"date" : {
"type" : "string",
"format" : "date-time",
"description" : "Reply date"
},
"type" : {
"type" : "string",
"description" : "Type of user who replied"
}
}
},
"ListShopRecoverableErrors_Response_200" : {
"type" : "object",
"description" : "Response representing all the recoverable error details",
"properties" : {
"recoverableErrors" : {
"type" : "array",
"description" : "List of recoverable error details",
"items" : {
"$ref" : "#/components/schemas/ListShopRecoverableErrors_Response_200_RecoverableErrors"
}
}
}
},
"ListShopRecoverableErrors_Response_200_RecoverableErrors" : {
"type" : "object",
"description" : "Response representing a recoverable error details",
"properties" : {
"attempts" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of attempts made to process the error",
"example" : 3
},
"data" : {
"type" : "object",
"description" : "Additional data associated with the error"
},
"discriminant" : {
"type" : "string",
"description" : "Unique error discriminator"
},
"firstAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the first recorded attempt",
"example" : "2023-10-30T12:00:00Z"
},
"lastAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last attempt",
"example" : "2023-10-30T12:34:56Z"
},
"lastError" : {
"$ref" : "#/components/schemas/ListShopRecoverableErrors_Response_200_RecoverableErrors_LastError",
"description" : "Details of the last error"
},
"nextAttempt" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp for the next retry attempt",
"example" : "2023-10-31T00:00:00Z"
}
}
},
"ListShopRecoverableErrors_Response_200_RecoverableErrors_LastError" : {
"type" : "object",
"description" : "Details of a recoverable error",
"properties" : {
"applicationCode" : {
"type" : "string",
"description" : "Application specific error code",
"example" : "CM19248"
},
"httpCode" : {
"type" : "string",
"description" : "HTTP status code associated with the error",
"example" : "404"
},
"message" : {
"type" : "string",
"description" : "Detailed error message",
"example" : "Resource not found"
}
}
},
"SetupCheckConsistency_Response_200" : {
"type" : "object",
"description" : "Checked setup data response",
"properties" : {
"checkedElements" : {
"type" : "array",
"description" : "List of checked components",
"items" : {
"$ref" : "#/components/schemas/SetupCheckConsistency_Response_200_CheckedElements"
}
}
}
},
"SetupCheckConsistency_Response_200_CheckedElements" : {
"type" : "object",
"description" : "Component checked",
"properties" : {
"code" : {
"type" : "string",
"description" : "Code of the component"
},
"name" : {
"type" : "string",
"description" : "Name of the component"
},
"status" : {
"type" : "array",
"description" : "Status for each element",
"items" : {
"$ref" : "#/components/schemas/SetupCheckConsistency_Response_200_CheckedElements_Status"
}
}
}
},
"SetupCheckConsistency_Response_200_CheckedElements_Status" : {
"type" : "object",
"description" : "Element checked",
"properties" : {
"key" : {
"type" : "string",
"description" : "Key of the element"
},
"message" : {
"type" : "string",
"description" : "A message related to the status"
},
"status" : {
"type" : "string",
"description" : "Status of the element"
}
}
},
"SetupCheckPermissions_Response_200" : {
"type" : "object",
"description" : "Check permissions response",
"properties" : {
"missingPermissions" : {
"type" : "array",
"description" : "List of missing permissions",
"items" : {
"type" : "string"
}
}
}
},
"SetupUpdate_Response_200" : {
"type" : "object",
"description" : "Updated setup data response",
"properties" : {
"updatedElements" : {
"type" : "array",
"description" : "List of updated components",
"items" : {
"$ref" : "#/components/schemas/SetupUpdate_Response_200_UpdatedElements"
}
}
}
},
"SetupUpdate_Response_200_UpdatedElements" : {
"type" : "object",
"description" : "Component updated",
"properties" : {
"code" : {
"type" : "string",
"description" : "Code of the component"
},
"name" : {
"type" : "string",
"description" : "Name of the component"
},
"status" : {
"type" : "array",
"description" : "Status for each element",
"items" : {
"$ref" : "#/components/schemas/SetupUpdate_Response_200_UpdatedElements_Status"
}
}
}
},
"SetupUpdate_Response_200_UpdatedElements_Status" : {
"type" : "object",
"description" : "Element updated",
"properties" : {
"key" : {
"type" : "string",
"description" : "Key of the element"
},
"message" : {
"type" : "string",
"description" : "A message related to the status"
},
"status" : {
"type" : "string",
"description" : "Status of the element"
}
}
},
"SyncDeletedMiraklProducts_Request" : {
"type" : "object",
"description" : "Request object holding the parameters for the deleted Mirakl product synchronization request",
"properties" : {
"deletedSince" : {
"type" : "string",
"format" : "date-time",
"description" : "Sync Mirakl deleted products to Shopify since this date"
}
}
},
"SyncFirstPartyProducts_Request" : {
"type" : "object",
"description" : "Request object to update Shopify to Mirakl product synchronization since date",
"properties" : {
"sinceDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last product synchronization"
}
}
},
"SyncOffers_Request" : {
"type" : "object",
"description" : "Request object holding the parameters for the offer import",
"properties" : {
"sinceDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last offer import into Shopify"
}
}
},
"SyncOrders_Request" : {
"type" : "object",
"description" : "Request object to update order synchronization since date",
"properties" : {
"sinceDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last order synchronization"
}
}
},
"SyncReturns_Request" : {
"type" : "object",
"description" : "Request object for return synchronization from Shopify to Mirakl",
"properties" : {
"sinceDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Date threshold: only syncs returns modified after this date"
}
}
},
"SyncShipments_Request" : {
"type" : "object",
"description" : "Request object to update Mirakl to Shopify shipment synchronization since date",
"properties" : {
"sinceDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last shipment synchronization"
}
}
},
"SyncShops_Request" : {
"type" : "object",
"description" : "Request object for shop synchronization from Shopify to Mirakl",
"properties" : {
"sinceDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Date threshold: only syncs shops modified after this date"
}
}
},
"SyncThirdPartyProducts_Request" : {
"type" : "object",
"description" : "Request object holding the parameters for the product import",
"properties" : {
"sinceDate" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last product import into Shopify"
}
}
},
"UpdateSettings_Request" : {
"type" : "object",
"description" : "Request object to update environment settings",
"properties" : {
"additionalLocales" : {
"type" : "array",
"description" : "Additional locales configuration, aside the primary language of the store",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_AdditionalLocales"
}
},
"categories" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Categories",
"description" : "Configuration for category filtering during taxonomy export"
},
"customAppClientSecret" : {
"type" : "string",
"description" : "Client secret used to verify the signature of JWT tokens send in CustomerUI API call"
},
"customCarrierDescription" : {
"type" : "string",
"description" : "Description for the custom carrier"
},
"customCarrierTitle" : {
"type" : "string",
"description" : "Title for the custom carrier"
},
"fraudCheck" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_FraudCheck",
"description" : "Fraud check"
},
"imageAttributes" : {
"type" : "array",
"description" : "List of image attributes exported when taxonomy is synchronized in Mirakl",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_ImageAttributes"
}
},
"jobs" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Jobs"
},
"description" : "The job settings"
},
"lastDeletedMiraklProductSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last synchronization of Mirakl deleted products to Shopify"
},
"lastMiraklToShopifyProductSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last Mirakl to Shopify product synchronization"
},
"lastMiraklToShopifyShipmentSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last Mirakl to Shopify shipment synchronization"
},
"lastOfferSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last offer synchronization"
},
"lastOrderSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last order synchronization"
},
"lastReturnSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last return synchronization"
},
"lastShopSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last shop synchronization"
},
"lastShopifyToMiraklProductSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last Shopify to Mirakl product synchronization"
},
"miraklMasterMode" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_MiraklMasterMode",
"description" : "Mirakl Master Mode settings"
},
"miraklPayout" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_MiraklPayout",
"description" : "Mirakl payout settings"
},
"offer" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Offer",
"description" : "Offer settings"
},
"order" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Order",
"description" : "Order settings"
},
"payment" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Payment",
"description" : "Payment settings"
},
"product" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Product",
"description" : "Product settings"
},
"publicationIds" : {
"type" : "array",
"description" : "The Shopify publication ids in which the third-party products and collections will be published",
"items" : {
"type" : "string"
}
},
"rootAttributes" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_RootAttributes"
},
"description" : "Settings of the root attributes and their Mirakl attribute codes. Only relevant when miraklMasterMode is enabled. If not provided, defaults to preset values."
},
"shippingZoneMapping" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_ShippingZoneMapping",
"description" : "Mapping to compute Mirakl shipping zone code from customer address"
},
"shop" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Shop",
"description" : "Shop settings"
},
"syncMiraklToShopifyProductWithTags" : {
"type" : "array",
"description" : "List of all tags used to mark Mirakl products imported into Shopify.",
"items" : {
"type" : "string"
}
},
"syncShopifyToMiraklProductWithTags" : {
"type" : "array",
"description" : "List of all tags used to synchronize Shopify products to Mirakl. No product are exported if null or empty",
"items" : {
"type" : "string"
}
},
"taxonomyMetafields" : {
"type" : "array",
"description" : "List of all Shopify Metafields exported when taxonomy is synchronized in Mirakl",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_TaxonomyMetafields"
}
},
"vendorAsValueList" : {
"type" : "boolean",
"description" : "Export Shopify vendor attribute as a LIST attribute instead of TEXT"
}
}
},
"UpdateSettings_Request_AdditionalLocales" : {
"type" : "object",
"description" : "Configuration of an additional locale, aside the primary language of the store",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Locale code, language without region (e.g., 'fr', 'de', 'es')",
"example" : "fr"
}
}
},
"UpdateSettings_Request_Categories" : {
"type" : "object",
"description" : "Configuration for category filtering during taxonomy export",
"properties" : {
"excludes" : {
"type" : "array",
"description" : "List of category IDs to exclude from the export (excludes all subcategories automatically)",
"items" : {
"type" : "string"
}
},
"includes" : {
"type" : "array",
"description" : "List of category IDs to include in the export (includes all subcategories automatically)",
"items" : {
"type" : "string"
}
}
}
},
"UpdateSettings_Request_FraudCheck" : {
"type" : "object",
"description" : "Fraud check",
"properties" : {
"analysisFactDescription" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
},
"UpdateSettings_Request_ImageAttributes" : {
"type" : "object",
"description" : "Request object to update image attribute",
"properties" : {
"code" : {
"type" : "string",
"description" : "The unique code for the image attribute"
},
"isMainImage" : {
"type" : "boolean",
"description" : "Indicates if this is the main image"
},
"label" : {
"type" : "string",
"description" : "The label describing the image attribute"
}
}
},
"UpdateSettings_Request_Jobs" : {
"type" : "object",
"description" : "The job settings",
"properties" : {
"scheduled" : {
"type" : "boolean",
"description" : "Indicates if the job is scheduled"
}
}
},
"UpdateSettings_Request_MiraklMasterMode" : {
"type" : "object",
"description" : "Request object to update Mirakl master mode settings"
},
"UpdateSettings_Request_MiraklPayout" : {
"type" : "object",
"description" : "Mirakl Payout settings",
"properties" : {
"payinPspId" : {
"type" : "string",
"description" : "Pay-in PSP to use to process payments"
}
}
},
"UpdateSettings_Request_Offer" : {
"type" : "object",
"description" : "Request object to update offer sync settings",
"properties" : {
"synchronizeAdvancedPricing" : {
"type" : "boolean",
"description" : "Enabled status of the advanced pricing synchronization"
}
}
},
"UpdateSettings_Request_Order" : {
"type" : "object",
"description" : "Request object to update order sync settings",
"properties" : {
"miraklExportCustomerOrganization" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Order_MiraklExportCustomerOrganization",
"description" : "Settings for exporting customer organization data to Mirakl"
},
"orderMetafields" : {
"type" : "array",
"description" : "List of order metafield mappings",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Order_OrderMetafields"
}
}
}
},
"UpdateSettings_Request_Order_MiraklExportCustomerOrganization" : {
"type" : "object",
"description" : "Request object to exporting customer organization data to Mirakl",
"properties" : {
"mode" : {
"type" : "string",
"description" : "The mode for exporting customer organization data to Mirakl (Default: INACTIVE)"
}
}
},
"UpdateSettings_Request_Order_OrderMetafields" : {
"type" : "object",
"description" : "Request object to update order metafield mapping",
"properties" : {
"miraklCustomFieldCode" : {
"type" : "string",
"description" : "The Mirakl custom field code"
},
"shopifyKey" : {
"type" : "string",
"description" : "The Shopify metafield key"
},
"shopifyNamespace" : {
"type" : "string",
"description" : "The Shopify metafield namespace"
}
}
},
"UpdateSettings_Request_Payment" : {
"type" : "object",
"description" : "Payment settings request",
"properties" : {
"confirmCaptureToMirakl" : {
"type" : "boolean",
"description" : "Whether to confirm captures to Mirakl"
},
"confirmRefundToMirakl" : {
"type" : "boolean",
"description" : "Whether to confirm refunds to Mirakl"
},
"create3PCaptureInShopify" : {
"type" : "boolean",
"description" : "Whether to create third-party captures in Shopify"
},
"create3PRefundInShopify" : {
"type" : "boolean",
"description" : "Whether to create third-party refunds in Shopify"
},
"miraklPaymentWorkflow" : {
"type" : "string",
"description" : "Workflow for handling order payments"
},
"pspTransactionReferenceSource" : {
"type" : "string",
"description" : "Metafield value path to write as imprint number in Mirakl"
},
"useMiraklPayout" : {
"type" : "boolean",
"description" : "Whether to use Mirakl payout"
},
"useTransactionNumberForCaptureFromMetafield" : {
"type" : "boolean",
"description" : "Whether to use transaction number from order metafield for capture"
},
"useTransactionNumberForRefundFromMetafield" : {
"type" : "boolean",
"description" : "Whether to use transaction number from order metafield for refund"
}
}
},
"UpdateSettings_Request_Product" : {
"type" : "object",
"description" : "Request object to update product settings",
"properties" : {
"skuGenerations" : {
"type" : "array",
"description" : "Ordered list of SKU generation strategies",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Product_SkuGenerations"
}
}
}
},
"UpdateSettings_Request_Product_SkuGenerations" : {
"type" : "object",
"description" : "Request object to define a SKU generation strategy",
"discriminator" : {
"mapping" : {
"MIRAKL_PRODUCT_ID_BASED" : "#/components/schemas/UpdateSettings_Request_Product_SkuGenerations_MiraklProductIdBased",
"UNIQUE_IDENTIFIER_BASED" : "#/components/schemas/UpdateSettings_Request_Product_SkuGenerations_UniqueIdentifierBased"
},
"propertyName" : "strategy"
},
"properties" : {
"strategy" : {
"type" : "string"
}
}
},
"UpdateSettings_Request_Product_SkuGenerations_MiraklProductIdBased" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/UpdateSettings_Request_Product_SkuGenerations"
} ],
"description" : "SKU generation request using Mirakl product ID with a prefix",
"properties" : {
"prefix" : {
"type" : "string",
"description" : "Prefix to prepend to the Mirakl product ID"
}
}
},
"UpdateSettings_Request_Product_SkuGenerations_UniqueIdentifierBased" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/UpdateSettings_Request_Product_SkuGenerations"
} ],
"description" : "SKU generation request using a unique identifier attribute",
"properties" : {
"attributeCode" : {
"type" : "string",
"description" : "Mirakl attribute code with UNIQUE_IDENTIFIER role"
}
}
},
"UpdateSettings_Request_RootAttributes" : {
"type" : "object",
"description" : "Request object to update Shopify root attribute",
"properties" : {
"code" : {
"type" : "string",
"description" : "The Shopify root attribute code"
}
}
},
"UpdateSettings_Request_ShippingZoneMapping" : {
"type" : "object",
"description" : "Request object to update shipping zone mapping",
"properties" : {
"countries" : {
"type" : "array",
"description" : "List of countries who override the default shipping zone code",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_ShippingZoneMapping_Countries"
}
},
"shippingZone" : {
"type" : "string",
"description" : "The default shipping zone code"
}
}
},
"UpdateSettings_Request_ShippingZoneMapping_Countries" : {
"type" : "object",
"description" : "List of countries who override the default shipping zone code",
"properties" : {
"iso2Code" : {
"type" : "string",
"description" : "The ISO 2 code for the country"
},
"provinces" : {
"type" : "array",
"description" : "List of province who override the shipping zone code (not checked if override is found in zips list)",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_ShippingZoneMapping_Countries_Provinces"
}
},
"shippingZone" : {
"type" : "string",
"description" : "The shipping zone for the country"
},
"zips" : {
"type" : "array",
"description" : "List of zip who override the shipping zone code. The code must match the beginning of customer the zip code (ex: `K2` and `K2P` will match the customer zip code `K2P-2L8` but `K2P` will be prioritized)",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_ShippingZoneMapping_Countries_Zips"
}
}
}
},
"UpdateSettings_Request_ShippingZoneMapping_Countries_Provinces" : {
"type" : "object",
"description" : "List of zip who override the shipping zone code. The code must match the beginning of customer the zip code (ex: `K2` and `K2P` will match the customer zip code `K2P-2L8` but `K2P` will be prioritized)",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code"
},
"shippingZone" : {
"type" : "string",
"description" : "The shipping zone code"
}
}
},
"UpdateSettings_Request_ShippingZoneMapping_Countries_Zips" : {
"type" : "object",
"description" : "List of zip who override the shipping zone code. The code must match the beginning of customer the zip code (ex: `K2` and `K2P` will match the customer zip code `K2P-2L8` but `K2P` will be prioritized)",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code"
},
"shippingZone" : {
"type" : "string",
"description" : "The shipping zone code"
}
}
},
"UpdateSettings_Request_Shop" : {
"type" : "object",
"description" : "Request object to update shop settings",
"properties" : {
"shopMiraklCustomFields" : {
"type" : "array",
"description" : "List of Mirakl shop custom attributes to map",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Request_Shop_ShopMiraklCustomFields"
}
}
}
},
"UpdateSettings_Request_Shop_ShopMiraklCustomFields" : {
"type" : "object",
"description" : "Request object to update Mirakl shop custom field",
"properties" : {
"code" : {
"type" : "string",
"description" : "The Mirakl custom field code"
}
}
},
"UpdateSettings_Request_TaxonomyMetafields" : {
"type" : "object",
"description" : "Request object to update taxonomy metafield",
"properties" : {
"key" : {
"type" : "string",
"description" : "The unique identifier for the metafield definition within its namespace"
},
"localizable" : {
"type" : "boolean",
"description" : "Whether this metafield can be translated"
},
"namespace" : {
"type" : "string",
"description" : "The namespace for the metafield definition"
},
"ownerType" : {
"type" : "string",
"description" : "The resource type that the metafield definition is attached to (PRODUCT or PRODUCTVARIANT)"
}
}
},
"UpdateSettings_Response_200" : {
"type" : "object",
"description" : "Environment settings response",
"properties" : {
"additionalLocales" : {
"type" : "array",
"description" : "Additional locales configuration, aside the primary language of the store",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_AdditionalLocales"
}
},
"categories" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Categories",
"description" : "Configuration for category filtering during taxonomy export"
},
"customAppClientSecret" : {
"type" : "string",
"description" : "Client secret used to verify the signature of JWT tokens send in CustomerUI API call"
},
"customCarrierDescription" : {
"type" : "string",
"description" : "Description for the custom carrier"
},
"customCarrierTitle" : {
"type" : "string",
"description" : "Title for the custom carrier"
},
"fraudCheck" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_FraudCheck",
"description" : "Fraud check"
},
"imageAttributes" : {
"type" : "array",
"description" : "List of image attributes exported when taxonomy is synchronized in Mirakl",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_ImageAttributes"
}
},
"jobs" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Jobs"
},
"description" : "The job settings"
},
"lastDeletedMiraklProductSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last synchronization of Mirakl deleted products to Shopify"
},
"lastMiraklToShopifyProductSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last Mirakl to Shopify product synchronization"
},
"lastMiraklToShopifyShipmentSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last Mirakl to Shopify shipment synchronization"
},
"lastOfferSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last offer synchronization"
},
"lastOrderSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last order synchronization"
},
"lastReturnSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last return synchronization"
},
"lastShopSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last shop synchronization"
},
"lastShopifyToMiraklProductSync" : {
"type" : "string",
"format" : "date-time",
"description" : "Timestamp of the last Shopify to Mirakl product synchronization"
},
"miraklMasterMode" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_MiraklMasterMode",
"description" : "Mirakl Master Mode settings"
},
"miraklPayout" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_MiraklPayout",
"description" : "Mirakl payout settings"
},
"offer" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Offer",
"description" : "Offer settings"
},
"order" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Order",
"description" : "Order settings"
},
"payment" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Payment",
"description" : "Payment settings"
},
"product" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Product",
"description" : "Product settings"
},
"publicationIds" : {
"type" : "array",
"description" : "The Shopify publication ids in which the third-party products and collections will be published",
"items" : {
"type" : "string"
}
},
"rootAttributes" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_RootAttributes"
},
"description" : "Settings of the root attributes and their Mirakl attribute codes. Only relevant when miraklMasterMode is enabled. If empty, defaults to preset values."
},
"shippingZoneMapping" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_ShippingZoneMapping",
"description" : "Mapping to compute Mirakl shipping zone code from customer address"
},
"shop" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Shop",
"description" : "Shop settings"
},
"syncMiraklToShopifyProductWithTags" : {
"type" : "array",
"description" : "List of all tags used to mark Mirakl products imported into Shopify.",
"items" : {
"type" : "string"
}
},
"syncShopifyToMiraklProductWithTags" : {
"type" : "array",
"description" : "List of all tags used to synchronize Shopify products to Mirakl. No product are exported if null or empty",
"items" : {
"type" : "string"
}
},
"taxonomyMetafields" : {
"type" : "array",
"description" : "List of all Shopify Metafields exported when taxonomy is synchronized in Mirakl",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_TaxonomyMetafields"
}
},
"vendorAsValueList" : {
"type" : "boolean",
"description" : "Export Shopify vendor attribute as a LIST attribute instead of TEXT"
}
}
},
"UpdateSettings_Response_200_AdditionalLocales" : {
"type" : "object",
"description" : "Configuration of an additional locale, aside the primary language of the store",
"properties" : {
"locale" : {
"type" : "string",
"description" : "Locale code, language without region (e.g., 'fr', 'de', 'es')",
"example" : "fr"
}
}
},
"UpdateSettings_Response_200_Categories" : {
"type" : "object",
"description" : "Response object for category configuration during taxonomy export",
"properties" : {
"excludes" : {
"type" : "array",
"description" : "List of category IDs to exclude from the export (excludes all subcategories automatically)",
"items" : {
"type" : "string"
}
},
"includes" : {
"type" : "array",
"description" : "List of category IDs to include in the export (includes all subcategories automatically)",
"items" : {
"type" : "string"
}
}
}
},
"UpdateSettings_Response_200_FraudCheck" : {
"type" : "object",
"properties" : {
"analysisFactDescription" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
},
"UpdateSettings_Response_200_ImageAttributes" : {
"type" : "object",
"description" : "Image attribute response",
"properties" : {
"code" : {
"type" : "string",
"description" : "The unique code for the image attribute"
},
"isMainImage" : {
"type" : "boolean",
"description" : "Indicates if this is the main image"
},
"label" : {
"type" : "string",
"description" : "The label describing the image attribute"
}
}
},
"UpdateSettings_Response_200_Jobs" : {
"type" : "object",
"properties" : {
"scheduled" : {
"type" : "boolean",
"description" : "Indicates if the job is scheduled"
}
}
},
"UpdateSettings_Response_200_MiraklMasterMode" : {
"type" : "object",
"properties" : {
"enabled" : {
"type" : "boolean",
"description" : "Indicates if Mirakl is master on the taxonomy."
},
"useShopifyCategories" : {
"type" : "boolean",
"description" : "Indicates if Shopify categories should be used when Mirakl is master on the taxonomy."
}
}
},
"UpdateSettings_Response_200_MiraklPayout" : {
"type" : "object",
"description" : "Payment settings response",
"properties" : {
"payinPspId" : {
"type" : "string",
"description" : "Pay-in PSP to use to process payments"
}
}
},
"UpdateSettings_Response_200_Offer" : {
"type" : "object",
"description" : "Offer metafield mapping response",
"properties" : {
"synchronizeAdvancedPricing" : {
"type" : "boolean",
"description" : "Enabled status of the advanced pricing synchronization"
}
}
},
"UpdateSettings_Response_200_Order" : {
"type" : "object",
"description" : "Order sync settings response",
"properties" : {
"miraklExportCustomerOrganization" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Order_MiraklExportCustomerOrganization",
"description" : "Settings for exporting customer organization data to Mirakl"
},
"orderMetafields" : {
"type" : "array",
"description" : "List of order metafield mappings",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Order_OrderMetafields"
}
}
}
},
"UpdateSettings_Response_200_Order_MiraklExportCustomerOrganization" : {
"type" : "object",
"description" : "Mirakl export customer organization response",
"properties" : {
"mode" : {
"type" : "string",
"description" : "The mode for exporting customer organization data to Mirakl (Default: INACTIVE)"
}
}
},
"UpdateSettings_Response_200_Order_OrderMetafields" : {
"type" : "object",
"description" : "Order metafield mapping response",
"properties" : {
"miraklCustomFieldCode" : {
"type" : "string",
"description" : "The Mirakl custom field code"
},
"shopifyKey" : {
"type" : "string",
"description" : "The Shopify metafield key"
},
"shopifyNamespace" : {
"type" : "string",
"description" : "The Shopify metafield namespace"
}
}
},
"UpdateSettings_Response_200_Payment" : {
"type" : "object",
"description" : "Payment settings response",
"properties" : {
"confirmCaptureToMirakl" : {
"type" : "boolean",
"description" : "Whether to confirm captures to Mirakl"
},
"confirmRefundToMirakl" : {
"type" : "boolean",
"description" : "Whether to confirm refunds to Mirakl"
},
"create3PCaptureInShopify" : {
"type" : "boolean",
"description" : "Whether to create third-party captures in Shopify"
},
"create3PRefundInShopify" : {
"type" : "boolean",
"description" : "Whether to create third-party refunds in Shopify"
},
"miraklPaymentWorkflow" : {
"type" : "string",
"description" : "Workflow for handling order payments"
},
"pspTransactionReferenceSource" : {
"type" : "string",
"description" : "Metafield value path to write as imprint number in Mirakl"
},
"useMiraklPayout" : {
"type" : "boolean",
"description" : "Whether to use Mirakl payout"
},
"useTransactionNumberForCaptureFromMetafield" : {
"type" : "boolean",
"description" : "Whether to use transaction number from order metafield for capture"
},
"useTransactionNumberForRefundFromMetafield" : {
"type" : "boolean",
"description" : "Whether to use transaction number from order metafield for refund"
}
}
},
"UpdateSettings_Response_200_Product" : {
"type" : "object",
"description" : "Product settings response",
"properties" : {
"skuGenerations" : {
"type" : "array",
"description" : "Ordered list of SKU generation strategies",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Product_SkuGenerations"
}
}
}
},
"UpdateSettings_Response_200_Product_SkuGenerations" : {
"type" : "object",
"description" : "SKU generation settings response",
"discriminator" : {
"mapping" : {
"MIRAKL_PRODUCT_ID_BASED" : "#/components/schemas/UpdateSettings_Response_200_Product_SkuGenerations_MiraklProductIdBased",
"UNIQUE_IDENTIFIER_BASED" : "#/components/schemas/UpdateSettings_Response_200_Product_SkuGenerations_UniqueIdentifierBased"
},
"propertyName" : "strategy"
},
"properties" : {
"strategy" : {
"type" : "string"
}
}
},
"UpdateSettings_Response_200_Product_SkuGenerations_MiraklProductIdBased" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Product_SkuGenerations"
} ],
"description" : "SKU generation response using Mirakl product ID with a prefix",
"properties" : {
"prefix" : {
"type" : "string",
"description" : "Prefix to prepend to the Mirakl product ID"
}
}
},
"UpdateSettings_Response_200_Product_SkuGenerations_UniqueIdentifierBased" : {
"type" : "object",
"allOf" : [ {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Product_SkuGenerations"
} ],
"description" : "SKU generation response using a unique identifier attribute",
"properties" : {
"attributeCode" : {
"type" : "string",
"description" : "Mirakl attribute code with UNIQUE_IDENTIFIER role"
}
}
},
"UpdateSettings_Response_200_RootAttributes" : {
"type" : "object",
"description" : "Response object for Shopify root attribute",
"properties" : {
"code" : {
"type" : "string",
"description" : "The Shopify root attribute code"
}
}
},
"UpdateSettings_Response_200_ShippingZoneMapping" : {
"type" : "object",
"description" : "Shipping zone mapping response",
"properties" : {
"countries" : {
"type" : "array",
"description" : "List of countries who override the default shipping zone code",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_ShippingZoneMapping_Countries"
}
},
"shippingZone" : {
"type" : "string",
"description" : "The default shipping zone code"
}
}
},
"UpdateSettings_Response_200_ShippingZoneMapping_Countries" : {
"type" : "object",
"properties" : {
"iso2Code" : {
"type" : "string",
"description" : "The ISO 2 code for the country"
},
"provinces" : {
"type" : "array",
"description" : "List of province who override the shipping zone code (not checked if override is found in zips list)",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_ShippingZoneMapping_Countries_Provinces"
}
},
"shippingZone" : {
"type" : "string",
"description" : "The shipping zone for the country"
},
"zips" : {
"type" : "array",
"description" : "List of zip who override the shipping zone code. The code must match the beginning of customer the zip code (ex: `K2` and `K2P` will match the customer zip code `K2P-2L8` but `K2P` will be prioritized)",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_ShippingZoneMapping_Countries_Zips"
}
}
}
},
"UpdateSettings_Response_200_ShippingZoneMapping_Countries_Provinces" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code"
},
"shippingZone" : {
"type" : "string",
"description" : "The shipping zone code"
}
}
},
"UpdateSettings_Response_200_ShippingZoneMapping_Countries_Zips" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The code"
},
"shippingZone" : {
"type" : "string",
"description" : "The shipping zone code"
}
}
},
"UpdateSettings_Response_200_Shop" : {
"type" : "object",
"description" : "Shop settings response",
"properties" : {
"shopMiraklCustomFields" : {
"type" : "array",
"description" : "List of Mirakl shop custom attributes to map",
"items" : {
"$ref" : "#/components/schemas/UpdateSettings_Response_200_Shop_ShopMiraklCustomFields"
}
}
}
},
"UpdateSettings_Response_200_Shop_ShopMiraklCustomFields" : {
"type" : "object",
"description" : "Mirakl shop custom field response",
"properties" : {
"code" : {
"type" : "string",
"description" : "The Mirakl custom field code"
}
}
},
"UpdateSettings_Response_200_TaxonomyMetafields" : {
"type" : "object",
"description" : "Taxonomy metafield response",
"properties" : {
"key" : {
"type" : "string",
"description" : "The unique identifier for the metafield definition within its namespace"
},
"localizable" : {
"type" : "boolean",
"description" : "Whether this metafield can be translated"
},
"namespace" : {
"type" : "string",
"description" : "The namespace for the metafield definition"
},
"ownerType" : {
"type" : "string",
"description" : "The resource type that the metafield definition is attached to (PRODUCT or PRODUCTVARIANT)"
}
}
}
},
"securitySchemes" : {
"Bearer" : {
"bearerFormat" : "JWT",
"scheme" : "bearer",
"type" : "http"
}
}
},
"info" : {
"title" : "Shopify Operator Connector APIs",
"version" : "latest-release"
},
"openapi" : "3.0.1",
"paths" : {
"/api/product-bindings/delete" : {
"post" : {
"description" : "",
"operationId" : "DeleteProductBindings",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteProductBindings_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/DeleteProductBindings_Response_200"
}
}
},
"description" : "Product bindings deleted successfully"
}
},
"summary" : "Delete product bindings",
"tags" : [ "Product Bindings" ]
}
},
"/api/environment" : {
"get" : {
"description" : "",
"operationId" : "GetConnection",
"parameters" : [ ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetConnection_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get the information of the connection between a Shopify store an a Mirakl instance",
"tags" : [ "Connection" ]
}
},
"/api/storefront/custom-carrier" : {
"post" : {
"description" : "Using to display the Mirakl shipment method during the checkout process",
"operationId" : "GetCustomCarrierRates",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomCarrierRates_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetCustomCarrierRates_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get Mirakl custom carrier information",
"tags" : [ "Checkout" ]
}
},
"/api/storefront/evaluations/assessments" : {
"get" : {
"description" : "",
"operationId" : "GetEvaluationsAssessments",
"parameters" : [ {
"description" : "Locale tag used to translate assessment labels (e.g. en_US, fr_FR). Optional — defaults to the operator's primary locale when omitted.",
"explode" : true,
"in" : "query",
"name" : "locale",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/GetEvaluationsAssessments_Response_200"
}
}
}
},
"description" : "OK"
}
},
"summary" : "Get evaluations assessments",
"tags" : [ "Storefront" ]
}
},
"/api/storefront/returns/items-to-return" : {
"get" : {
"description" : "When you want to retrieve items to return for a list of orders",
"operationId" : "GetItemsToReturn",
"parameters" : [ {
"description" : "Mirakl order commercial identifiers separated by comma (e.g. order1,order2,...)",
"explode" : true,
"in" : "query",
"name" : "orderCommercialIds",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetItemsToReturn_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get items to return for a list of orders",
"tags" : [ "Storefront" ]
}
},
"/api/sync/mirakl-offers-sync-error" : {
"get" : {
"description" : "Get a specific offer recoverable error that occurred during the synchronization process.",
"operationId" : "GetOfferRecoverableError",
"parameters" : [ {
"description" : "The product sku: mp-7fe0b646-69bb-4ea5-8da9-fb5ecbeaf862",
"explode" : true,
"in" : "query",
"name" : "discriminant",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetOfferRecoverableError_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get an offer recoverable error",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/platform-settings/operator-return-configurations" : {
"get" : {
"description" : "When you want to retrieve return configurations for the operator",
"operationId" : "GetOperatorReturnConfigurations",
"parameters" : [ ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetOperatorReturnConfigurations_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get return configurations for shops",
"tags" : [ "Platform Settings" ]
}
},
"/api/sync/shopify-orders-sync-error" : {
"get" : {
"description" : "Get a specific order recoverable error that occurred during the synchronization process.",
"operationId" : "GetOrderRecoverableError",
"parameters" : [ {
"description" : "The Shopify order id: gid://shopify/Order/7133529014539",
"explode" : true,
"in" : "query",
"name" : "discriminant",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetOrderRecoverableError_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get an order recoverable error",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/sync/shopify-products-sync-error" : {
"get" : {
"description" : "Get a specific product recoverable error that occurred during the synchronization process.",
"operationId" : "GetProductRecoverableError",
"parameters" : [ {
"description" : "The Shopify id of the product variant: gid://shopify/ProductVariant/51146999824651",
"explode" : true,
"in" : "query",
"name" : "discriminant",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetProductRecoverableError_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get a product recoverable error",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/sync/mirakl-returns-sync-error" : {
"get" : {
"description" : "Get a specific return recoverable error that occurred during the synchronization process.",
"operationId" : "GetReturnRecoverableError",
"parameters" : [ {
"description" : "The Mirakl return id",
"explode" : true,
"in" : "query",
"name" : "discriminant",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetReturnRecoverableError_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get a return recoverable error",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/storefront/returns" : {
"get" : {
"description" : "",
"operationId" : "GetReturns",
"parameters" : [ {
"description" : "Mirakl order commercial identifiers separated by comma (e.g. order1,order2,...)",
"explode" : true,
"in" : "query",
"name" : "orderCommercialIds",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetReturns_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List returns",
"tags" : [ "Storefront" ]
}
},
"/api/storefront/shipment" : {
"get" : {
"description" : "When you want to retrieve shipment details",
"operationId" : "GetShipment",
"parameters" : [ {
"description" : "Shopify fulfillment identifier",
"explode" : true,
"in" : "query",
"name" : "fulfillmentId",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetShipment_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get shipment details by Shopify fulfillment ID",
"tags" : [ "Storefront" ]
}
},
"/api/sync/mirakl-shipments-sync-error" : {
"get" : {
"description" : "Get a specific shipment recoverable error that occurred during the synchronization process.",
"operationId" : "GetShipmentRecoverableError",
"parameters" : [ {
"description" : "The Mirakl shipment id: d4dcfd38-2fa2-4380-80a7-2d7ff7e4d596",
"explode" : true,
"in" : "query",
"name" : "discriminant",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetShipmentRecoverableError_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get a shipment recoverable error",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/public/shipping-fees" : {
"post" : {
"description" : "Using to display shipping methods per seller during the checkout process",
"operationId" : "GetShippingFees",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetShippingFees_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetShippingFees_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get shipping fees",
"tags" : [ "Public" ]
}
},
"/api/sync/mirakl-shops-sync-error" : {
"get" : {
"description" : "Get a specific shop recoverable error that occurred during the synchronization process.",
"operationId" : "GetShopRecoverableError",
"parameters" : [ {
"description" : "The Mirakl shop id: 2000",
"explode" : true,
"in" : "query",
"name" : "discriminant",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/GetShopRecoverableError_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Get a shop recoverable error",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/environment-dev" : {
"delete" : {
"description" : "",
"operationId" : "HardDeleteConnectionDev",
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "OK"
}
},
"summary" : "Hard delete environment for dev/test only",
"tags" : [ "Connection" ]
}
},
"/api/product-bindings" : {
"post" : {
"description" : "",
"operationId" : "ImportProductBindings",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ImportProductBindings_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ImportProductBindings_Response_200"
}
}
},
"description" : "Product bindings imported successfully"
}
},
"summary" : "Import product bindings",
"tags" : [ "Product Bindings" ]
},
"get" : {
"description" : "",
"operationId" : "ListProductBindings",
"parameters" : [ {
"description" : "Filter by variant group code",
"explode" : true,
"in" : "query",
"name" : "variantGroupCode",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Filter by SKU",
"explode" : true,
"in" : "query",
"name" : "sku",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Filter by Shopify GID",
"explode" : true,
"in" : "query",
"name" : "shopifyGid",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Filter by Mirakl product ID",
"explode" : true,
"in" : "query",
"name" : "miraklProductId",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "Maximum number of items returned per page",
"in" : "query",
"name" : "max",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "Index of the first item (among all the results) in the returned page",
"in" : "query",
"name" : "offset",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "How the results should be sorted",
"in" : "query",
"name" : "sort",
"schema" : {
"type" : "string"
}
}, {
"description" : "Sort direction",
"in" : "query",
"name" : "order",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListProductBindings_Response_200"
}
}
},
"description" : "Product bindings listed successfully"
}
},
"summary" : "List product bindings",
"tags" : [ "Product Bindings" ]
}
},
"/api/storefront/orders/accounting-documents" : {
"get" : {
"description" : "Retrieves a list of accounting documents for specified Mirakl orders, with secure URLs for downloading each document.",
"operationId" : "ListAccountingOrdersDocuments",
"parameters" : [ {
"description" : "Mirakl orders identifier",
"explode" : true,
"in" : "query",
"name" : "orderIds",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListAccountingOrdersDocuments_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List accounting orders documents",
"tags" : [ "Storefront" ]
}
},
"/api/sync/mirakl-offers-sync-errors" : {
"get" : {
"description" : "List the offer recoverable errors that occurred during the synchronization process.
You can filter the list by offset and max.",
"operationId" : "ListOfferRecoverableErrors",
"parameters" : [ {
"description" : "Maximum number of items returned per page",
"in" : "query",
"name" : "max",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "Index of the first item (among all the results) in the returned page",
"in" : "query",
"name" : "offset",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "How the results should be sorted",
"in" : "query",
"name" : "sort",
"schema" : {
"type" : "string"
}
}, {
"description" : "Sort direction",
"in" : "query",
"name" : "order",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListOfferRecoverableErrors_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List the offer recoverable errors",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/sync/shopify-orders-sync-errors" : {
"get" : {
"description" : "List the order recoverable errors that occurred during the synchronization process.
You can filter the list by offset and max.",
"operationId" : "ListOrderRecoverableErrors",
"parameters" : [ {
"description" : "Maximum number of items returned per page",
"in" : "query",
"name" : "max",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "Index of the first item (among all the results) in the returned page",
"in" : "query",
"name" : "offset",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "How the results should be sorted",
"in" : "query",
"name" : "sort",
"schema" : {
"type" : "string"
}
}, {
"description" : "Sort direction",
"in" : "query",
"name" : "order",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListOrderRecoverableErrors_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List the order recoverable errors",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/mapping/returns/{orderId}" : {
"get" : {
"description" : "Returns all Mirakl marketplace returns tracked for the given Shopify order, ordered by creation date descending.",
"operationId" : "ListOrderReturnMappings",
"parameters" : [ {
"description" : "Shopify Order identifier (= mirakl_order_commercial_id)",
"explode" : false,
"in" : "path",
"name" : "orderId",
"required" : true,
"schema" : {
"type" : "string"
},
"style" : "simple"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ListOrderReturnMappings_Response_200"
}
}
}
},
"description" : "OK"
}
},
"summary" : "List Mirakl returns for a Shopify order",
"tags" : [ "Mapping" ]
}
},
"/api/mapping/transactions/{orderId}" : {
"get" : {
"description" : "Returns all Mirakl transactions (debit, refund, refusal, cancellation, items-not-shippable) tracked for the given Shopify order, ordered by creation date descending.",
"operationId" : "ListOrderTransactionMappings",
"parameters" : [ {
"description" : "Shopify Order identifier (= mirakl_commercial_id)",
"explode" : false,
"in" : "path",
"name" : "orderId",
"required" : true,
"schema" : {
"type" : "string"
},
"style" : "simple"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ListOrderTransactionMappings_Response_200"
}
}
}
},
"description" : "OK"
}
},
"summary" : "List Mirakl transactions for a Shopify order",
"tags" : [ "Mapping" ]
}
},
"/api/storefront/orders/documents" : {
"get" : {
"description" : "Retrieves a list of general order documents for specified Mirakl orders, with secure URLs for downloading each document.",
"operationId" : "ListOrdersDocuments",
"parameters" : [ {
"description" : "Mirakl orders identifier",
"explode" : true,
"in" : "query",
"name" : "orderIds",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListOrdersDocuments_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List orders documents",
"tags" : [ "Storefront" ]
}
},
"/api/storefront/products/offers" : {
"get" : {
"description" : "Calls the Mirakl P11 API and returns a trimmed payload tailored to the PDP.",
"operationId" : "ListProductOffers",
"parameters" : [ {
"description" : "Mirakl product SKUs separated by comma (max 100)",
"explode" : true,
"in" : "query",
"name" : "productIds",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"maxItems" : 100,
"minItems" : 0
},
"style" : "form"
}, {
"description" : "Locale tag used to translate localized fields (e.g. en_US, fr_FR). Optional - defaults to the operator's primary locale when omitted.",
"explode" : true,
"in" : "query",
"name" : "locale",
"schema" : {
"type" : "string"
},
"style" : "form"
}, {
"description" : "List of shipping zones. Filter used to pick shipping prices on one or multiple shipping zones",
"explode" : true,
"in" : "query",
"name" : "shippingZones",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"style" : "form"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListProductOffers_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List offers for each given product",
"tags" : [ "Storefront" ]
}
},
"/api/sync/shopify-products-sync-errors" : {
"get" : {
"description" : "List the product recoverable errors that occurred during the synchronization process.
You can filter the list by offset and max.",
"operationId" : "ListProductRecoverableErrors",
"parameters" : [ {
"description" : "Maximum number of items returned per page",
"in" : "query",
"name" : "max",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "Index of the first item (among all the results) in the returned page",
"in" : "query",
"name" : "offset",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "How the results should be sorted",
"in" : "query",
"name" : "sort",
"schema" : {
"type" : "string"
}
}, {
"description" : "Sort direction",
"in" : "query",
"name" : "order",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListProductRecoverableErrors_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List the product recoverable errors",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/sync/mirakl-returns-sync-errors" : {
"get" : {
"description" : "List the return recoverable errors that occurred during the synchronization process.
You can filter the list by offset and max.",
"operationId" : "ListReturnRecoverableErrors",
"parameters" : [ {
"description" : "Maximum number of items returned per page",
"in" : "query",
"name" : "max",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "Index of the first item (among all the results) in the returned page",
"in" : "query",
"name" : "offset",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "How the results should be sorted",
"in" : "query",
"name" : "sort",
"schema" : {
"type" : "string"
}
}, {
"description" : "Sort direction",
"in" : "query",
"name" : "order",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListReturnRecoverableErrors_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List the return recoverable errors",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/settings" : {
"get" : {
"description" : "",
"operationId" : "ListSettings",
"parameters" : [ ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListSettings_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List connector settings",
"tags" : [ "Settings" ]
},
"patch" : {
"description" : "Update your environment settings information field by field: unspecified fields will not be updated.",
"operationId" : "UpdateSettings",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateSettings_Request"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/UpdateSettings_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Update connector settings",
"tags" : [ "Settings" ]
}
},
"/api/sync/mirakl-shipments-sync-errors" : {
"get" : {
"description" : "List the shipment recoverable errors that occurred during the synchronization process.
You can filter the list by offset and max.",
"operationId" : "ListShipmentRecoverableErrors",
"parameters" : [ {
"description" : "Maximum number of items returned per page",
"in" : "query",
"name" : "max",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "Index of the first item (among all the results) in the returned page",
"in" : "query",
"name" : "offset",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "How the results should be sorted",
"in" : "query",
"name" : "sort",
"schema" : {
"type" : "string"
}
}, {
"description" : "Sort direction",
"in" : "query",
"name" : "order",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListShipmentRecoverableErrors_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List the shipment recoverable errors",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/storefront/shop-ratings/{shopId}" : {
"get" : {
"description" : "",
"operationId" : "ListShopEvaluations",
"parameters" : [ {
"description" : "Mirakl shop identifier",
"explode" : false,
"in" : "path",
"name" : "shopId",
"required" : true,
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"description" : "Maximum number of items returned per page",
"in" : "query",
"name" : "max",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "Index of the first item (among all the results) in the returned page",
"in" : "query",
"name" : "offset",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "How the results should be sorted",
"in" : "query",
"name" : "sort",
"schema" : {
"type" : "string"
}
}, {
"description" : "Sort direction",
"in" : "query",
"name" : "order",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListShopEvaluations_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List evaluations of a shop",
"tags" : [ "Storefront" ]
}
},
"/api/sync/mirakl-shops-sync-errors" : {
"get" : {
"description" : "List the shop recoverable errors that occurred during the synchronization process.
You can filter the list by offset and max.",
"operationId" : "ListShopRecoverableErrors",
"parameters" : [ {
"description" : "Maximum number of items returned per page",
"in" : "query",
"name" : "max",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "Index of the first item (among all the results) in the returned page",
"in" : "query",
"name" : "offset",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"description" : "How the results should be sorted",
"in" : "query",
"name" : "sort",
"schema" : {
"type" : "string"
}
}, {
"description" : "Sort direction",
"in" : "query",
"name" : "order",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/ListShopRecoverableErrors_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "List the shop recoverable errors",
"tags" : [ "Synchronization Errors" ]
}
},
"/api/storefront/graphql" : {
"post" : {
"description" : "For security reasons, not all fields are available depending on the context. For example, it is not possible to query the additional fields from the storefront.
For offers queries, the customer location headers are used to resolve the operator shipping zone, which always overwrites the shippingZones filter of the offers input before the query is forwarded to Mirakl. When the X-Customer-Country header is absent, the query is forwarded unchanged.",
"operationId" : "MiraklGraphQL",
"parameters" : [ {
"deprecated" : false,
"description" : "ISO2 country code of the customer (case-insensitive), used to resolve the operator shipping zone injected in offers queries",
"explode" : false,
"in" : "header",
"name" : "X-Customer-Country",
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"deprecated" : false,
"description" : "Zip/postal code of the customer, used to refine the shipping zone resolution. Ignored when X-Customer-Country is absent",
"explode" : false,
"in" : "header",
"name" : "X-Customer-Zip",
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"deprecated" : false,
"description" : "Province/state code of the customer, used to refine the shipping zone resolution. Ignored when X-Customer-Country is absent",
"explode" : false,
"in" : "header",
"name" : "X-Customer-Province",
"schema" : {
"type" : "string"
},
"style" : "simple"
} ],
"responses" : {
"200" : {
"description" : "OK"
}
},
"summary" : "Forward request to Mirakl GraphQL API",
"tags" : [ "Storefront" ]
}
},
"/api/storefront/graphql/upload" : {
"put" : {
"description" : "",
"operationId" : "MiraklGraphQLUpload",
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "OK"
}
},
"summary" : "Forward file upload request to Mirakl GraphQL Upload API",
"tags" : [ "Storefront" ]
}
},
"/api/storefront/fulfillments/receive" : {
"put" : {
"description" : "",
"operationId" : "ReceiveFulfillment",
"parameters" : [ {
"description" : "Shopify fulfillment identifier",
"explode" : true,
"in" : "query",
"name" : "fulfillmentId",
"schema" : {
"type" : "string"
},
"style" : "form"
} ],
"responses" : {
"200" : {
"description" : "OK"
}
},
"summary" : "Confirm the reception of a fulfillment",
"tags" : [ "Storefront" ]
}
},
"/api/setup/check-consistency" : {
"get" : {
"description" : "Description: Verifies whether the data initialized during the application's installation is still up to date. It compares the currently used data with the initial or expected version and returns an update status indicator. This ensures data consistency and helps detect potential refresh needs.",
"operationId" : "SetupCheckConsistency",
"parameters" : [ ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/SetupCheckConsistency_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Check initialized data",
"tags" : [ "Setup" ]
}
},
"/api/setup/check-permissions" : {
"get" : {
"description" : "Verify Shopify App has all the required permissions granted.",
"operationId" : "SetupCheckPermissions",
"parameters" : [ ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/SetupCheckPermissions_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Check Shopify permissions",
"tags" : [ "Setup" ]
}
},
"/api/setup/update" : {
"post" : {
"description" : "Updates all the data that was initialized during the application's installation. It ensures that the latest versions of the required data are applied, maintaining consistency and preventing outdated information from affecting the system's functionality.",
"operationId" : "SetupUpdate",
"parameters" : [ ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"$ref" : "#/components/schemas/SetupUpdate_Response_200"
}
}
},
"description" : "OK"
}
},
"summary" : "Update initialized data",
"tags" : [ "Setup" ]
}
},
"/api/sync/taxonomy" : {
"post" : {
"description" : "Synchronize categories and attributes from Shopify to Mirakl. This operation is asynchronous.",
"operationId" : "SyncCatalogStructure",
"parameters" : [ ],
"responses" : {
"202" : {
"description" : "A taxonomy synchronization task has been created."
},
"425" : {
"description" : "A taxonomy synchronization task is already running. Please wait for the task to complete before starting a new one."
}
},
"summary" : "Synchronize your Shopify catalog structure to Mirakl",
"tags" : [ "Synchronization" ]
}
},
"/api/sync/deleted-mirakl-products" : {
"post" : {
"description" : "Deletes third-party (3P) products from Shopify that have been deleted in Mirakl. This operation also cleans up the middleware by deleting the corresponding product bindings for both third-party (3P) and first-party (1P) products. The operation is asynchronous and scheduled to run periodically, so manual triggering is typically not required.",
"operationId" : "SyncDeletedMiraklProducts",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncDeletedMiraklProducts_Request"
}
}
}
},
"responses" : {
"202" : {
"description" : "A deleted Mirakl products synchronization to Shopify has successfully been scheduled."
},
"425" : {
"description" : "A deleted Mirakl products synchronization to Shopify task is already running. Please wait for the task to complete before starting a new one."
}
},
"summary" : "Synchronize deleted products from Mirakl to Shopify",
"tags" : [ "Synchronization" ]
}
},
"/api/sync/product-shopify-to-mirakl" : {
"post" : {
"description" : "Synchronize products from Shopify to Mirakl. This operation is asynchronous.",
"operationId" : "SyncFirstPartyProducts",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncFirstPartyProducts_Request"
}
}
}
},
"responses" : {
"202" : {
"description" : "A product synchronization from Shopify to Mirak has successfully been scheduled."
},
"425" : {
"description" : "A product synchronization from Shopify to Mirakl task is already running. Please wait for the task to complete before starting a new one."
}
},
"summary" : "Synchronize first-party products from Shopify to Mirakl",
"tags" : [ "Synchronization" ]
}
},
"/api/sync/offer-conditions" : {
"post" : {
"description" : "Synchronizes offer conditions from Mirakl to Shopify.",
"operationId" : "SyncOfferConditions",
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "Synchronization completed successfully"
},
"400" : {
"description" : "One or more offer conditions could not be synchronized"
}
},
"summary" : "Synchronize offer conditions from Mirakl to Shopify",
"tags" : [ "Synchronization" ]
}
},
"/api/sync/offers" : {
"post" : {
"description" : "Import offers from Mirakl into Shopify. This operation is asynchronous and is scheduled to run periodically, so in most cases, you don't need to trigger it manually.",
"operationId" : "SyncOffers",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncOffers_Request"
}
}
}
},
"responses" : {
"202" : {
"description" : "An offer synchronization task has been created."
},
"425" : {
"description" : "An offer synchronization task is already running. Please wait for the task to complete before starting a new one."
}
},
"summary" : "Sync Offers",
"tags" : [ "Synchronization" ]
}
},
"/api/sync/orders" : {
"post" : {
"description" : "Synchronize orders between Mirakl and Shopify. This operation is asynchronous.",
"operationId" : "SyncOrders",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncOrders_Request"
}
}
}
},
"responses" : {
"202" : {
"description" : "An order synchronization task has been created."
},
"425" : {
"description" : "An order synchronization task is already running. Please wait for the task to complete before starting a new one."
}
},
"summary" : "Synchronize orders between Mirakl and Shopify",
"tags" : [ "Synchronization" ]
}
},
"/api/sync/returns" : {
"post" : {
"description" : "Synchronizes returns from Mirakl to Shopify. This operation is asynchronous.",
"operationId" : "SyncReturns",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncReturns_Request"
}
}
}
},
"responses" : {
"202" : {
"description" : "A return synchronization has successfully been scheduled."
},
"425" : {
"description" : "A return synchronization task is already running."
}
},
"summary" : "Synchronize returns from Mirakl to Shopify",
"tags" : [ "Synchronization" ]
}
},
"/api/sync/shipment-mirakl-to-shopify" : {
"post" : {
"description" : "Synchronize shipments from Mirakl to Shopify. This operation is asynchronous.",
"operationId" : "SyncShipments",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncShipments_Request"
}
}
}
},
"responses" : {
"202" : {
"description" : "An order synchronization task has been created."
},
"425" : {
"description" : "An order synchronization task is already running. Please wait for the task to complete before starting a new one."
}
},
"summary" : "Synchronize shipments from Mirakl to Shopify",
"tags" : [ "Synchronization" ]
}
},
"/api/sync/shops" : {
"post" : {
"description" : "Synchronizes shops from Mirakl to Shopify. This operation is asynchronous.",
"operationId" : "SyncShops",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncShops_Request"
}
}
}
},
"responses" : {
"202" : {
"description" : "A shop synchronization has successfully been scheduled."
},
"425" : {
"description" : "A shop synchronization task is already running."
}
},
"summary" : "Synchronize shops from Mirakl to Shopify",
"tags" : [ "Synchronization" ]
}
},
"/api/sync/product-mirakl-to-shopify" : {
"post" : {
"description" : "Import products from Mirakl into Shopify. This operation is asynchronous and is scheduled to run periodically, so in most cases, you don't need to trigger it manually.",
"operationId" : "SyncThirdPartyProducts",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncThirdPartyProducts_Request"
}
}
}
},
"responses" : {
"202" : {
"description" : "A product synchronization from Mirakl to Shopify has successfully been scheduled."
},
"425" : {
"description" : "A product synchronization from Mirakl to Shopify task is already running. Please wait for the task to complete before starting a new one."
}
},
"summary" : "Synchronize third-party products from Mirakl to Shopify",
"tags" : [ "Synchronization" ]
}
}
},
"servers" : [ {
"description" : "Shopify production endpoint.",
"url" : "https://operator-shpy.mirakl.net"
} ],
"x-group-parameters" : true
}