Детали заказа

Узнайте, как работает конечная точка деталей заказа.

Конечная точка orderDetail используется для безопасного получения деталей заказа и статуса заказа, завершенного через Zonos Checkout.

Конечная точка

Примечание: Ключи ответа могут быть изменены и/или могут быть добавлены дополнительные ключи. Если вы собираетесь использовать конечную точку, пожалуйста, настройте свой код с учетом этих возможностей.

POST | `https://api.iglobalstores.com/v2/orderDetail`

HTTPS запрос

поле	замечания
HTTP метод	POST
Конечная точка	`https://api.iglobalstores.com/v2/orderDetail`
Протокол	HTTPS
Формат сообщения	JSON
Заголовок Accept HTTP	Accept: application/json
Заголовок Content-Type HTTP	Content-Type: application/json

JSON ключ/значение в теле запроса

поле	замечания
`orderId` НЕОБЯЗАТЕЛЬНО, если передается параметр `referenceId`	Идентификатор заказа Zonos может быть передан с вашим идентификатором магазина и дефисом или без них (Пример: 123-45678 или 45678). Примечание: После завершения заказа и оплаты клиент будет перенаправлен на страницу Завершения заказа / Благодарности за заказ, размещенную на вашем домене. URL будет содержать параметр строки запроса “orderId”, который будет содержать это значение.`integer / string`
`referenceId` НЕОБЯЗАТЕЛЬНО, если передается параметр “orderId”	Этот параметр используется для поиска данных заказа по уникальному `referenceId`, переданному в конечной точке API Service `createTempCart`. Этот параметр следует оставить пустым или null, если вы собираетесь искать детали заказа на основе параметра `orderId` .`string`
`secret` ОБЯЗАТЕЛЬНО	API секретный GUID, предоставленный Zonos`string`
`storeId` ОБЯЗАТЕЛЬНО	Идентификатор магазина, предоставленный Zonos.`integer`

Ошибки HTTP ответов

Код ошибки	сообщение	значение
415	Неподдерживаемый тип медиа	HTML-сущность. Заголовок HTTP “Content-Type” недействителен.
406	Не приемлемо	HTML-сущность. Заголовок HTTP “Accept” недействителен.
400	Неверный запрос	“error”:”orderId: 999-99999 не является действительным orderId”“error”:”Не удалось найти заказ с orderId: 999-99999”“error”:”Недействительные учетные данные безопасности”“error”:”Недействительное тело запроса”“error”:”Параметр orderId или referenceId обязателен”“error”:”Нельзя указывать оба параметра orderId и referenceId”“error”:”Заказ с orderId: 999-99999 не найден”“error”:”Параметр store обязателен”“error”:”Заказ с referenceId: 999999 для storeId: 999 не найден”“error”:”referenceId: 999999 для storeId: 999 дублируется”“error”:”Не удалось получить заказ с referenceId: 999999”
500	Внутренняя ошибка сервера	“error”:”Не удалось обработать детали заказа”

Определения JSON ответа

поле	заметки
`error`	Этот параметр присутствует только в случае возникновения ошибки и будет содержать описание ошибки.`string`
`order`	Это карта деталей заказа.`JSON строка`
`order.billingZip`	Адрес для выставления счета по заказу - значения были введены в Zonos Checkout.`string`
`orderboxCount`	Это поле описывает коробки, которые будут использованы для отправки заказа, переданные в запрос createTempCart .`string`
`order.carrierAccountNumber`	Номер учетной записи собственного перевозчика посетителя; используется, когда учетные записи перевозчиков посетителей включены`string`
`order.carrierAccountShippingMethod`	Выбранный метод доставки в учетной записи собственного перевозчика посетителя; используется, когда учетные записи перевозчиков посетителей включены`string`
`order.cslListMatch`	Совпадение с Консолидированным списком проверок (CSL). Булевое значение, которое указывает, когда информация о клиенте дала совпадение в Консолидированном списке проверок США и должна быть проверена на возможную связь с отказанными сторонами.`boolean`
`order.customerSelectedShippingName`	Отображаемое имя варианта доставки внутри Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Карта разбивки пошлин/налогов. Примечание - Если применимо, IPF (Международный сбор за обработку) не включен.`JSON строка`
`order.dutyTaxesBreakdown.brokerageFee`	Сумма брокерского сбора в USD; положительное число с плавающей запятой, два десятичных знака`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Сумма сбора за распределение в USD; положительное число с плавающей запятой, два десятичных знака`integer`
`order.dutyTaxesBreakdown.duty`	Сумма пошлины в USD; положительное число с плавающей запятой, два десятичных знака`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Сумма сбора за предоплату в USD; положительное число с плавающей запятой, два десятичных знака`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Сумма НДС/налога на сбор за распределение в USD; положительное число с плавающей запятой, два десятичных знака`integer`
`order.dutyTaxesBreakdown.vatTax`	Сумма НДС/налога в USD, не включает НДС/налог на сбор за распределение; положительное число с плавающей запятой, два десятичных знака`integer`
`order.dutyTaxesTotal`	Общая сумма пошлин и налогов в USD; положительное число с плавающей запятой, два десятичных знака`integer`
`order.foreignCurrencyCode`	Код валюты, в которой была произведена оплата заказа.`string`
`remittance_amount`	Сумма денег, которую необходимо перечислить в конкретную страну (например, НДС Великобритании).`decimal`
`order.grandTotal`	Общая сумма в USD; положительное число с плавающей запятой, два десятичных знака`integer`
`order.grandTotalForeign`	Общая сумма в расчетной валюте; положительное число с плавающей запятой, два десятичных знака`integer`
`order.items`	Список карт товаров. Карта товара содержит детали о товаре, которые были переданы в Zonos Checkout при создании временной корзины. Для получения более подробной информации о свойствах товара, пожалуйста, ознакомьтесь с документацией createTempCart API`JSON строка`
`order.itemsCount`	Количество позиций в заказе`integer`
`order.itemsTotal`	Общая сумма товаров / продукции в USD; положительное число с плавающей запятой, два десятичных знака`integer`
`order.itemsTotalForeign`	Общая сумма товаров / продукции в расчетной валюте; положительное число с плавающей запятой, два десятичных знака`integer`
`order.items[index].height`	Положительное число с плавающей запятой, два десятичных знака`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Положительное число с плавающей запятой, два десятичных знака`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Положительное число с плавающей запятой, два десятичных знака`integer`
`order.items[index].width`	Положительное число с плавающей запятой, два десятичных знака`integer`
`order.items[index].unitPrice`	Положительное число с плавающей запятой, два десятичных знака`integer`
`order.merchantOrderId`	`MerchantOrderId`, связанный с заказом через updateMerchantOrderId API сервисный конечный пункт.`string`
`order.misc1`	Дополнительное значение, связанное с заказом через createTempCart API сервисный конечный пункт.`string`
`order.misc2`	Дополнительное значение, связанное с заказом через createTempCart API сервисный конечный пункт.`string`
`order.misc3`	Дополнительное значение, связанное с заказом через createTempCart API сервисный конечный пункт.`string`
`order.misc4`	Дополнительное значение, связанное с заказом через createTempCart API сервисный конечный пункт.`string`
`order.misc5`	Дополнительное значение, связанное с заказом через createTempCart API сервисный конечный пункт.`string`
`order.misc6`	Дополнительное значение, связанное с заказом через createTempCart API сервисный конечный пункт.`string`
`order.nationalIdentifier`	Дополнительная информация о международном адресе выставления счета для заказа, когда это необходимо. Значения были введены в Zonos Checkout.`string`
`order.notes`	Список заметок; карта заметок содержит детали о заметке заказа.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Булевое значение, указывающее, была ли это заметка, созданная клиентом о заказе, доставке и т.д.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Булевое значение, указывающее, была ли эта заметка помечена как важная
`order.notes[index].note`	Содержимое заметки`string`
`order.optInEmail`	Указывает, что клиент выбрал флажок для "подписки на нашу рассылку" внутри Zonos Checkout. Применимо только в том случае, если вы выбрали отображение этого флажка на странице checkout`boolean`
`order.orderId`	Идентификационный номер заказа в системе Zonos`string`
`order.orderDate`	Временная метка создания заказа в миллисекундах в UTC/GMT.`millis`
`order.orderDateString`	Временная метка создания заказа в строковом формате в UTC/GMT.`string`
`order.orderStatus`	Статус/состояние заказа в системе Zonos. Для получения дополнительной информации о использовании `orderStatus`, пожалуйста, ознакомьтесь с Retrieve an order document here. Дополнительную информацию о статусах заказов можно найти в Update an order document here.`string`
`order.orderStatusDate`	Временная метка в миллисекундах в UTC/GMT последнего изменения `orderStatus` в системе Zonos.`millis`
`order.orderStatusDateString`	Строка временной метки в UTC/GMT последнего изменения `orderStatus` в системе Zonos.`string`
`order.paymentProcessing`	Карта деталей `paymentProcessing`. Некоторые параметры могут не применяться к вашей учетной записи и будут исключены из ответа.`JSON string`
`order.paymentProcessing.captureDate`	Дата захвата платежа в миллисекундах, если доступно. Если Zonos обрабатывает платеж, этот узел исключается из ответа.`millis`
`order.paymentProcessing.captureDateString`	Дата захвата платежа в строковом формате, если доступно. Если Zonos обрабатывает платеж, этот узел исключается из ответа.`string`
`order.paymentProcessing.cardType`	Бренд кредитной карты. Если Zonos обрабатывает платеж, этот узел исключается из ответа.`string`
`order.paymentProcessing.lastFour`	Последние четыре цифры номера кредитной карты для выставления счета. Если Zonos обрабатывает платеж, этот узел исключается из ответа.`string`
`order.paymentProcessing.paymentGateway`	Название платежного шлюза. Если Zonos обрабатывает платеж, будет указано “iGlobal_CC” или “iGlobal_PayPal”.`string`
`order.paymentProcessing.transactionType`	Указывает тип транзакции “AUTH_CAPTURE” или “AUTH_ONLY”. Если Zonos обрабатывает платеж, этот узел исключается из ответа.`string`
`order.poNumber`	Номер заказа на покупку для заказа, указанного внутри Zonos Checkout; используется, когда включены заказы на покупку.`string`
`order.quotedDutyTaxes`	Пошлина и налог, указанные в Zonos Checkout, отображаемые в USD; положительное число с плавающей запятой, два десятичных знака.`integer`
`order.quotedDutyTaxesForeign`	Пошлина и налог, указанные в Zonos Checkout. Отображается в расчетной валюте; положительное число с плавающей запятой, два десятичных знака.`integer`
`order.referenceId`	Уникальный `referenceId`, связанный с заказом через createTempCart API сервисный конечный пункт.`string`
`order.shipComplete`	Указывает, должен ли заказ отправляться несколькими частями.`boolean`
`order.shippingCarrierServiceLevel`	Идентификатор перевозчика и уровня обслуживания для выбранного варианта доставки.`string`
`order.shippingInstructions`	Настраиваемые инструкции для уровня обслуживания доставки.`string`
`order.shippingTotal`	Общая стоимость доставки в USD; положительное число с плавающей запятой, два десятичных знака.`integer`
`order.shippingTotalForeign`	Общая стоимость доставки в расчетной валюте; положительное число с плавающей запятой, два десятичных знака.`integer`
`order.testOrder`	Указывает, является ли заказ тестовым.`boolean`
`order.trackingNumber`	Номер отслеживания, сгенерированный для отправления, если применимо.`string`
`order.zip`	Адрес назначения / доставки для заказа - значения были введены в Zonos Checkout или были переданы в заказ через перенаправление на Zonos Checkout.`string`

Дополнительные типы данных:

order.address1
order.address2
order.address3
order.altPhone
order.billingAddress1
order.billingAddress2
order.billingAddress3
order.billingAltPhone
order.billingCity
order.birthDate
order.billingCompany
order.billingCountryCode
order.billingCountryName
order.billingEmail
order.billingName
order.billingPhone
order.billingState
order.city
order.company
order.countryCode
order.countryName
order.email
order.items[index].countryOfOrigin
order.items[index].description
order.items[index].imageURL
order.items[index].itemBrand
order.items[index].itemCategory
order.items[index].itemColor
order.items[index].itemCustomization
order.items[index].itemDescriptionDetailed
order.items[index].itemDescriptionLong
order.items[index].itemFabricContent
order.items[index].itemHSCode
order.items[index].itemLtlClass
order.items[index].itemMaterial
order.items[index].itemURL
order.items[index].productId
order.items[index].sku
order.items[index].productId
order.items[index].weightUnits
order.name
order.phone
order.state

Была ли эта страница полезной?

Вопросы?

Свяжитесь с нами.

Посмотреть Zonos

политики и соглашения