API-интерфейсы магазина BigCommerce для заказа

#bigcommerce

#bigcommerce

Вопрос:

Где документация для /api /storefront/orders / *? Я ожидал найти это на этой странице. https://developer.bigcommerce.com/api-docs/cart-and-checkout/working-sf-apis

В частности, документация, которая будет охватывать /api/storefront/orders /:order-id и содержать допустимые входные данные для строки запроса. Я знаю, что вы можете передать include с одним или несколькими значениями в виде строки, разделенной запятой

  • платежи
  • Линейные элементы.физические элементы.Социальные медиа
  • Линейные элементы.физические элементы.параметры
  • Линейные элементы.Цифровые элементы.Социальные медиа
  • Элементы строки.Цифровые элементы.параметры

Редактировать

Контекстный объект шаблона оформления заказа, используемый в themetemplatespagesorder-confirmation.html , имеет следующую схему

 {
     "order_confirmation_content": "goes in the body",
     "checkout_head": "goes in the head",
     "order": {
         "id": 206
     },
     "header_image": "for an img src attribute"
}
  

Ответ №1:

Документацию по API-интерфейсу заказов магазина можно найти здесь:

https://developer.bigcommerce.com/api-reference/orders/storefront-orders-api/order/ordersbyorderidget

Однако, как вы упомянули, есть несколько недокументированных параметров запроса. Они официально не поддерживаются и могут быть изменены в будущем. Это тот случай, когда наша позиция заключается в том, чтобы отложить документирование параметров API до тех пор, пока мы не определим долгосрочную поддержку. Надеюсь, это поможет обеспечить некоторый контекст!

Комментарии:

1. Спасибо. Я не нашел его, потому что искал категорию высокого уровня под названием «StoreFront API», в которой, как я ожидал, будут корзина, оформление заказа и заказы…

2. Жаль, что объект проверки, используемый в themetemplatespagesorder-confirmation.html не документировано…

3. Эй, @JJS, ты имеешь в виду объект checkout, который возвращает order_confirmation_content, checkout_head и номер заказа? Если вы не возражаете отправить мне электронное письмо с несколькими дополнительными деталями, я был бы рад добавить его — просто хочу убедиться, что я все записал правильно.

4. Пропустил вашу правку в исходном сообщении 🙂 Но мне все равно было бы интересно узнать больше о вашем варианте использования.

5. Я отправил тебе электронное письмо