Что такое конечная точка API Checkout?

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

Какой HTTPS запрос для API Checkout?

HTTPS запрос для API Checkout включает HTTP метод (POST), конечную точку ('https://api.iglobalstores.com/v2/orderDetail'), протокол (HTTPS), формат сообщения (JSON) и заголовки HTTP (Accept: application/json, Content-Type: application/json).

Какие пары ключ/значение JSON находятся в теле запроса?

Пары ключ/значение JSON в теле запроса включают «orderId», «referenceId», «secret» и «storeId». «orderId» и «referenceId» опциональны, но один из них должен быть передан. «secret» и «storeId» обязательны.

Какие возможные ошибочные ответы HTTP?

Возможные ошибочные ответы HTTP включают 415 (Неподдерживаемый тип мультимедиа), 406 (Неприемлемо), 400 (Неверный запрос) и 500 (Внутренняя ошибка сервера). Каждый код ошибки соответствует определенному типу ошибки.

Какие определения JSON ответа?

Определения JSON ответа включают различные параметры, связанные с деталями заказа, такие как «error», «order», «order.billingZip», «orderboxCount», «order.carrierAccountNumber» и многие другие. Каждый параметр предоставляет конкретную информацию о заказе.

Checkout•

ГлавнаяСправочник API REST API Checkout Детали заказа

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

Узнайте, как работает конечная точка «Детали заказа».

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

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

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

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

HTTPS запрос

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

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

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

Ошибочные ответы HTTP

Код ошибки↕	сообщение↕	значение↕
415	Unsupported media type	Сущность HTML. Заголовок HTTP «Content-Type» недействителен.
406	Not Acceptable	Сущность HTML. Заголовок HTTP «Accept» недействителен.
400	Bad Request	"error":"orderId: 999-99999 не является допустимым orderId""error":"Не удалось найти заказ с orderId: 999-99999""error":"Недействительные учетные данные безопасности""error":"Неверное тело запроса""error":"Требуется параметр orderId или referenceId""error":"Невозможно указать оба параметра orderId и referenceId""error":"Заказ с orderId: 999-99999 не найден""error":"Требуется параметр хранилища""error":"Заказ с referenceId: 999999 для storeId: 999 не найден""error":"referenceId: 999999 для storeId: 999 был дублирован""error":"Не удалось получить заказ с referenceId: 999999"
500	Internal Server Error	"error":"Не удалось обработать детали заказа"

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

поле↕	примечания↕
`error`	Этот параметр присутствует только при возникновении ошибки и будет содержать описание ошибки.`string`
`order`	Это карта деталей заказа.`JSON string`
`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 string`
`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 doc`JSON string`
`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`, связанный с заказом через конечную точку API услуги updateMerchantOrderId .`string`
`order.misc1`	Дополнительное значение, связанное с заказом через конечную точку API услуги createTempCart .`string`
`order.misc2`	Дополнительное значение, связанное с заказом через конечную точку API услуги createTempCart .`string`
`order.misc3`	Дополнительное значение, связанное с заказом через конечную точку API услуги createTempCart .`string`
`order.misc4`	Дополнительное значение, связанное с заказом через конечную точку API услуги createTempCart .`string`
`order.misc5`	Дополнительное значение, связанное с заказом через конечную точку API услуги createTempCart .`string`
`order.misc6`	Дополнительное значение, связанное с заказом через конечную точку API услуги createTempCart .`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. Применимо только если вы решили отобразить этот флажок на странице оформления`boolean`
`order.orderId`	Номер идентификации заказа в системе Zonos`string`
`order.orderDate`	Временная метка создания заказа в миллисекундах в UTC/GMT.`millis`
`order.orderDateString`	Временная метка создания заказа в виде строки в UTC/GMT.`string`
`order.orderStatus`	Статус/состояние заказа в системе Zonos. Для получения дополнительной информации об использовании `orderStatus` см. Получить документ заказа здесь. Дополнительную информацию о статусах заказов можно найти в Документе обновления заказа здесь.`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`, связанный с заказом через конечную точку API услуги createTempCart.`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

Записаться на демонстрацию