Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

SD-1551 Add Stock Locations to Platform API (#11496)

Aleksandar Petrushev31f8b371c433
diff --git a/api/app/controllers/spree/api/v2/platform/stock_locations_controller.rb b/api/app/controllers/spree/api/v2/platform/stock_locations_controller.rb
new file mode 100644
index 0000000000..90575056ec
--- /dev/null
+++ b/api/app/controllers/spree/api/v2/platform/stock_locations_controller.rb
@@ -0,0 +1,19 @@
+module Spree
+ module Api
+ module V2
+ module Platform
+ class StockLocationsController < ResourceController
+ private
+
+ def model_class
+ Spree::StockLocation
+ end
+
+ def scope_includes
+ [:country]
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/api/docs/v2/platform/index.yaml b/api/docs/v2/platform/index.yaml
index e1d0be015a..de6b6dd951 100644
--- a/api/docs/v2/platform/index.yaml
+++ b/api/docs/v2/platform/index.yaml
@@ -70,8 +70,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-16T15:43:36.071Z'
- updated_at: '2021-11-16T15:43:36.071Z'
+ created_at: '2021-11-17T08:58:27.524Z'
+ updated_at: '2021-11-17T08:58:27.524Z'
deleted_at:
label:
public_metadata: {}
@@ -100,8 +100,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-16T15:43:36.077Z'
- updated_at: '2021-11-16T15:43:36.077Z'
+ created_at: '2021-11-17T08:58:27.531Z'
+ updated_at: '2021-11-17T08:58:27.531Z'
deleted_at:
label:
public_metadata: {}
@@ -177,8 +177,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-16T15:43:36.436Z'
- updated_at: '2021-11-16T15:43:36.436Z'
+ created_at: '2021-11-17T08:58:27.932Z'
+ updated_at: '2021-11-17T08:58:27.932Z'
deleted_at:
label:
public_metadata: {}
@@ -274,8 +274,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-16T15:43:36.532Z'
- updated_at: '2021-11-16T15:43:36.532Z'
+ created_at: '2021-11-17T08:58:28.037Z'
+ updated_at: '2021-11-17T08:58:28.037Z'
deleted_at:
label:
public_metadata: {}
@@ -356,8 +356,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-16T15:43:36.651Z'
- updated_at: '2021-11-16T15:43:36.665Z'
+ created_at: '2021-11-17T08:58:28.170Z'
+ updated_at: '2021-11-17T08:58:28.183Z'
deleted_at:
label:
public_metadata: {}
@@ -503,8 +503,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-11-16T15:43:37.039Z'
- updated_at: '2021-11-16T15:43:37.039Z'
+ created_at: '2021-11-17T08:58:28.579Z'
+ updated_at: '2021-11-17T08:58:28.579Z'
state: open
included: false
display_amount: "$100.00"
@@ -530,8 +530,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-11-16T15:43:37.070Z'
- updated_at: '2021-11-16T15:43:37.070Z'
+ created_at: '2021-11-17T08:58:28.613Z'
+ updated_at: '2021-11-17T08:58:28.613Z'
state: open
included: false
display_amount: "$100.00"
@@ -604,8 +604,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-11-16T15:43:37.467Z'
- updated_at: '2021-11-16T15:43:37.467Z'
+ created_at: '2021-11-17T08:58:29.126Z'
+ updated_at: '2021-11-17T08:58:29.126Z'
state: open
included: false
display_amount: "$100.00"
@@ -687,8 +687,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-11-16T15:43:37.645Z'
- updated_at: '2021-11-16T15:43:37.653Z'
+ created_at: '2021-11-17T08:58:29.319Z'
+ updated_at: '2021-11-17T08:58:29.326Z'
state: open
included: false
display_amount: "$1.00"
@@ -766,8 +766,8 @@ paths:
label: New label
mandatory:
eligible: true
- created_at: '2021-11-16T15:43:37.962Z'
- updated_at: '2021-11-16T15:43:37.981Z'
+ created_at: '2021-11-17T08:58:29.663Z'
+ updated_at: '2021-11-17T08:58:29.683Z'
state: open
included: false
display_amount: "$15.00"
@@ -907,8 +907,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-16T15:43:38.786Z'
- updated_at: '2021-11-16T15:43:38.786Z'
+ created_at: '2021-11-17T08:58:30.788Z'
+ updated_at: '2021-11-17T08:58:30.788Z'
relationships:
product:
data:
@@ -922,8 +922,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-16T15:43:38.888Z'
- updated_at: '2021-11-16T15:43:38.888Z'
+ created_at: '2021-11-17T08:58:30.981Z'
+ updated_at: '2021-11-17T08:58:30.981Z'
relationships:
product:
data:
@@ -984,8 +984,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-16T15:43:39.580Z'
- updated_at: '2021-11-16T15:43:39.580Z'
+ created_at: '2021-11-17T08:58:31.828Z'
+ updated_at: '2021-11-17T08:58:31.828Z'
relationships:
product:
data:
@@ -1052,8 +1052,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-16T15:43:39.845Z'
- updated_at: '2021-11-16T15:43:39.845Z'
+ created_at: '2021-11-17T08:58:32.141Z'
+ updated_at: '2021-11-17T08:58:32.141Z'
relationships:
product:
data:
@@ -1119,8 +1119,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-16T15:43:40.341Z'
- updated_at: '2021-11-16T15:43:40.341Z'
+ created_at: '2021-11-17T08:58:32.716Z'
+ updated_at: '2021-11-17T08:58:32.716Z'
relationships:
product:
data:
@@ -1264,34 +1264,34 @@ paths:
- id: '1'
type: cms_page
attributes:
- title: Optio nisi illo ipsum maiores quae blanditiis cupiditate.
+ title: Libero iusto cupiditate totam qui omnis exercitationem.
meta_title:
content:
meta_description:
visible: true
- slug: optio-nisi-illo-ipsum-maiores-quae-blanditiis-cupiditate
+ slug: libero-iusto-cupiditate-totam-qui-omnis-exercitationem
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-16T15:43:41.407Z'
- updated_at: '2021-11-16T15:43:41.407Z'
+ created_at: '2021-11-17T08:58:33.932Z'
+ updated_at: '2021-11-17T08:58:33.932Z'
relationships:
cms_sections:
data: []
- id: '2'
type: cms_page
attributes:
- title: Fugiat suscipit illum velit earum neque provident excepturi.
+ title: Delectus nesciunt impedit placeat eveniet fugit.
meta_title:
content:
meta_description:
visible: true
- slug: fugiat-suscipit-illum-velit-earum-neque-provident-excepturi
+ slug: delectus-nesciunt-impedit-placeat-eveniet-fugit
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-16T15:43:41.412Z'
- updated_at: '2021-11-16T15:43:41.412Z'
+ created_at: '2021-11-17T08:58:33.938Z'
+ updated_at: '2021-11-17T08:58:33.938Z'
relationships:
cms_sections:
data: []
@@ -1345,18 +1345,17 @@ paths:
id: '5'
type: cms_page
attributes:
- title: Adipisci voluptatibus quos corporis temporibus illum
- consequuntur ut.
+ title: Enim dicta illo ipsum quos molestiae.
meta_title:
content:
meta_description:
visible: true
- slug: adipisci-voluptatibus-quos-corporis-temporibus-illum-consequuntur-ut
+ slug: enim-dicta-illo-ipsum-quos-molestiae
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-16T15:43:41.552Z'
- updated_at: '2021-11-16T15:43:41.552Z'
+ created_at: '2021-11-17T08:58:34.087Z'
+ updated_at: '2021-11-17T08:58:34.087Z'
relationships:
cms_sections:
data: []
@@ -1422,17 +1421,17 @@ paths:
id: '6'
type: cms_page
attributes:
- title: Officia quo doloremque quia nostrum quis.
+ title: Quis distinctio tempore occaecati perferendis amet.
meta_title:
content:
meta_description:
visible: true
- slug: officia-quo-doloremque-quia-nostrum-quis
+ slug: quis-distinctio-tempore-occaecati-perferendis-amet
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-16T15:43:41.625Z'
- updated_at: '2021-11-16T15:43:41.625Z'
+ created_at: '2021-11-17T08:58:34.181Z'
+ updated_at: '2021-11-17T08:58:34.181Z'
relationships:
cms_sections:
data: []
@@ -1496,12 +1495,12 @@ paths:
content:
meta_description:
visible: true
- slug: voluptates-velit-placeat-laudantium-magnam-voluptas-sequi
+ slug: aperiam-et-esse-deserunt-ipsum-quam-sapiente-voluptatem-non
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-16T15:43:41.809Z'
- updated_at: '2021-11-16T15:43:41.827Z'
+ created_at: '2021-11-17T08:58:34.307Z'
+ updated_at: '2021-11-17T08:58:34.324Z'
relationships:
cms_sections:
data: []
@@ -1630,8 +1629,7 @@ paths:
- id: '1'
type: cms_section
attributes:
- name: Iusto earum voluptates rem atque sequi reiciendis dolores
- veritatis.
+ name: Occaecati ut ullam dolor perferendis.
content: {}
settings:
gutters: No Gutters
@@ -1640,8 +1638,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 1
linked_resource_type: Spree::Taxon
- created_at: '2021-11-16T15:43:42.176Z'
- updated_at: '2021-11-16T15:43:42.176Z'
+ created_at: '2021-11-17T08:58:34.667Z'
+ updated_at: '2021-11-17T08:58:34.667Z'
relationships:
cms_page:
data:
@@ -1652,7 +1650,7 @@ paths:
- id: '2'
type: cms_section
attributes:
- name: Aut ab est voluptatem voluptatibus quam aliquam.
+ name: Necessitatibus quaerat repellat incidunt cupiditate.
content:
link_type_one: Spree::Taxon
link_type_two: Spree::Taxon
@@ -1664,8 +1662,8 @@ paths:
type: Spree::Cms::Sections::ImageGallery
position: 2
linked_resource_type:
- created_at: '2021-11-16T15:43:42.180Z'
- updated_at: '2021-11-16T15:43:42.180Z'
+ created_at: '2021-11-17T08:58:34.673Z'
+ updated_at: '2021-11-17T08:58:34.673Z'
relationships:
cms_page:
data:
@@ -1676,7 +1674,8 @@ paths:
- id: '3'
type: cms_section
attributes:
- name: At aliquid in sed sequi possimus quos.
+ name: Temporibus deleniti delectus repellat unde consequuntur
+ consequatur magni consectetur.
content: {}
settings:
gutters: No Gutters
@@ -1685,8 +1684,8 @@ paths:
type: Spree::Cms::Sections::FeaturedArticle
position: 3
linked_resource_type: Spree::Taxon
- created_at: '2021-11-16T15:43:42.191Z'
- updated_at: '2021-11-16T15:43:42.191Z'
+ created_at: '2021-11-17T08:58:34.687Z'
+ updated_at: '2021-11-17T08:58:34.687Z'
relationships:
cms_page:
data:
@@ -1697,7 +1696,7 @@ paths:
- id: '4'
type: cms_section
attributes:
- name: Dolorum modi rerum quos nostrum enim provident ab.
+ name: Exercitationem aliquam nobis fugiat sunt.
content: {}
settings:
gutters: No Gutters
@@ -1706,8 +1705,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-11-16T15:43:42.202Z'
- updated_at: '2021-11-16T15:43:42.202Z'
+ created_at: '2021-11-17T08:58:34.704Z'
+ updated_at: '2021-11-17T08:58:34.704Z'
relationships:
cms_page:
data:
@@ -1720,8 +1719,7 @@ paths:
- id: '5'
type: cms_section
attributes:
- name: Non error molestiae distinctio autem cupiditate maxime
- dolor repellat.
+ name: Iusto explicabo natus minus debitis hic eum doloribus.
content: {}
settings:
gutters: No Gutters
@@ -1730,8 +1728,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 5
linked_resource_type: Spree::Product
- created_at: '2021-11-16T15:43:42.212Z'
- updated_at: '2021-11-16T15:43:42.212Z'
+ created_at: '2021-11-17T08:58:34.717Z'
+ updated_at: '2021-11-17T08:58:34.717Z'
relationships:
cms_page:
data:
@@ -1791,7 +1789,8 @@ paths:
id: '13'
type: cms_section
attributes:
- name: Voluptas deleniti soluta totam occaecati.
+ name: Laborum quibusdam cupiditate delectus atque eos labore
+ nemo.
content: {}
settings:
gutters: No Gutters
@@ -1800,8 +1799,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 3
linked_resource_type: Spree::Product
- created_at: '2021-11-16T15:43:42.444Z'
- updated_at: '2021-11-16T15:43:42.444Z'
+ created_at: '2021-11-17T08:58:35.103Z'
+ updated_at: '2021-11-17T08:58:35.103Z'
relationships:
cms_page:
data:
@@ -1876,7 +1875,7 @@ paths:
id: '19'
type: cms_section
attributes:
- name: Quos id magni maxime vitae quia pariatur.
+ name: Repellendus explicabo quos debitis magni similique quae.
content: {}
settings:
gutters: No Gutters
@@ -1885,8 +1884,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-11-16T15:43:42.648Z'
- updated_at: '2021-11-16T15:43:42.648Z'
+ created_at: '2021-11-17T08:58:35.352Z'
+ updated_at: '2021-11-17T08:58:35.352Z'
relationships:
cms_page:
data:
@@ -1960,8 +1959,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 1
linked_resource_type: Spree::Product
- created_at: '2021-11-16T15:43:42.958Z'
- updated_at: '2021-11-16T15:43:42.974Z'
+ created_at: '2021-11-17T08:58:35.730Z'
+ updated_at: '2021-11-17T08:58:35.746Z'
relationships:
cms_page:
data:
@@ -2081,9 +2080,9 @@ paths:
name: United States of America
numcode: 840
states_required: true
- updated_at: '2021-11-16T15:43:43.578Z'
+ updated_at: '2021-11-17T08:58:36.545Z'
zipcode_required: true
- created_at: '2021-11-16T15:43:43.578Z'
+ created_at: '2021-11-17T08:58:36.545Z'
relationships:
states:
data: []
@@ -2096,9 +2095,9 @@ paths:
name: NAME_2
numcode: 840
states_required: false
- updated_at: '2021-11-16T15:43:43.585Z'
+ updated_at: '2021-11-17T08:58:36.553Z'
zipcode_required: true
- created_at: '2021-11-16T15:43:43.585Z'
+ created_at: '2021-11-17T08:58:36.553Z'
relationships:
states:
data: []
@@ -2111,9 +2110,9 @@ paths:
name: NAME_3
numcode: 840
states_required: false
- updated_at: '2021-11-16T15:43:43.588Z'
+ updated_at: '2021-11-17T08:58:36.558Z'
zipcode_required: true
- created_at: '2021-11-16T15:43:43.588Z'
+ created_at: '2021-11-17T08:58:36.558Z'
relationships:
states:
data: []
@@ -2172,9 +2171,9 @@ paths:
name: NAME_6
numcode: 840
states_required: false
- updated_at: '2021-11-16T15:43:43.677Z'
+ updated_at: '2021-11-17T08:58:36.669Z'
zipcode_required: true
- created_at: '2021-11-16T15:43:43.677Z'
+ created_at: '2021-11-17T08:58:36.669Z'
relationships:
states:
data: []
@@ -2232,7 +2231,7 @@ paths:
- id: '1'
type: digital_link
attributes:
- token: D5ZGuFh4kuE9A6F3qc9Hs6gM
+ token: nuiYcLrbrkSsTyaPCHfGEfBa
access_counter: 0
relationships:
digital:
@@ -2246,7 +2245,7 @@ paths:
- id: '2'
type: digital_link
attributes:
- token: 5xJ1A9HLisKrDZwDfiNQEMxF
+ token: sxhLyyWCiQv5ef5iDKYMq7vw
access_counter: 0
relationships:
digital:
@@ -2300,7 +2299,7 @@ paths:
id: '5'
type: digital_link
attributes:
- token: cTWPyUE6a3wwGWZ5FMJxkR96
+ token: yy6BSSYWsyduQdSs8josXWqq
access_counter: 0
relationships:
digital:
@@ -2363,7 +2362,7 @@ paths:
id: '6'
type: digital_link
attributes:
- token: BdM1kgUabseQGhWiToDr2N3H
+ token: XVPRFqKvkmvTZyqXh6it8Ve6
access_counter: 0
relationships:
digital:
@@ -2422,7 +2421,7 @@ paths:
id: '8'
type: digital_link
attributes:
- token: GpTF9pyqQMcZYp9Pk966ddPX
+ token: Zxtm4L5NqdZEJUDAgzbLdV7a
access_counter: 0
relationships:
digital:
@@ -2537,7 +2536,7 @@ paths:
id: '13'
type: digital_link
attributes:
- token: MaKuPgdGXAxpJBTfBgA7Qtxx
+ token: yejFsjWDXrujT8Etdz3T5qPM
access_counter: 0
relationships:
digital:
@@ -2609,7 +2608,7 @@ paths:
- id: '15'
type: digital
attributes:
- url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBJQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--1623ea2b9ed788d7d24f66bc34c2b125868ff345/thinking-cat.jpg"
+ url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBJQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--139889339da605b73416a7b84e0e5978f974c889/thinking-cat.jpg"
content_type: image/jpeg
filename: thinking-cat.jpg
byte_size: 18090
@@ -2621,7 +2620,7 @@ paths:
- id: '16'
type: digital
attributes:
- url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBJUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c0f37a85ca6119585a6377b0b5654d336e0299bd/thinking-cat.jpg"
+ url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBJUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--41f6331d4c5177a4f37da7d04fe69467cd773301/thinking-cat.jpg"
content_type: image/jpeg
filename: thinking-cat.jpg
byte_size: 18090
@@ -2633,7 +2632,7 @@ paths:
- id: '17'
type: digital
attributes:
- url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBJZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--a3992c7650dec5bc0877fdceb0695f6b201efc38/thinking-cat.jpg"
+ url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBJZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--f7d6d648dc4bb29032d46648c28547974a4c2754/thinking-cat.jpg"
content_type: image/jpeg
filename: thinking-cat.jpg
byte_size: 18090
@@ -2692,7 +2691,7 @@ paths:
id: '24'
type: digital
attributes:
- url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBLUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--20c0fe7f26f9118f852a2fa5a8d8f5186feacb53/icon_256x256.jpg"
+ url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBLUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--52590f82a73468b5fe5a4ade78c290e564de329b/icon_256x256.jpg"
content_type: image/png
filename: icon_256x256.jpg
byte_size: 818
@@ -2757,7 +2756,7 @@ paths:
id: '28'
type: digital
attributes:
- url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBMUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--20e5c2088245d70d24543ee1705724b4734239be/thinking-cat.jpg"
+ url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBMUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--39595a1e731b502858309ee8c2772fc796f406cc/thinking-cat.jpg"
content_type: image/jpeg
filename: thinking-cat.jpg
byte_size: 18090
@@ -2821,7 +2820,7 @@ paths:
id: '36'
type: digital
attributes:
- url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBPQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--f32f69a558155710b5b08f7ce33ed56d81faad02/icon_256x256.jpg"
+ url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBPQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--da0a36cb1f998ff6c37283f117552f561f570413/icon_256x256.jpg"
content_type: image/png
filename: icon_256x256.jpg
byte_size: 818
@@ -2954,8 +2953,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-11-16T15:43:55.734Z'
- updated_at: '2021-11-16T15:43:55.745Z'
+ created_at: '2021-11-17T08:58:50.441Z'
+ updated_at: '2021-11-17T08:58:50.466Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -2967,10 +2966,6 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_price: "$10.00"
- single_display_amount: "$10.00"
- display_discounted_amount: "$10.00"
- display_total: "$10.00"
display_amount: "$10.00"
display_subtotal: "$10.00"
display_final_amount: "$10.00"
@@ -2979,6 +2974,10 @@ paths:
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
display_pre_tax_amount: "$10.00"
+ display_price: "$10.00"
+ single_display_amount: "$10.00"
+ display_discounted_amount: "$10.00"
+ display_total: "$10.00"
relationships:
order:
data:
@@ -3003,8 +3002,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-11-16T15:43:55.805Z'
- updated_at: '2021-11-16T15:43:55.812Z'
+ created_at: '2021-11-17T08:58:50.529Z'
+ updated_at: '2021-11-17T08:58:50.538Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3016,10 +3015,6 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_price: "$10.00"
- single_display_amount: "$10.00"
- display_discounted_amount: "$10.00"
- display_total: "$10.00"
display_amount: "$10.00"
display_subtotal: "$10.00"
display_final_amount: "$10.00"
@@ -3028,6 +3023,10 @@ paths:
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
display_pre_tax_amount: "$10.00"
+ display_price: "$10.00"
+ single_display_amount: "$10.00"
+ display_discounted_amount: "$10.00"
+ display_total: "$10.00"
relationships:
order:
data:
@@ -3099,8 +3098,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-11-16T15:43:56.143Z'
- updated_at: '2021-11-16T15:43:56.191Z'
+ created_at: '2021-11-17T08:58:50.920Z'
+ updated_at: '2021-11-17T08:58:50.966Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3112,10 +3111,6 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_price: "$10.00"
- single_display_amount: "$10.00"
- display_discounted_amount: "$10.00"
- display_total: "$10.00"
display_amount: "$10.00"
display_subtotal: "$10.00"
display_final_amount: "$10.00"
@@ -3124,6 +3119,10 @@ paths:
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
display_pre_tax_amount: "$10.00"
+ display_price: "$10.00"
+ single_display_amount: "$10.00"
+ display_discounted_amount: "$10.00"
+ display_total: "$10.00"
relationships:
order:
data:
@@ -3204,8 +3203,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-11-16T15:43:56.496Z'
- updated_at: '2021-11-16T15:43:56.506Z'
+ created_at: '2021-11-17T08:58:51.218Z'
+ updated_at: '2021-11-17T08:58:51.231Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3217,10 +3216,6 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_price: "$10.00"
- single_display_amount: "$10.00"
- display_discounted_amount: "$10.00"
- display_total: "$10.00"
display_amount: "$10.00"
display_subtotal: "$10.00"
display_final_amount: "$10.00"
@@ -3229,6 +3224,10 @@ paths:
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
display_pre_tax_amount: "$10.00"
+ display_price: "$10.00"
+ single_display_amount: "$10.00"
+ display_discounted_amount: "$10.00"
+ display_total: "$10.00"
relationships:
order:
data:
@@ -3305,8 +3304,8 @@ paths:
attributes:
quantity: 4
price: '10.0'
- created_at: '2021-11-16T15:43:56.841Z'
- updated_at: '2021-11-16T15:43:56.890Z'
+ created_at: '2021-11-17T08:58:51.635Z'
+ updated_at: '2021-11-17T08:58:51.701Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3318,10 +3317,6 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_price: "$10.00"
- single_display_amount: "$10.00"
- display_discounted_amount: "$40.00"
- display_total: "$40.00"
display_amount: "$40.00"
display_subtotal: "$40.00"
display_final_amount: "$40.00"
@@ -3330,6 +3325,10 @@ paths:
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
display_pre_tax_amount: "$40.00"
+ display_price: "$10.00"
+ single_display_amount: "$10.00"
+ display_discounted_amount: "$40.00"
+ display_total: "$40.00"
relationships:
order:
data:
@@ -3358,10 +3357,10 @@ paths:
examples:
Example:
value:
- error: 'Quantity selected of "Product #127 - 7991" is not available.'
+ error: 'Quantity selected of "Product #127 - 5769" is not available.'
errors:
quantity:
- - 'selected of "Product #127 - 7991" is not available.'
+ - 'selected of "Product #127 - 5769" is not available.'
schema:
"$ref": "#/components/schemas/validation_errors"
'404':
@@ -3481,8 +3480,8 @@ paths:
lft: 2
rgt: 3
depth: 1
- created_at: '2021-11-16T15:43:57.719Z'
- updated_at: '2021-11-16T15:43:57.725Z'
+ created_at: '2021-11-17T08:58:52.768Z'
+ updated_at: '2021-11-17T08:58:52.774Z'
link:
is_container: false
is_root: false
@@ -3518,8 +3517,8 @@ paths:
lft: 4
rgt: 5
depth: 1
- created_at: '2021-11-16T15:43:57.810Z'
- updated_at: '2021-11-16T15:43:57.817Z'
+ created_at: '2021-11-17T08:58:52.860Z'
+ updated_at: '2021-11-17T08:58:52.867Z'
link:
is_container: false
is_root: false
@@ -3555,8 +3554,8 @@ paths:
lft: 6
rgt: 7
depth: 1
- created_at: '2021-11-16T15:43:57.902Z'
- updated_at: '2021-11-16T15:43:57.909Z'
+ created_at: '2021-11-17T08:58:53.052Z'
+ updated_at: '2021-11-17T08:58:53.078Z'
link:
is_container: false
is_root: false
@@ -3592,8 +3591,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-11-16T15:43:57.998Z'
- updated_at: '2021-11-16T15:43:58.005Z'
+ created_at: '2021-11-17T08:58:53.243Z'
+ updated_at: '2021-11-17T08:58:53.250Z'
link:
is_container: false
is_root: false
@@ -3629,8 +3628,8 @@ paths:
lft: 10
rgt: 11
depth: 1
- created_at: '2021-11-16T15:43:58.093Z'
- updated_at: '2021-11-16T15:43:58.100Z'
+ created_at: '2021-11-17T08:58:53.339Z'
+ updated_at: '2021-11-17T08:58:53.347Z'
link:
is_container: false
is_root: false
@@ -3666,8 +3665,8 @@ paths:
lft: 12
rgt: 13
depth: 1
- created_at: '2021-11-16T15:43:58.203Z'
- updated_at: '2021-11-16T15:43:58.210Z'
+ created_at: '2021-11-17T08:58:53.435Z'
+ updated_at: '2021-11-17T08:58:53.442Z'
link:
is_container: false
is_root: false
@@ -3703,8 +3702,8 @@ paths:
lft: 14
rgt: 15
depth: 1
- created_at: '2021-11-16T15:43:58.301Z'
- updated_at: '2021-11-16T15:43:58.308Z'
+ created_at: '2021-11-17T08:58:53.529Z'
+ updated_at: '2021-11-17T08:58:53.536Z'
link:
is_container: false
is_root: false
@@ -3730,7 +3729,7 @@ paths:
- id: '1'
type: menu_item
attributes:
- name: Officiis nulla labore illum sed voluptates excepturi.
+ name: Impedit aliquid ratione eum quas id.
subtitle:
destination:
new_window: false
@@ -3740,8 +3739,8 @@ paths:
lft: 1
rgt: 16
depth: 0
- created_at: '2021-11-16T15:43:57.632Z'
- updated_at: '2021-11-16T15:43:58.321Z'
+ created_at: '2021-11-17T08:58:52.682Z'
+ updated_at: '2021-11-17T08:58:53.551Z'
link:
is_container: true
is_root: true
@@ -3834,8 +3833,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-11-16T15:43:59.548Z'
- updated_at: '2021-11-16T15:43:59.556Z'
+ created_at: '2021-11-17T08:58:54.710Z'
+ updated_at: '2021-11-17T08:58:54.717Z'
link:
is_container: false
is_root: false
@@ -3925,8 +3924,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-11-16T15:44:00.416Z'
- updated_at: '2021-11-16T15:44:00.422Z'
+ created_at: '2021-11-17T08:58:55.460Z'
+ updated_at: '2021-11-17T08:58:55.467Z'
link:
is_container: false
is_root: false
@@ -4014,8 +4013,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-11-16T15:44:01.652Z'
- updated_at: '2021-11-16T15:44:01.689Z'
+ created_at: '2021-11-17T08:58:56.717Z'
+ updated_at: '2021-11-17T08:58:56.756Z'
link:
is_container: false
is_root: false
@@ -4152,8 +4151,8 @@ paths:
lft: 5
rgt: 6
depth: 2
- created_at: '2021-11-16T15:44:04.725Z'
- updated_at: '2021-11-16T15:44:04.765Z'
+ created_at: '2021-11-17T08:58:59.586Z'
+ updated_at: '2021-11-17T08:58:59.627Z'
link:
is_container: false
is_root: false
@@ -4257,8 +4256,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-11-16T15:44:05.649Z'
- updated_at: '2021-11-16T15:44:05.849Z'
+ created_at: '2021-11-17T08:59:00.457Z'
+ updated_at: '2021-11-17T08:59:00.651Z'
relationships:
menu_items:
data:
@@ -4274,8 +4273,8 @@ paths:
name: Footer Menu
location: footer
locale: en
- created_at: '2021-11-16T15:44:05.662Z'
- updated_at: '2021-11-16T15:44:06.043Z'
+ created_at: '2021-11-17T08:59:00.471Z'
+ updated_at: '2021-11-17T08:59:00.840Z'
relationships:
menu_items:
data:
@@ -4338,8 +4337,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-11-16T15:44:06.600Z'
- updated_at: '2021-11-16T15:44:06.608Z'
+ created_at: '2021-11-17T08:59:01.381Z'
+ updated_at: '2021-11-17T08:59:01.390Z'
relationships:
menu_items:
data:
@@ -4407,8 +4406,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-11-16T15:44:06.686Z'
- updated_at: '2021-11-16T15:44:06.694Z'
+ created_at: '2021-11-17T08:59:01.482Z'
+ updated_at: '2021-11-17T08:59:01.490Z'
relationships:
menu_items:
data:
@@ -4472,8 +4471,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-11-16T15:44:06.816Z'
- updated_at: '2021-11-16T15:44:06.824Z'
+ created_at: '2021-11-17T08:59:01.666Z'
+ updated_at: '2021-11-17T08:59:01.674Z'
relationships:
menu_items:
data:
@@ -4608,8 +4607,8 @@ paths:
name: foo-size-68
presentation: Size
position: 1
- created_at: '2021-11-16T15:44:07.114Z'
- updated_at: '2021-11-16T15:44:07.114Z'
+ created_at: '2021-11-17T08:59:02.004Z'
+ updated_at: '2021-11-17T08:59:02.004Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -4622,8 +4621,8 @@ paths:
name: foo-size-69
presentation: Size
position: 2
- created_at: '2021-11-16T15:44:07.116Z'
- updated_at: '2021-11-16T15:44:07.116Z'
+ created_at: '2021-11-17T08:59:02.007Z'
+ updated_at: '2021-11-17T08:59:02.007Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -4676,8 +4675,8 @@ paths:
name: foo-size-72
presentation: Size
position: 1
- created_at: '2021-11-16T15:44:07.220Z'
- updated_at: '2021-11-16T15:44:07.220Z'
+ created_at: '2021-11-17T08:59:02.122Z'
+ updated_at: '2021-11-17T08:59:02.122Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -4736,8 +4735,8 @@ paths:
name: foo-size-73
presentation: Size
position: 1
- created_at: '2021-11-16T15:44:07.398Z'
- updated_at: '2021-11-16T15:44:07.398Z'
+ created_at: '2021-11-17T08:59:02.193Z'
+ updated_at: '2021-11-17T08:59:02.193Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -4795,8 +4794,8 @@ paths:
name: Size-X
presentation: Size
position: 1
- created_at: '2021-11-16T15:44:07.512Z'
- updated_at: '2021-11-16T15:44:07.523Z'
+ created_at: '2021-11-17T08:59:02.314Z'
+ updated_at: '2021-11-17T08:59:02.326Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -4934,8 +4933,8 @@ paths:
position: 1
name: Size-68
presentation: S
- created_at: '2021-11-16T15:44:07.752Z'
- updated_at: '2021-11-16T15:44:07.752Z'
+ created_at: '2021-11-17T08:59:02.583Z'
+ updated_at: '2021-11-17T08:59:02.583Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -4949,8 +4948,8 @@ paths:
position: 1
name: Size-69
presentation: S
- created_at: '2021-11-16T15:44:07.758Z'
- updated_at: '2021-11-16T15:44:07.758Z'
+ created_at: '2021-11-17T08:59:02.591Z'
+ updated_at: '2021-11-17T08:59:02.591Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -5011,8 +5010,8 @@ paths:
position: 1
name: Size-72
presentation: S
- created_at: '2021-11-16T15:44:07.864Z'
- updated_at: '2021-11-16T15:44:07.864Z'
+ created_at: '2021-11-17T08:59:02.710Z'
+ updated_at: '2021-11-17T08:59:02.710Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -5077,8 +5076,8 @@ paths:
position: 1
name: Size-73
presentation: S
- created_at: '2021-11-16T15:44:07.939Z'
- updated_at: '2021-11-16T15:44:07.939Z'
+ created_at: '2021-11-17T08:59:02.786Z'
+ updated_at: '2021-11-17T08:59:02.786Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -5144,8 +5143,8 @@ paths:
position: 1
name: M
presentation: S
- created_at: '2021-11-16T15:44:08.057Z'
- updated_at: '2021-11-16T15:44:08.069Z'
+ created_at: '2021-11-17T08:59:02.917Z'
+ updated_at: '2021-11-17T08:59:02.930Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -5275,7 +5274,7 @@ paths:
- id: '40'
type: order
attributes:
- number: R617450213
+ number: R936310679
item_total: '0.0'
total: '0.0'
state: cart
@@ -5284,10 +5283,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-16T15:44:08.330Z'
- updated_at: '2021-11-16T15:44:08.330Z'
+ created_at: '2021-11-17T08:59:03.222Z'
+ updated_at: '2021-11-17T08:59:03.222Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5305,10 +5304,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$0.00"
- display_ship_total: "$0.00"
- display_shipment_total: "$0.00"
- display_total: "$0.00"
display_outstanding_balance: "$0.00"
display_item_total: "$0.00"
display_tax_total: "$0.00"
@@ -5318,6 +5313,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$0.00"
+ display_ship_total: "$0.00"
+ display_shipment_total: "$0.00"
+ display_total: "$0.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$0.00"
@@ -5361,7 +5360,7 @@ paths:
- id: '41'
type: order
attributes:
- number: R300625424
+ number: R743211233
item_total: '0.0'
total: '0.0'
state: cart
@@ -5370,10 +5369,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-16T15:44:08.342Z'
- updated_at: '2021-11-16T15:44:08.342Z'
+ created_at: '2021-11-17T08:59:03.238Z'
+ updated_at: '2021-11-17T08:59:03.238Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5391,10 +5390,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$0.00"
- display_ship_total: "$0.00"
- display_shipment_total: "$0.00"
- display_total: "$0.00"
display_outstanding_balance: "$0.00"
display_item_total: "$0.00"
display_tax_total: "$0.00"
@@ -5404,6 +5399,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$0.00"
+ display_ship_total: "$0.00"
+ display_shipment_total: "$0.00"
+ display_total: "$0.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$0.00"
@@ -5494,7 +5493,7 @@ paths:
id: '44'
type: order
attributes:
- number: R321644015
+ number: R074996438
item_total: '0.0'
total: '0.0'
state: cart
@@ -5505,8 +5504,8 @@ paths:
payment_state:
email:
special_instructions:
- created_at: '2021-11-16T15:44:08.706Z'
- updated_at: '2021-11-16T15:44:08.722Z'
+ created_at: '2021-11-17T08:59:03.698Z'
+ updated_at: '2021-11-17T08:59:03.718Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5524,10 +5523,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$20.00"
- display_ship_total: "$0.00"
- display_shipment_total: "$0.00"
- display_total: "$0.00"
display_outstanding_balance: "$0.00"
display_item_total: "$0.00"
display_tax_total: "$0.00"
@@ -5537,6 +5532,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$20.00"
+ display_ship_total: "$0.00"
+ display_shipment_total: "$0.00"
+ display_total: "$0.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$0.00"
@@ -5622,7 +5621,7 @@ paths:
id: '45'
type: order
attributes:
- number: R976926465
+ number: R860669827
item_total: '10.0'
total: '110.0'
state: delivery
@@ -5631,10 +5630,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-16T15:44:08.797Z'
- updated_at: '2021-11-16T15:44:09.020Z'
+ created_at: '2021-11-17T08:59:03.790Z'
+ updated_at: '2021-11-17T08:59:04.000Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5652,10 +5651,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$10.00"
- display_ship_total: "$100.00"
- display_shipment_total: "$100.00"
- display_total: "$110.00"
display_outstanding_balance: "$110.00"
display_item_total: "$10.00"
display_tax_total: "$0.00"
@@ -5665,6 +5660,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$10.00"
+ display_ship_total: "$100.00"
+ display_shipment_total: "$100.00"
+ display_total: "$110.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$110.00"
@@ -5766,7 +5765,7 @@ paths:
id: '47'
type: order
attributes:
- number: R123461339
+ number: R343758136
item_total: '10.0'
total: '110.0'
state: delivery
@@ -5777,8 +5776,8 @@ paths:
payment_state:
special_instructions:
- created_at: '2021-11-16T15:44:09.325Z'
- updated_at: '2021-11-16T15:44:09.446Z'
+ created_at: '2021-11-17T08:59:04.504Z'
+ updated_at: '2021-11-17T08:59:04.688Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5796,10 +5795,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$10.00"
- display_ship_total: "$100.00"
- display_shipment_total: "$100.00"
- display_total: "$110.00"
display_outstanding_balance: "$110.00"
display_item_total: "$10.00"
display_tax_total: "$0.00"
@@ -5809,6 +5804,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$10.00"
+ display_ship_total: "$100.00"
+ display_shipment_total: "$100.00"
+ display_total: "$110.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$110.00"
@@ -5966,7 +5965,7 @@ paths:
id: '52'
type: order
attributes:
- number: R450160704
+ number: R334088042
item_total: '10.0'
total: '110.0'
state: payment
@@ -5975,10 +5974,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-16T15:44:10.235Z'
- updated_at: '2021-11-16T15:44:10.413Z'
+ created_at: '2021-11-17T08:59:05.689Z'
+ updated_at: '2021-11-17T08:59:05.889Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5996,10 +5995,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$110.00"
- display_ship_total: "$100.00"
- display_shipment_total: "$100.00"
- display_total: "$110.00"
display_outstanding_balance: "$110.00"
display_item_total: "$10.00"
display_tax_total: "$0.00"
@@ -6009,6 +6004,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$110.00"
+ display_ship_total: "$100.00"
+ display_shipment_total: "$100.00"
+ display_total: "$110.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$110.00"
@@ -6113,7 +6112,7 @@ paths:
id: '54'
type: order
attributes:
- number: R902821820
+ number: R630834231
item_total: '10.0'
total: '110.0'
state: payment
@@ -6122,10 +6121,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-16T15:44:10.672Z'
- updated_at: '2021-11-16T15:44:10.837Z'
+ created_at: '2021-11-17T08:59:06.248Z'
+ updated_at: '2021-11-17T08:59:06.444Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6143,10 +6142,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$110.00"
- display_ship_total: "$100.00"
- display_shipment_total: "$100.00"
- display_total: "$110.00"
display_outstanding_balance: "$110.00"
display_item_total: "$10.00"
display_tax_total: "$0.00"
@@ -6156,6 +6151,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$110.00"
+ display_ship_total: "$100.00"
+ display_shipment_total: "$100.00"
+ display_total: "$110.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$110.00"
@@ -6260,19 +6259,19 @@ paths:
id: '56'
type: order
attributes:
- number: R443906629
+ number: R189235257
item_total: '10.0'
total: '110.0'
state: complete
adjustment_total: '0.0'
- completed_at: '2021-11-16T15:44:11.365Z'
+ completed_at: '2021-11-17T08:59:07.073Z'
payment_total: '0.0'
shipment_state: pending
payment_state: balance_due
special_instructions:
- created_at: '2021-11-16T15:44:11.097Z'
- updated_at: '2021-11-16T15:44:11.365Z'
+ created_at: '2021-11-17T08:59:06.748Z'
+ updated_at: '2021-11-17T08:59:07.073Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6290,10 +6289,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$110.00"
- display_ship_total: "$100.00"
- display_shipment_total: "$100.00"
- display_total: "$110.00"
display_outstanding_balance: "$110.00"
display_item_total: "$10.00"
display_tax_total: "$0.00"
@@ -6303,6 +6298,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$110.00"
+ display_ship_total: "$100.00"
+ display_shipment_total: "$100.00"
+ display_total: "$110.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$110.00"
@@ -6418,7 +6417,7 @@ paths:
id: '59'
type: order
attributes:
- number: R761534714
+ number: R848296928
item_total: '0.0'
total: '0.0'
state: cart
@@ -6427,10 +6426,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-16T15:44:11.784Z'
- updated_at: '2021-11-16T15:44:11.919Z'
+ created_at: '2021-11-17T08:59:07.639Z'
+ updated_at: '2021-11-17T08:59:07.800Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -6448,10 +6447,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$0.00"
- display_ship_total: "$0.00"
- display_shipment_total: "$0.00"
- display_total: "$0.00"
display_outstanding_balance: "$0.00"
display_item_total: "$0.00"
display_tax_total: "$0.00"
@@ -6461,6 +6456,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$0.00"
+ display_ship_total: "$0.00"
+ display_shipment_total: "$0.00"
+ display_total: "$0.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$0.00"
@@ -6560,7 +6559,7 @@ paths:
id: '61'
type: order
attributes:
- number: R707114429
+ number: R315735568
item_total: '10.0'
total: '110.0'
state: delivery
@@ -6569,10 +6568,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-16T15:44:12.192Z'
- updated_at: '2021-11-16T15:44:12.307Z'
+ created_at: '2021-11-17T08:59:08.118Z'
+ updated_at: '2021-11-17T08:59:08.247Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6590,10 +6589,6 @@ paths:
store_owner_notification_delivered:
public_metadata: {}
private_metadata: {}
- display_pre_tax_total: "$10.00"
- display_ship_total: "$100.00"
- display_shipment_total: "$100.00"
- display_total: "$110.00"
display_outstanding_balance: "$110.00"
display_item_total: "$10.00"
display_tax_total: "$0.00"
@@ -6603,6 +6598,10 @@ paths:
display_additional_tax_total: "$0.00"
display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_pre_tax_total: "$10.00"
+ display_ship_total: "$100.00"
+ display_shipment_total: "$100.00"
+ display_total: "$110.00"
display_total_applicable_store_credit: "$0.00"
display_total_applied_store_credit: "$0.00"
display_order_total_after_store_credit: "$110.00"
@@ -6875,8 +6874,8 @@ paths:
display_on: both
auto_capture:
position: 1
- created_at: '2021-11-16T15:44:14.343Z'
- updated_at: '2021-11-16T15:44:14.343Z'
+ created_at: '2021-11-17T08:59:11.171Z'
+ updated_at: '2021-11-17T08:59:11.171Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -6896,8 +6895,8 @@ paths:
display_on: both
auto_capture:
position: 2
- created_at: '2021-11-16T15:44:14.352Z'
- updated_at: '2021-11-16T15:44:14.352Z'
+ created_at: '2021-11-17T08:59:11.181Z'
+ updated_at: '2021-11-17T08:59:11.181Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -6917,8 +6916,8 @@ paths:
display_on: both
auto_capture:
position: 3
- created_at: '2021-11-16T15:44:14.357Z'
- updated_at: '2021-11-16T15:44:14.357Z'
+ created_at: '2021-11-17T08:59:11.187Z'
+ updated_at: '2021-11-17T08:59:11.187Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -6938,8 +6937,8 @@ paths:
display_on: both
auto_capture:
position: 4
- created_at: '2021-11-16T15:44:14.363Z'
- updated_at: '2021-11-16T15:44:14.363Z'
+ created_at: '2021-11-17T08:59:11.193Z'
+ updated_at: '2021-11-17T08:59:11.193Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -6962,8 +6961,8 @@ paths:
display_on: both
auto_capture:
position: 5
- created_at: '2021-11-16T15:44:14.369Z'
- updated_at: '2021-11-16T15:44:14.369Z'
+ created_at: '2021-11-17T08:59:11.201Z'
+ updated_at: '2021-11-17T08:59:11.201Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7033,8 +7032,8 @@ paths:
display_on: both
auto_capture:
position: 3
- created_at: '2021-11-16T15:44:14.531Z'
- updated_at: '2021-11-16T15:44:14.531Z'
+ created_at: '2021-11-17T08:59:11.418Z'
+ updated_at: '2021-11-17T08:59:11.418Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7110,8 +7109,8 @@ paths:
display_on: both
auto_capture:
position: 4
- created_at: '2021-11-16T15:44:14.661Z'
- updated_at: '2021-11-16T15:44:14.661Z'
+ created_at: '2021-11-17T08:59:11.575Z'
+ updated_at: '2021-11-17T08:59:11.575Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7186,8 +7185,8 @@ paths:
display_on: both
auto_capture:
position: 3
- created_at: '2021-11-16T15:44:14.860Z'
- updated_at: '2021-11-16T15:44:14.874Z'
+ created_at: '2021-11-17T08:59:11.812Z'
+ updated_at: '2021-11-17T08:59:11.830Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7335,9 +7334,9 @@ paths:
state: invalid
response_code: '12345'
avs_response:
- created_at: '2021-11-16T15:44:15.283Z'
- updated_at: '2021-11-16T15:44:15.307Z'
- number: P30HHYFC
+ created_at: '2021-11-17T08:59:12.345Z'
+ updated_at: '2021-11-17T08:59:12.377Z'
+ number: PAEAUM26
cvv_response_code:
cvv_response_message:
public_metadata: {}
@@ -7374,9 +7373,9 @@ paths:
state: checkout
response_code: '12345'
avs_response:
- created_at: '2021-11-16T15:44:15.303Z'
- updated_at: '2021-11-16T15:44:15.303Z'
- number: PL2WUVT0
+ created_at: '2021-11-17T08:59:12.372Z'
+ updated_at: '2021-11-17T08:59:12.372Z'
+ number: PG4BHVZY
cvv_response_code:
cvv_response_message:
public_metadata: {}
@@ -7464,9 +7463,9 @@ paths:
state: checkout
response_code: '12345'
avs_response:
- created_at: '2021-11-16T15:44:15.511Z'
- updated_at: '2021-11-16T15:44:15.511Z'
- number: P87UCSN0
+ created_at: '2021-11-17T08:59:12.653Z'
+ updated_at: '2021-11-17T08:59:12.653Z'
+ number: PZ5KKG99
cvv_response_code:
cvv_response_message:
public_metadata: {}
@@ -7600,8 +7599,8 @@ paths:
position:
type:
deleted_at:
- created_at: '2021-11-16T15:44:15.851Z'
- updated_at: '2021-11-16T15:44:15.851Z'
+ created_at: '2021-11-17T08:59:13.270Z'
+ updated_at: '2021-11-17T08:59:13.270Z'
relationships:
promotion:
data:
@@ -7613,8 +7612,8 @@ paths:
position:
type:
deleted_at:
- created_at: '2021-11-16T15:44:15.852Z'
- updated_at: '2021-11-16T15:44:15.852Z'
+ created_at: '2021-11-17T08:59:13.271Z'
+ updated_at: '2021-11-17T08:59:13.271Z'
relationships:
promotion:
data:
@@ -7673,8 +7672,8 @@ paths:
position:
type:
deleted_at:
- created_at: '2021-11-16T15:44:15.964Z'
- updated_at: '2021-11-16T15:44:15.964Z'
+ created_at: '2021-11-17T08:59:13.425Z'
+ updated_at: '2021-11-17T08:59:13.425Z'
relationships:
promotion:
data:
@@ -7724,8 +7723,8 @@ paths:
position:
type:
deleted_at:
- created_at: '2021-11-16T15:44:16.014Z'
- updated_at: '2021-11-16T15:44:16.014Z'
+ created_at: '2021-11-17T08:59:13.476Z'
+ updated_at: '2021-11-17T08:59:13.476Z'
relationships:
promotion:
data:
@@ -7789,8 +7788,8 @@ paths:
position:
type: Spree::Promotion::Actions::CreateAdjustment
deleted_at:
- created_at: '2021-11-16T15:44:16.136Z'
- updated_at: '2021-11-16T15:44:16.145Z'
+ created_at: '2021-11-17T08:59:13.644Z'
+ updated_at: '2021-11-17T08:59:13.654Z'
relationships:
promotion:
data:
@@ -7912,8 +7911,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-11-16T15:44:16.361Z'
- updated_at: '2021-11-16T15:44:16.361Z'
+ created_at: '2021-11-17T08:59:13.914Z'
+ updated_at: '2021-11-17T08:59:13.914Z'
code: POP123
relationships:
promotions:
@@ -7922,8 +7921,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-11-16T15:44:16.362Z'
- updated_at: '2021-11-16T15:44:16.362Z'
+ created_at: '2021-11-17T08:59:13.916Z'
+ updated_at: '2021-11-17T08:59:13.916Z'
code: POP123
relationships:
promotions:
@@ -7979,8 +7978,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-11-16T15:44:16.442Z'
- updated_at: '2021-11-16T15:44:16.442Z'
+ created_at: '2021-11-17T08:59:14.019Z'
+ updated_at: '2021-11-17T08:59:14.019Z'
code: 2021-BFM
relationships:
promotions:
@@ -8040,8 +8039,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-11-16T15:44:16.502Z'
- updated_at: '2021-11-16T15:44:16.502Z'
+ created_at: '2021-11-17T08:59:14.103Z'
+ updated_at: '2021-11-17T08:59:14.103Z'
code: MJO
relationships:
promotions:
@@ -8102,8 +8101,8 @@ paths:
type: promotion_category
attributes:
name: 2021 Promotions
- created_at: '2021-11-16T15:44:16.609Z'
- updated_at: '2021-11-16T15:44:16.618Z'
+ created_at: '2021-11-17T08:59:14.221Z'
+ updated_at: '2021-11-17T08:59:14.232Z'
code: 2021-Promos
relationships:
promotions:
@@ -8231,8 +8230,8 @@ paths:
type: promotion_rule
attributes:
type:
- created_at: '2021-11-16T15:44:16.840Z'
- updated_at: '2021-11-16T15:44:16.840Z'
+ created_at: '2021-11-17T08:59:14.494Z'
+ updated_at: '2021-11-17T08:59:14.494Z'
code:
preferences: {}
relationships:
@@ -8244,8 +8243,8 @@ paths:
type: promotion_rule
attributes:
type:
- created_at: '2021-11-16T15:44:16.842Z'
- updated_at: '2021-11-16T15:44:16.842Z'
+ created_at: '2021-11-17T08:59:14.498Z'
+ updated_at: '2021-11-17T08:59:14.498Z'
code:
preferences: {}
relationships:
@@ -8304,8 +8303,8 @@ paths:
type: promotion_rule
attributes:
type:
- created_at: '2021-11-16T15:44:16.960Z'
- updated_at: '2021-11-16T15:44:16.960Z'
+ created_at: '2021-11-17T08:59:14.648Z'
+ updated_at: '2021-11-17T08:59:14.648Z'
code:
preferences: {}
relationships:
@@ -8355,8 +8354,8 @@ paths:
type: promotion_rule
attributes:
type:
- created_at: '2021-11-16T15:44:16.999Z'
- updated_at: '2021-11-16T15:44:16.999Z'
+ created_at: '2021-11-17T08:59:14.699Z'
+ updated_at: '2021-11-17T08:59:14.699Z'
code:
preferences: {}
relationships:
@@ -8420,8 +8419,8 @@ paths:
type: promotion_rule
attributes:
type: Spree::Promotion::Rules::Country
- created_at: '2021-11-16T15:44:17.115Z'
- updated_at: '2021-11-16T15:44:17.125Z'
+ created_at: '2021-11-17T08:59:14.852Z'
+ updated_at: '2021-11-17T08:59:14.863Z'
code:
preferences: {}
relationships:
@@ -8554,8 +8553,8 @@ paths:
code:
advertise: false
path:
- created_at: '2021-11-16T15:44:17.352Z'
- updated_at: '2021-11-16T15:44:17.352Z'
+ created_at: '2021-11-17T08:59:15.143Z'
+ updated_at: '2021-11-17T08:59:15.143Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -8582,8 +8581,8 @@ paths:
code:
advertise: false
path:
- created_at: '2021-11-16T15:44:17.364Z'
- updated_at: '2021-11-16T15:44:17.364Z'
+ created_at: '2021-11-17T08:59:15.163Z'
+ updated_at: '2021-11-17T08:59:15.163Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -8614,8 +8613,8 @@ paths:
code:
advertise: false
path:
- created_at: '2021-11-16T15:44:17.384Z'
- updated_at: '2021-11-16T15:44:17.384Z'
+ created_at: '2021-11-17T08:59:15.194Z'
+ updated_at: '2021-11-17T08:59:15.194Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -8646,8 +8645,8 @@ paths:
code:
advertise: false
path:
- created_at: '2021-11-16T15:44:17.398Z'
- updated_at: '2021-11-16T15:44:17.398Z'
+ created_at: '2021-11-17T08:59:15.217Z'
+ updated_at: '2021-11-17T08:59:15.217Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -8718,8 +8717,8 @@ paths:
type: promotion
attributes:
description: First 1000 Customers Save 20%
- expires_at: '2021-11-20T15:44:17.615Z'
- starts_at: '2021-11-16T15:44:17.615Z'
+ expires_at: '2021-11-21T08:59:15.537Z'
+ starts_at: '2021-11-17T08:59:15.537Z'
name: Black Friday 20% Off
type: Spree::Promotion
usage_limit: 1000
@@ -8727,8 +8726,8 @@ paths:
code: BLK-20
advertise: true
path: "/black-fri/today"
- created_at: '2021-11-16T15:44:17.633Z'
- updated_at: '2021-11-16T15:44:17.633Z'
+ created_at: '2021-11-17T08:59:15.562Z'
+ updated_at: '2021-11-17T08:59:15.562Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -8812,8 +8811,8 @@ paths:
code:
advertise: false
path:
- created_at: '2021-11-16T15:44:17.854Z'
- updated_at: '2021-11-16T15:44:17.854Z'
+ created_at: '2021-11-17T08:59:15.893Z'
+ updated_at: '2021-11-17T08:59:15.893Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -8898,8 +8897,8 @@ paths:
code: RAND-10
advertise: false
path:
- created_at: '2021-11-16T15:44:18.174Z'
- updated_at: '2021-11-16T15:44:18.194Z'
+ created_at: '2021-11-17T08:59:16.633Z'
+ updated_at: '2021-11-17T08:59:16.662Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -9042,14 +9041,14 @@ paths:
type: role
attributes:
name: 'Role #1'
- created_at: '2021-11-16T15:44:18.874Z'
- updated_at: '2021-11-16T15:44:18.874Z'
+ created_at: '2021-11-17T08:59:17.787Z'
+ updated_at: '2021-11-17T08:59:17.787Z'
- id: '2'
type: role
attributes:
name: 'Role #2'
- created_at: '2021-11-16T15:44:18.876Z'
- updated_at: '2021-11-16T15:44:18.876Z'
+ created_at: '2021-11-17T08:59:17.789Z'
+ updated_at: '2021-11-17T08:59:17.789Z'
meta:
count: 2
total_count: 2
@@ -9094,8 +9093,8 @@ paths:
type: role
attributes:
name: 'Role #5'
- created_at: '2021-11-16T15:44:18.956Z'
- updated_at: '2021-11-16T15:44:18.956Z'
+ created_at: '2021-11-17T08:59:17.904Z'
+ updated_at: '2021-11-17T08:59:17.904Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -9144,8 +9143,8 @@ paths:
type: role
attributes:
name: 'Role #6'
- created_at: '2021-11-16T15:44:19.017Z'
- updated_at: '2021-11-16T15:44:19.017Z'
+ created_at: '2021-11-17T08:59:17.980Z'
+ updated_at: '2021-11-17T08:59:17.980Z'
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -9195,8 +9194,8 @@ paths:
type: role
attributes:
name: administrator
- created_at: '2021-11-16T15:44:19.127Z'
- updated_at: '2021-11-16T15:44:19.135Z'
+ created_at: '2021-11-17T08:59:18.098Z'
+ updated_at: '2021-11-17T08:59:18.108Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -9320,12 +9319,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H94608258936
+ number: H49185489578
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-11-16T15:44:19.362Z'
- updated_at: '2021-11-16T15:44:19.366Z'
+ created_at: '2021-11-17T08:59:18.447Z'
+ updated_at: '2021-11-17T08:59:18.453Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -9335,12 +9334,11 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_discounted_cost: "$100.00"
- display_item_cost: "$0.00"
display_final_price: "$100.00"
display_amount: "$100.00"
display_cost: "$100.00"
- tracking_url:
+ display_discounted_cost: "$100.00"
+ display_item_cost: "$0.00"
relationships:
order:
data:
@@ -9370,12 +9368,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H18770551606
+ number: H48328237505
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-11-16T15:44:19.403Z'
- updated_at: '2021-11-16T15:44:19.407Z'
+ created_at: '2021-11-17T08:59:18.515Z'
+ updated_at: '2021-11-17T08:59:18.520Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -9385,12 +9383,11 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_discounted_cost: "$100.00"
- display_item_cost: "$0.00"
display_final_price: "$100.00"
display_amount: "$100.00"
display_cost: "$100.00"
- tracking_url:
+ display_discounted_cost: "$100.00"
+ display_item_cost: "$0.00"
relationships:
order:
data:
@@ -9438,15 +9435,21 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- post:
- summary: Create a Shipment
+ "/api/v2/platform/shipments/{id}":
+ get:
+ summary: Return a Shipment
tags:
- Shipments
security:
- bearer_auth: []
- description: Creates a Shipment
- operationId: create-shipment
+ description: Returns a Shipment
+ operationId: show-shipment
parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
- name: include
in: query
description: 'Select which associated resources you would like to fetch, see:
@@ -9455,24 +9458,24 @@ paths:
schema:
type: string
responses:
- '201':
- description: Record created
+ '200':
+ description: Record found
content:
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '32'
+ id: '33'
type: shipment
attributes:
- tracking:
- number: H42423392607
- cost: '0.0'
+ tracking: U10000
+ number: H29305380595
+ cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-11-16T15:44:19.713Z'
- updated_at: '2021-11-16T15:44:19.727Z'
+ created_at: '2021-11-17T08:59:19.069Z'
+ updated_at: '2021-11-17T08:59:19.101Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -9482,12 +9485,11 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_discounted_cost: "$0.00"
- display_item_cost: "$19.99"
- display_final_price: "$0.00"
- display_amount: "$0.00"
- display_cost: "$0.00"
- tracking_url:
+ display_final_price: "$100.00"
+ display_amount: "$100.00"
+ display_cost: "$100.00"
+ display_discounted_cost: "$100.00"
+ display_item_cost: "$10.00"
relationships:
order:
data:
@@ -9497,47 +9499,92 @@ paths:
data:
stock_location:
data:
- id: '128'
+ id: '130'
type: stock_location
adjustments:
data: []
inventory_units:
data:
- - id: '28'
+ - id: '29'
type: inventory_unit
shipping_rates:
- data: []
+ data:
+ - id: '37'
+ type: shipping_rate
state_changes:
data: []
selected_shipping_rate:
data:
+ id: '37'
+ type: shipping_rate
schema:
"$ref": "#/components/schemas/resource"
- '422':
- description: Invalid request
+ '404':
+ description: Record not found
content:
application/vnd.api+json:
examples:
Example:
value:
- error: order_not_found
- errors: {}
+ error: The resource you were looking for could not be found.
schema:
- "$ref": "#/components/schemas/validation_errors"
- requestBody:
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/create_shipment_params"
- "/api/v2/platform/shipments/{id}":
- get:
- summary: Return a Shipment
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ delete:
+ summary: Delete a Shipment
tags:
- Shipments
security:
- bearer_auth: []
- description: Returns a Shipment
- operationId: show-shipment
+ description: Deletes a Shipment
+ operationId: delete-shipment
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: Record deleted
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ "/api/v2/platform/shipments/{id}/ready":
+ patch:
+ summary: Mark Shipment as ready to be shipped
+ tags:
+ - Shipments
+ security:
+ - bearer_auth: []
+ description: Marks Shipment as ready to be shipped
+ operationId: ready-shipment
parameters:
- name: id
in: path
@@ -9553,23 +9600,23 @@ paths:
type: string
responses:
'200':
- description: Record found
+ description: Record updated
content:
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '34'
+ id: '41'
type: shipment
attributes:
tracking: U10000
- number: H67033263864
+ number: H89971370745
cost: '100.0'
shipped_at:
- state: pending
- created_at: '2021-11-16T15:44:20.052Z'
- updated_at: '2021-11-16T15:44:20.080Z'
+ state: ready
+ created_at: '2021-11-17T08:59:20.739Z'
+ updated_at: '2021-11-17T08:59:20.788Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -9579,38 +9626,39 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_discounted_cost: "$100.00"
- display_item_cost: "$10.00"
display_final_price: "$100.00"
display_amount: "$100.00"
display_cost: "$100.00"
- tracking_url:
+ display_discounted_cost: "$100.00"
+ display_item_cost: "$10.00"
relationships:
order:
data:
- id: '83'
+ id: '86'
type: order
address:
data:
stock_location:
data:
- id: '131'
+ id: '142'
type: stock_location
adjustments:
data: []
inventory_units:
data:
- - id: '30'
+ - id: '37'
type: inventory_unit
shipping_rates:
data:
- - id: '37'
+ - id: '53'
type: shipping_rate
state_changes:
- data: []
+ data:
+ - id: '17'
+ type: state_change
selected_shipping_rate:
data:
- id: '37'
+ id: '53'
type: shipping_rate
schema:
"$ref": "#/components/schemas/resource"
@@ -9634,14 +9682,15 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
+ "/api/v2/platform/shipments/{id}/ship":
patch:
- summary: Update a Shipment
+ summary: Mark Shipment as shipped
tags:
- Shipments
security:
- bearer_auth: []
- description: Updates a Shipment
- operationId: update-shipment
+ description: Marks Shipment as shipped
+ operationId: ship-shipment
parameters:
- name: id
in: path
@@ -9664,16 +9713,16 @@ paths:
Example:
value:
data:
- id: '38'
+ id: '45'
type: shipment
attributes:
- tracking: MY-TRACKING-NUMBER-1234
- number: H36181193782
+ tracking: U10000
+ number: H42967804063
cost: '100.0'
- shipped_at:
- state: pending
- created_at: '2021-11-16T15:44:20.625Z'
- updated_at: '2021-11-16T15:44:20.661Z'
+ shipped_at: '2021-11-17T08:59:21.558Z'
+ state: shipped
+ created_at: '2021-11-17T08:59:21.501Z'
+ updated_at: '2021-11-17T08:59:21.558Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -9683,96 +9732,42 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_discounted_cost: "$100.00"
- display_item_cost: "$10.00"
display_final_price: "$100.00"
display_amount: "$100.00"
display_cost: "$100.00"
- tracking_url:
+ display_discounted_cost: "$100.00"
+ display_item_cost: "$10.00"
relationships:
order:
data:
- id: '85'
+ id: '88'
type: order
address:
data:
stock_location:
data:
- id: '137'
+ id: '148'
type: stock_location
adjustments:
data: []
inventory_units:
data:
- - id: '34'
+ - id: '41'
type: inventory_unit
shipping_rates:
data:
- - id: '45'
+ - id: '61'
type: shipping_rate
state_changes:
- data: []
+ data:
+ - id: '19'
+ type: state_change
selected_shipping_rate:
data:
- id: '45'
+ id: '61'
type: shipping_rate
schema:
"$ref": "#/components/schemas/resource"
- '422':
- description: Invalid request
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- error: Stock location can't be blank
- errors:
- stock_location:
- - can't be blank
- schema:
- "$ref": "#/components/schemas/validation_errors"
- '404':
- description: Record not found
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- error: The resource you were looking for could not be found.
- schema:
- "$ref": "#/components/schemas/error"
- '401':
- description: Authentication Failed
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- error: The access token is invalid
- schema:
- "$ref": "#/components/schemas/error"
- requestBody:
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/update_shipment_params"
- delete:
- summary: Delete a Shipment
- tags:
- - Shipments
- security:
- - bearer_auth: []
- description: Deletes a Shipment
- operationId: delete-shipment
- parameters:
- - name: id
- in: path
- required: true
- schema:
- type: string
- responses:
- '204':
- description: Record deleted
'404':
description: Record not found
content:
@@ -9793,16 +9788,15 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- "/api/v2/platform/shipments/{id}/add_item":
+ "/api/v2/platform/shipments/{id}/cancel":
patch:
- summary: Adds item (Variant) to an existing Shipment
+ summary: Cancels the Shipment
tags:
- Shipments
security:
- bearer_auth: []
- description: If selected Variant was already added to Order it will increase
- the quantity of existing Line Item, if not it will create a new Line Item
- operationId: add-item-shipment
+ description: Cancels the Shipment
+ operationId: cancel-shipment
parameters:
- name: id
in: path
@@ -9825,16 +9819,16 @@ paths:
Example:
value:
data:
- id: '48'
+ id: '49'
type: shipment
attributes:
tracking: U10000
- number: H56123465497
- cost: '0.0'
+ number: H14478205241
+ cost: '100.0'
shipped_at:
- state: pending
- created_at: '2021-11-16T15:44:22.002Z'
- updated_at: '2021-11-16T15:44:22.103Z'
+ state: canceled
+ created_at: '2021-11-17T08:59:22.309Z'
+ updated_at: '2021-11-17T08:59:22.352Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -9844,12 +9838,11 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_discounted_cost: "$0.00"
- display_item_cost: "$29.99"
- display_final_price: "$0.00"
- display_amount: "$0.00"
- display_cost: "$0.00"
- tracking_url:
+ display_final_price: "$100.00"
+ display_amount: "$100.00"
+ display_cost: "$100.00"
+ display_discounted_cost: "$100.00"
+ display_item_cost: "$10.00"
relationships:
order:
data:
@@ -9859,27 +9852,25 @@ paths:
data:
stock_location:
data:
- id: '152'
+ id: '154'
type: stock_location
adjustments:
data: []
inventory_units:
data:
- - id: '44'
- type: inventory_unit
- id: '45'
type: inventory_unit
shipping_rates:
data:
- - id: '76'
- type: shipping_rate
- - id: '77'
+ - id: '69'
type: shipping_rate
state_changes:
- data: []
+ data:
+ - id: '20'
+ type: state_change
selected_shipping_rate:
data:
- id: '77'
+ id: '69'
type: shipping_rate
schema:
"$ref": "#/components/schemas/resource"
@@ -9903,21 +9894,15 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- requestBody:
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/add_item_shipment_params"
- "/api/v2/platform/shipments/{id}/remove_item":
+ "/api/v2/platform/shipments/{id}/resume":
patch:
- summary: Removes item (Variant) from Shipment
+ summary: Resumes the Shipment
tags:
- Shipments
security:
- bearer_auth: []
- description: If selected Variant is removed completely and Shipment doesn't
- include any other Line Items, Shipment itself will be deleted
- operationId: remove-item-shipment
+ description: Resumes previously canceled Shipment
+ operationId: resume-shipment
parameters:
- name: id
in: path
@@ -9932,8 +9917,6 @@ paths:
schema:
type: string
responses:
- '204':
- description: Record deleted
'200':
description: Record updated
content:
@@ -9942,16 +9925,16 @@ paths:
Example:
value:
data:
- id: '54'
+ id: '53'
type: shipment
attributes:
tracking: U10000
- number: H00192006453
- cost: '0.0'
+ number: H45251121432
+ cost: '100.0'
shipped_at:
- state: pending
- created_at: '2021-11-16T15:44:23.330Z'
- updated_at: '2021-11-16T15:44:23.503Z'
+ state: ready
+ created_at: '2021-11-17T08:59:23.213Z'
+ updated_at: '2021-11-17T08:59:23.290Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -9961,40 +9944,39 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_discounted_cost: "$0.00"
+ display_final_price: "$100.00"
+ display_amount: "$100.00"
+ display_cost: "$100.00"
+ display_discounted_cost: "$100.00"
display_item_cost: "$10.00"
- display_final_price: "$0.00"
- display_amount: "$0.00"
- display_cost: "$0.00"
- tracking_url:
relationships:
order:
data:
- id: '93'
+ id: '92'
type: order
address:
data:
stock_location:
data:
- id: '162'
+ id: '160'
type: stock_location
adjustments:
data: []
inventory_units:
data:
- - id: '51'
+ - id: '49'
type: inventory_unit
shipping_rates:
data:
- - id: '100'
- type: shipping_rate
- - id: '101'
+ - id: '77'
type: shipping_rate
state_changes:
- data: []
+ data:
+ - id: '21'
+ type: state_change
selected_shipping_rate:
data:
- id: '97'
+ id: '77'
type: shipping_rate
schema:
"$ref": "#/components/schemas/resource"
@@ -10018,20 +10000,15 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- requestBody:
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/remove_item_shipment_params"
- "/api/v2/platform/shipments/{id}/ready":
+ "/api/v2/platform/shipments/{id}/pend":
patch:
- summary: Mark Shipment as ready to be shipped
+ summary: Moves Shipment back to pending state
tags:
- Shipments
security:
- bearer_auth: []
- description: Marks Shipment as ready to be shipped
- operationId: ready-shipment
+ description: Moves Shipment back to pending state
+ operationId: pend-shipment
parameters:
- name: id
in: path
@@ -10054,16 +10031,16 @@ paths:
Example:
value:
data:
- id: '58'
+ id: '57'
type: shipment
attributes:
tracking: U10000
- number: H68441454133
+ number: H68269206941
cost: '100.0'
shipped_at:
- state: ready
- created_at: '2021-11-16T15:44:24.120Z'
- updated_at: '2021-11-16T15:44:24.161Z'
+ state: pending
+ created_at: '2021-11-17T08:59:24.229Z'
+ updated_at: '2021-11-17T08:59:24.275Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -10073,40 +10050,39 @@ paths:
non_taxable_adjustment_total: '0.0'
public_metadata: {}
private_metadata: {}
- display_discounted_cost: "$100.00"
- display_item_cost: "$10.00"
display_final_price: "$100.00"
display_amount: "$100.00"
display_cost: "$100.00"
- tracking_url:
+ display_discounted_cost: "$100.00"
+ display_item_cost: "$10.00"
relationships:
order:
data:
- id: '95'
+ id: '94'
type: order
address:
data:
stock_location:
data:
- id: '168'
+ id: '166'
type: stock_location
adjustments:
data: []
inventory_units:
data:
- - id: '55'
+ - id: '53'
type: inventory_unit
shipping_rates:
data:
- - id: '109'
+ - id: '85'
type: shipping_rate
state_changes:
data:
- - id: '25'
+ - id: '22'
type: state_change
selected_shipping_rate:
data:
- id: '109'
+ id: '85'
type: shipping_rate
schema:
"$ref": "#/components/schemas/resource"
@@ -10130,103 +10106,65 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- "/api/v2/platform/shipments/{id}/ship":
- patch:
- summary: Mark Shipment as shipped
+ "/api/v2/platform/shipping_categories":
+ get:
+ summary: Return a list of Shipping Categories
tags:
- - Shipments
+ - Shipping Categories
security:
- bearer_auth: []
- description: Marks Shipment as shipped
- operationId: ship-shipment
+ description: Returns a list of Shipping Categories
+ operationId: shipping-categories-list
parameters:
- - name: id
- in: path
- required: true
+ - name: page
+ in: query
+ example: 1
schema:
- type: string
- - name: include
+ type: integer
+ - name: per_page
in: query
- description: 'Select which associated resources you would like to fetch, see:
- <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
- example: line_items,variants,product
+ example: 50
+ schema:
+ type: integer
+ - name: filter[name_i_cont]
+ in: query
+ description: ''
+ example: default
schema:
type: string
responses:
'200':
- description: Record updated
+ description: Records returned
content:
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '62'
- type: shipment
+ - id: '113'
+ type: shipping_category
attributes:
- tracking: U10000
- number: H51286184672
- cost: '100.0'
- shipped_at: '2021-11-16T15:44:24.743Z'
- state: shipped
- created_at: '2021-11-16T15:44:24.699Z'
- updated_at: '2021-11-16T15:44:24.743Z'
- adjustment_total: '0.0'
- additional_tax_total: '0.0'
- promo_total: '0.0'
- included_tax_total: '0.0'
- pre_tax_amount: '0.0'
- taxable_adjustment_total: '0.0'
- non_taxable_adjustment_total: '0.0'
- public_metadata: {}
- private_metadata: {}
- display_discounted_cost: "$100.00"
- display_item_cost: "$10.00"
- display_final_price: "$100.00"
- display_amount: "$100.00"
- display_cost: "$100.00"
- tracking_url:
- relationships:
- order:
- data:
- id: '97'
- type: order
- address:
- data:
- stock_location:
- data:
- id: '174'
- type: stock_location
- adjustments:
- data: []
- inventory_units:
- data:
- - id: '59'
- type: inventory_unit
- shipping_rates:
- data:
- - id: '117'
- type: shipping_rate
- state_changes:
- data:
- - id: '27'
- type: state_change
- selected_shipping_rate:
- data:
- id: '117'
- type: shipping_rate
- schema:
- "$ref": "#/components/schemas/resource"
- '404':
- description: Record not found
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- error: The resource you were looking for could not be found.
+ name: 'ShippingCategory #113'
+ created_at: '2021-11-17T08:59:24.737Z'
+ updated_at: '2021-11-17T08:59:24.737Z'
+ - id: '114'
+ type: shipping_category
+ attributes:
+ name: 'ShippingCategory #114'
+ created_at: '2021-11-17T08:59:24.738Z'
+ updated_at: '2021-11-17T08:59:24.738Z'
+ meta:
+ count: 2
+ total_count: 2
+ total_pages: 1
+ links:
+ self: http://www.example.com/api/v2/platform/shipping_categories?page=1&per_page=&filter[name_i_cont]=
+ next: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
schema:
- "$ref": "#/components/schemas/error"
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -10237,91 +10175,80 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- "/api/v2/platform/shipments/{id}/cancel":
- patch:
- summary: Cancels the Shipment
+ post:
+ summary: Create a Shipping Category
tags:
- - Shipments
+ - Shipping Categories
security:
- bearer_auth: []
- description: Cancels the Shipment
- operationId: cancel-shipment
+ description: Creates a Shipping Category
+ operationId: create-shipping-category
+ parameters: []
+ responses:
+ '201':
+ description: Record created
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '117'
+ type: shipping_category
+ attributes:
+ name: 'ShippingCategory #117'
+ created_at: '2021-11-17T08:59:24.853Z'
+ updated_at: '2021-11-17T08:59:24.853Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '422':
+ description: Invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank
+ errors:
+ name:
+ - can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/create_shipping_category_params"
+ "/api/v2/platform/shipping_categories/{id}":
+ get:
+ summary: Return a Shipping Category
+ tags:
+ - Shipping Categories
+ security:
+ - bearer_auth: []
+ description: Returns a Shipping Category
+ operationId: show-shipping-category
parameters:
- name: id
in: path
required: true
schema:
type: string
- - name: include
- in: query
- description: 'Select which associated resources you would like to fetch, see:
- <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
- example: line_items,variants,product
- schema:
- type: string
responses:
'200':
- description: Record updated
+ description: Record found
content:
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '66'
- type: shipment
+ id: '118'
+ type: shipping_category
attributes:
- tracking: U10000
- number: H21415801551
- cost: '100.0'
- shipped_at:
- state: canceled
- created_at: '2021-11-16T15:44:25.299Z'
- updated_at: '2021-11-16T15:44:25.336Z'
- adjustment_total: '0.0'
- additional_tax_total: '0.0'
- promo_total: '0.0'
- included_tax_total: '0.0'
- pre_tax_amount: '0.0'
- taxable_adjustment_total: '0.0'
- non_taxable_adjustment_total: '0.0'
- public_metadata: {}
- private_metadata: {}
- display_discounted_cost: "$100.00"
- display_item_cost: "$10.00"
- display_final_price: "$100.00"
- display_amount: "$100.00"
- display_cost: "$100.00"
- tracking_url:
- relationships:
- order:
- data:
- id: '99'
- type: order
- address:
- data:
- stock_location:
- data:
- id: '180'
- type: stock_location
- adjustments:
- data: []
- inventory_units:
- data:
- - id: '63'
- type: inventory_unit
- shipping_rates:
- data:
- - id: '125'
- type: shipping_rate
- state_changes:
- data:
- - id: '28'
- type: state_change
- selected_shipping_rate:
- data:
- id: '125'
- type: shipping_rate
+ name: 'ShippingCategory #118'
+ created_at: '2021-11-17T08:59:24.931Z'
+ updated_at: '2021-11-17T08:59:24.931Z'
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -10344,28 +10271,20 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- "/api/v2/platform/shipments/{id}/resume":
patch:
- summary: Resumes the Shipment
+ summary: Update a Shipping Category
tags:
- - Shipments
+ - Shipping Categories
security:
- bearer_auth: []
- description: Resumes previously canceled Shipment
- operationId: resume-shipment
+ description: Updates a Shipping Category
+ operationId: update-shipping-category
parameters:
- name: id
in: path
required: true
schema:
type: string
- - name: include
- in: query
- description: 'Select which associated resources you would like to fetch, see:
- <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
- example: line_items,variants,product
- schema:
- type: string
responses:
'200':
description: Record updated
@@ -10375,62 +10294,27 @@ paths:
Example:
value:
data:
- id: '70'
- type: shipment
+ id: '120'
+ type: shipping_category
attributes:
- tracking: U10000
- number: H27208731620
- cost: '100.0'
- shipped_at:
- state: ready
- created_at: '2021-11-16T15:44:25.941Z'
- updated_at: '2021-11-16T15:44:25.982Z'
- adjustment_total: '0.0'
- additional_tax_total: '0.0'
- promo_total: '0.0'
- included_tax_total: '0.0'
- pre_tax_amount: '0.0'
- taxable_adjustment_total: '0.0'
- non_taxable_adjustment_total: '0.0'
- public_metadata: {}
- private_metadata: {}
- display_discounted_cost: "$100.00"
- display_item_cost: "$10.00"
- display_final_price: "$100.00"
- display_amount: "$100.00"
- display_cost: "$100.00"
- tracking_url:
- relationships:
- order:
- data:
- id: '101'
- type: order
- address:
- data:
- stock_location:
- data:
- id: '186'
- type: stock_location
- adjustments:
- data: []
- inventory_units:
- data:
- - id: '67'
- type: inventory_unit
- shipping_rates:
- data:
- - id: '133'
- type: shipping_rate
- state_changes:
- data:
- - id: '29'
- type: state_change
- selected_shipping_rate:
- data:
- id: '133'
- type: shipping_rate
+ name: Default
+ created_at: '2021-11-17T08:59:25.074Z'
+ updated_at: '2021-11-17T08:59:25.088Z'
schema:
"$ref": "#/components/schemas/resource"
+ '422':
+ description: Invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank
+ errors:
+ name:
+ - can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -10451,93 +10335,28 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- "/api/v2/platform/shipments/{id}/pend":
- patch:
- summary: Moves Shipment back to pending state
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/update_shipping_category_params"
+ delete:
+ summary: Delete a Shipping Category
tags:
- - Shipments
+ - Shipping Categories
security:
- bearer_auth: []
- description: Moves Shipment back to pending state
- operationId: pend-shipment
+ description: Deletes a Shipping Category
+ operationId: delete-shipping-category
parameters:
- name: id
in: path
required: true
schema:
type: string
- - name: include
- in: query
- description: 'Select which associated resources you would like to fetch, see:
- <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
- example: line_items,variants,product
- schema:
- type: string
responses:
- '200':
- description: Record updated
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- data:
- id: '75'
- type: shipment
- attributes:
- tracking: U10000
- number: H89659023392
- cost: '100.0'
- shipped_at:
- state: pending
- created_at: '2021-11-16T15:44:26.790Z'
- updated_at: '2021-11-16T15:44:26.824Z'
- adjustment_total: '0.0'
- additional_tax_total: '0.0'
- promo_total: '0.0'
- included_tax_total: '0.0'
- pre_tax_amount: '0.0'
- taxable_adjustment_total: '0.0'
- non_taxable_adjustment_total: '0.0'
- public_metadata: {}
- private_metadata: {}
- display_discounted_cost: "$100.00"
- display_item_cost: "$10.00"
- display_final_price: "$100.00"
- display_amount: "$100.00"
- display_cost: "$100.00"
- tracking_url:
- relationships:
- order:
- data:
- id: '104'
- type: order
- address:
- data:
- stock_location:
- data:
- id: '194'
- type: stock_location
- adjustments:
- data: []
- inventory_units:
- data:
- - id: '72'
- type: inventory_unit
- shipping_rates:
- data:
- - id: '144'
- type: shipping_rate
- state_changes:
- data:
- - id: '30'
- type: state_change
- selected_shipping_rate:
- data:
- id: '144'
- type: shipping_rate
- schema:
- "$ref": "#/components/schemas/resource"
+ '204':
+ description: Record deleted
'404':
description: Record not found
content:
@@ -10558,15 +10377,15 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- "/api/v2/platform/shipping_categories":
+ "/api/v2/platform/shipping_methods":
get:
- summary: Return a list of Shipping Categories
+ summary: Return a list of Shipping Methods
tags:
- - Shipping Categories
+ - Shipping Methods
security:
- bearer_auth: []
- description: Returns a list of Shipping Categories
- operationId: shipping-categories-list
+ description: Returns a list of Shipping Methods
+ operationId: shipping-methods-list
parameters:
- name: page
in: query
@@ -10578,10 +10397,23 @@ paths:
example: 50
schema:
type: integer
- - name: filter[name_i_cont]
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: calculator,shipping_categories,shipping_rates,tax_category
+ schema:
+ type: string
+ - name: filter[name]
in: query
description: ''
- example: default
+ example: DHL Express
+ schema:
+ type: string
+ - name: filter[title_cont]
+ in: query
+ description: ''
+ example: About Us
schema:
type: string
responses:
@@ -10593,28 +10425,68 @@ paths:
Example:
value:
data:
- - id: '124'
- type: shipping_category
+ - id: '60'
+ type: shipping_method
attributes:
- name: 'ShippingCategory #124'
- created_at: '2021-11-16T15:44:27.157Z'
- updated_at: '2021-11-16T15:44:27.157Z'
- - id: '125'
- type: shipping_category
+ name: UPS Ground
+ code: UPS_GROUND
+ admin_name:
+ display_on: both
+ tracking_url:
+ created_at: '2021-11-17T08:59:25.569Z'
+ updated_at: '2021-11-17T08:59:25.569Z'
+ deleted_at:
+ public_metadata: {}
+ private_metadata: {}
+ relationships:
+ shipping_categories:
+ data:
+ - id: '125'
+ type: shipping_category
+ shipping_rates:
+ data: []
+ tax_category:
+ data:
+ calculator:
+ data:
+ id: '120'
+ type: calculator
+ - id: '61'
+ type: shipping_method
attributes:
- name: 'ShippingCategory #125'
- created_at: '2021-11-16T15:44:27.159Z'
- updated_at: '2021-11-16T15:44:27.159Z'
+ name: UPS Ground
+ code: UPS_GROUND
+ admin_name:
+ display_on: both
+ tracking_url:
+ created_at: '2021-11-17T08:59:25.611Z'
+ updated_at: '2021-11-17T08:59:25.611Z'
+ deleted_at:
+ public_metadata: {}
+ private_metadata: {}
+ relationships:
+ shipping_categories:
+ data:
+ - id: '125'
+ type: shipping_category
+ shipping_rates:
+ data: []
+ tax_category:
+ data:
+ calculator:
+ data:
+ id: '121'
+ type: calculator
meta:
count: 2
total_count: 2
total_pages: 1
links:
- self: http://www.example.com/api/v2/platform/shipping_categories?page=1&per_page=&filter[name_i_cont]=
- next: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
- prev: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
- last: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
- first: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
+ self: http://www.example.com/api/v2/platform/shipping_methods?page=1&per_page=&include=&filter[name]=&filter[title_cont]=
+ next: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
schema:
"$ref": "#/components/schemas/resources_list"
'401':
@@ -10628,14 +10500,21 @@ paths:
schema:
"$ref": "#/components/schemas/error"
post:
- summary: Create a Shipping Category
+ summary: Create a Shipping Method
tags:
- - Shipping Categories
+ - Shipping Methods
security:
- bearer_auth: []
- description: Creates a Shipping Category
- operationId: create-shipping-category
- parameters: []
+ description: Creates a Shipping Method
+ operationId: create-shipping-method
+ parameters:
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: calculator,shipping_categories,shipping_rates,tax_category
+ schema:
+ type: string
responses:
'201':
description: Record created
@@ -10645,12 +10524,34 @@ paths:
Example:
value:
data:
- id: '128'
- type: shipping_category
+ id: '64'
+ type: shipping_method
attributes:
- name: 'ShippingCategory #128'
- created_at: '2021-11-16T15:44:27.254Z'
- updated_at: '2021-11-16T15:44:27.254Z'
+ name: DHL Express Domestic
+ code: DDD
+ admin_name: DHL Express- Zone A
+ display_on: both
+ tracking_url:
+ created_at: '2021-11-17T08:59:25.784Z'
+ updated_at: '2021-11-17T08:59:25.784Z'
+ deleted_at:
+ public_metadata: {}
+ private_metadata: {}
+ relationships:
+ shipping_categories:
+ data:
+ - id: '127'
+ type: shipping_category
+ shipping_rates:
+ data: []
+ tax_category:
+ data:
+ id: '122'
+ type: tax_category
+ calculator:
+ data:
+ id: '124'
+ type: calculator
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -10660,32 +10561,47 @@ paths:
examples:
Example:
value:
- error: Name can't be blank
+ error: Calculator can't be blank, Name can't be blank, Display
+ on can't be blank, and You must select at least one shipping
+ category
errors:
+ calculator:
+ - can't be blank
name:
- can't be blank
+ display_on:
+ - can't be blank
+ base:
+ - You must select at least one shipping category
schema:
"$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/create_shipping_category_params"
- "/api/v2/platform/shipping_categories/{id}":
+ "$ref": "#/components/schemas/create_shipping_method_params"
+ "/api/v2/platform/shipping_methods/{id}":
get:
- summary: Return a Shipping Category
+ summary: Return a Shipping Method
tags:
- - Shipping Categories
+ - Shipping Methods
security:
- bearer_auth: []
- description: Returns a Shipping Category
- operationId: show-shipping-category
+ description: Returns a Shipping Method
+ operationId: show-shipping-method
parameters:
- name: id
in: path
required: true
schema:
type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: calculator,shipping_categories,shipping_rates,tax_category
+ schema:
+ type: string
responses:
'200':
description: Record found
@@ -10695,12 +10611,32 @@ paths:
Example:
value:
data:
- id: '129'
- type: shipping_category
+ id: '65'
+ type: shipping_method
attributes:
- name: 'ShippingCategory #129'
- created_at: '2021-11-16T15:44:27.314Z'
- updated_at: '2021-11-16T15:44:27.314Z'
+ name: UPS Ground
+ code: UPS_GROUND
+ admin_name:
+ display_on: both
+ tracking_url:
+ created_at: '2021-11-17T08:59:25.888Z'
+ updated_at: '2021-11-17T08:59:25.888Z'
+ deleted_at:
+ public_metadata: {}
+ private_metadata: {}
+ relationships:
+ shipping_categories:
+ data:
+ - id: '128'
+ type: shipping_category
+ shipping_rates:
+ data: []
+ tax_category:
+ data:
+ calculator:
+ data:
+ id: '125'
+ type: calculator
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -10724,19 +10660,26 @@ paths:
schema:
"$ref": "#/components/schemas/error"
patch:
- summary: Update a Shipping Category
+ summary: Update a Shipping Method
tags:
- - Shipping Categories
+ - Shipping Methods
security:
- bearer_auth: []
- description: Updates a Shipping Category
- operationId: update-shipping-category
+ description: Updates a Shipping Method
+ operationId: update-shipping-method
parameters:
- name: id
in: path
required: true
schema:
type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: calculator,shipping_categories,shipping_rates,tax_category
+ schema:
+ type: string
responses:
'200':
description: Record updated
@@ -10746,12 +10689,32 @@ paths:
Example:
value:
data:
- id: '131'
- type: shipping_category
+ id: '67'
+ type: shipping_method
attributes:
- name: Default
- created_at: '2021-11-16T15:44:27.416Z'
- updated_at: '2021-11-16T15:44:27.425Z'
+ name: FedEx Expedited
+ code: UPS_GROUND
+ admin_name:
+ display_on: both
+ tracking_url:
+ created_at: '2021-11-17T08:59:26.053Z'
+ updated_at: '2021-11-17T08:59:26.079Z'
+ deleted_at:
+ public_metadata: {}
+ private_metadata: {}
+ relationships:
+ shipping_categories:
+ data:
+ - id: '130'
+ type: shipping_category
+ shipping_rates:
+ data: []
+ tax_category:
+ data:
+ calculator:
+ data:
+ id: '128'
+ type: calculator
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -10791,15 +10754,15 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/update_shipping_category_params"
+ "$ref": "#/components/schemas/update_shipping_method_params"
delete:
- summary: Delete a Shipping Category
+ summary: Delete a Shipping Method
tags:
- - Shipping Categories
+ - Shipping Methods
security:
- bearer_auth: []
- description: Deletes a Shipping Category
- operationId: delete-shipping-category
+ description: Deletes a Shipping Method
+ operationId: delete-shipping-method
parameters:
- name: id
in: path
@@ -10829,15 +10792,15 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
- "/api/v2/platform/shipping_methods":
+ "/api/v2/platform/stock_locations":
get:
- summary: Return a list of Shipping Methods
+ summary: Return a list of Stock Locations
tags:
- - Shipping Methods
+ - Stock Locations
security:
- bearer_auth: []
- description: Returns a list of Shipping Methods
- operationId: shipping-methods-list
+ description: Returns a list of Stock Locations
+ operationId: stock-locations-list
parameters:
- name: page
in: query
@@ -10853,19 +10816,7 @@ paths:
in: query
description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
- example: calculator,shipping_categories,shipping_rates,tax_category
- schema:
- type: string
- - name: filter[name]
- in: query
- description: ''
- example: DHL Express
- schema:
- type: string
- - name: filter[title_cont]
- in: query
- description: ''
- example: About Us
+ example: country
schema:
type: string
responses:
@@ -10877,68 +10828,60 @@ paths:
Example:
value:
data:
- - id: '77'
- type: shipping_method
+ - id: '170'
+ type: stock_location
attributes:
- name: UPS Ground
- code: UPS_GROUND
+ name: Celinda Bahringer
+ created_at: '2021-11-17T08:59:26.429Z'
+ updated_at: '2021-11-17T08:59:26.429Z'
+ default: false
+ address1: 1600 Pennsylvania Ave NW
+ address2:
+ city: Washington
+ state_name:
+ zipcode: '20500'
+ phone: "(202) 456-1111"
+ active: true
+ backorderable_default: true
+ propagate_all_variants: true
admin_name:
- display_on: both
- tracking_url:
- created_at: '2021-11-16T15:44:27.650Z'
- updated_at: '2021-11-16T15:44:27.650Z'
- deleted_at:
- public_metadata: {}
- private_metadata: {}
relationships:
- shipping_categories:
- data:
- - id: '136'
- type: shipping_category
- shipping_rates:
- data: []
- tax_category:
- data:
- calculator:
+ country:
data:
- id: '137'
- type: calculator
- - id: '78'
- type: shipping_method
+ id: '367'
+ type: country
+ - id: '171'
+ type: stock_location
attributes:
- name: UPS Ground
- code: UPS_GROUND
+ name: Ethyl Weber
+ created_at: '2021-11-17T08:59:26.435Z'
+ updated_at: '2021-11-17T08:59:26.435Z'
+ default: false
+ address1: 1600 Pennsylvania Ave NW
+ address2:
+ city: Washington
+ state_name:
+ zipcode: '20500'
+ phone: "(202) 456-1111"
+ active: true
+ backorderable_default: true
+ propagate_all_variants: true
admin_name:
- display_on: both
- tracking_url:
- created_at: '2021-11-16T15:44:27.663Z'
- updated_at: '2021-11-16T15:44:27.663Z'
- deleted_at:
- public_metadata: {}
- private_metadata: {}
relationships:
- shipping_categories:
- data:
- - id: '136'
- type: shipping_category
- shipping_rates:
- data: []
- tax_category:
- data:
- calculator:
+ country:
data:
- id: '138'
- type: calculator
+ id: '367'
+ type: country
meta:
count: 2
total_count: 2
total_pages: 1
links:
- self: http://www.example.com/api/v2/platform/shipping_methods?page=1&per_page=&include=&filter[name]=&filter[title_cont]=
- next: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
- prev: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
- last: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
- first: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
+ self: http://www.example.com/api/v2/platform/stock_locations?page=1&per_page=&include=
+ next: http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=
schema:
"$ref": "#/components/schemas/resources_list"
'401':
@@ -10952,19 +10895,19 @@ paths:
schema:
"$ref": "#/components/schemas/error"
post:
- summary: Create a Shipping Method
+ summary: Create a Stock Location
tags:
- - Shipping Methods
+ - Stock Locations
security:
- bearer_auth: []
- description: Creates a Shipping Method
- operationId: create-shipping-method
+ description: Creates a Stock Location
+ operationId: create-stock-location
parameters:
- name: include
in: query
description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
- example: calculator,shipping_categories,shipping_rates,tax_category
+ example: country
schema:
type: string
responses:
@@ -10976,34 +10919,28 @@ paths:
Example:
value:
data:
- id: '81'
- type: shipping_method
+ id: '174'
+ type: stock_location
attributes:
- name: DHL Express Domestic
- code: DDD
- admin_name: DHL Express- Zone A
- display_on: both
- tracking_url:
- created_at: '2021-11-16T15:44:27.802Z'
- updated_at: '2021-11-16T15:44:27.802Z'
- deleted_at:
- public_metadata: {}
- private_metadata: {}
+ name: Ardath Vandervort
+ created_at: '2021-11-17T08:59:26.558Z'
+ updated_at: '2021-11-17T08:59:26.558Z'
+ default: false
+ address1: 1600 Pennsylvania Ave NW
+ address2:
+ city: Washington
+ state_name:
+ zipcode: '20500'
+ phone: "(202) 456-1111"
+ active: true
+ backorderable_default: true
+ propagate_all_variants: true
+ admin_name:
relationships:
- shipping_categories:
- data:
- - id: '138'
- type: shipping_category
- shipping_rates:
- data: []
- tax_category:
- data:
- id: '133'
- type: tax_category
- calculator:
+ country:
data:
- id: '141'
- type: calculator
+ id: '369'
+ type: country
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -11013,34 +10950,26 @@ paths:
examples:
Example:
value:
- error: Calculator can't be blank, Name can't be blank, Display
- on can't be blank, and You must select at least one shipping
- category
+ error: Name can't be blank
errors:
- calculator:
- - can't be blank
name:
- can't be blank
- display_on:
- - can't be blank
- base:
- - You must select at least one shipping category
schema:
"$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/create_shipping_method_params"
- "/api/v2/platform/shipping_methods/{id}":
+ "$ref": "#/components/schemas/create_stock_location_params"
+ "/api/v2/platform/stock_locations/{id}":
get:
- summary: Return a Shipping Method
+ summary: Return a Stock Location
tags:
- - Shipping Methods
+ - Stock Locations
security:
- bearer_auth: []
- description: Returns a Shipping Method
- operationId: show-shipping-method
+ description: Returns a Stock Location
+ operationId: show-stock-location
parameters:
- name: id
in: path
@@ -11051,7 +10980,7 @@ paths:
in: query
description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
- example: calculator,shipping_categories,shipping_rates,tax_category
+ example: country
schema:
type: string
responses:
@@ -11063,32 +10992,28 @@ paths:
Example:
value:
data:
- id: '82'
- type: shipping_method
+ id: '175'
+ type: stock_location
attributes:
- name: UPS Ground
- code: UPS_GROUND
+ name: Dorathy Fahey
+ created_at: '2021-11-17T08:59:26.639Z'
+ updated_at: '2021-11-17T08:59:26.639Z'
+ default: false
+ address1: 1600 Pennsylvania Ave NW
+ address2:
+ city: Washington
+ state_name:
+ zipcode: '20500'
+ phone: "(202) 456-1111"
+ active: true
+ backorderable_default: true
+ propagate_all_variants: true
admin_name:
- display_on: both
- tracking_url:
- created_at: '2021-11-16T15:44:27.879Z'
- updated_at: '2021-11-16T15:44:27.879Z'
- deleted_at:
- public_metadata: {}
- private_metadata: {}
relationships:
- shipping_categories:
- data:
- - id: '139'
- type: shipping_category
- shipping_rates:
- data: []
- tax_category:
- data:
- calculator:
+ country:
data:
- id: '142'
- type: calculator
+ id: '371'
+ type: country
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -11112,13 +11037,13 @@ paths:
schema:
"$ref": "#/components/schemas/error"
patch:
- summary: Update a Shipping Method
+ summary: Update a Stock Location
tags:
- - Shipping Methods
+ - Stock Locations
security:
- bearer_auth: []
- description: Updates a Shipping Method
- operationId: update-shipping-method
+ description: Updates a Stock Location
+ operationId: update-stock-location
parameters:
- name: id
in: path
@@ -11129,7 +11054,7 @@ paths:
in: query
description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
- example: calculator,shipping_categories,shipping_rates,tax_category
+ example: country
schema:
type: string
responses:
@@ -11141,32 +11066,28 @@ paths:
Example:
value:
data:
- id: '84'
- type: shipping_method
+ id: '177'
+ type: stock_location
attributes:
- name: FedEx Expedited
- code: UPS_GROUND
+ name: Warehouse 3
+ created_at: '2021-11-17T08:59:26.774Z'
+ updated_at: '2021-11-17T08:59:26.787Z'
+ default: true
+ address1: South Street 8/2
+ address2:
+ city: Los Angeles
+ state_name:
+ zipcode: '11223'
+ phone: "(202) 456-1111"
+ active: true
+ backorderable_default: true
+ propagate_all_variants: true
admin_name:
- display_on: both
- tracking_url:
- created_at: '2021-11-16T15:44:28.014Z'
- updated_at: '2021-11-16T15:44:28.033Z'
- deleted_at:
- public_metadata: {}
- private_metadata: {}
relationships:
- shipping_categories:
- data:
- - id: '141'
- type: shipping_category
- shipping_rates:
- data: []
- tax_category:
- data:
- calculator:
+ country:
data:
- id: '145'
- type: calculator
+ id: '374'
+ type: country
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -11206,15 +11127,15 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/update_shipping_method_params"
+ "$ref": "#/components/schemas/update_stock_location_params"
delete:
- summary: Delete a Shipping Method
+ summary: Delete a Stock Location
tags:
- - Shipping Methods
+ - Stock Locations
security:
- bearer_auth: []
- description: Deletes a Shipping Method
- operationId: delete-shipping-method
+ description: Deletes a Stock Location
+ operationId: delete-stock-location
parameters:
- name: id
in: path
@@ -11283,14 +11204,14 @@ paths:
type: store_credit_category
attributes:
name: Exchange
- created_at: '2021-11-16T15:44:28.312Z'
- updated_at: '2021-11-16T15:44:28.312Z'
+ created_at: '2021-11-17T08:59:27.062Z'
+ updated_at: '2021-11-17T08:59:27.062Z'
- id: '3'
type: store_credit_category
attributes:
name: Exchange
- created_at: '2021-11-16T15:44:28.313Z'
- updated_at: '2021-11-16T15:44:28.313Z'
+ created_at: '2021-11-17T08:59:27.064Z'
+ updated_at: '2021-11-17T08:59:27.064Z'
meta:
count: 2
total_count: 2
@@ -11335,8 +11256,8 @@ paths:
type: store_credit_category
attributes:
name: Exchange
- created_at: '2021-11-16T15:44:28.403Z'
- updated_at: '2021-11-16T15:44:28.403Z'
+ created_at: '2021-11-17T08:59:27.164Z'
+ updated_at: '2021-11-17T08:59:27.164Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -11385,8 +11306,8 @@ paths:
type: store_credit_category
attributes:
name: Exchange
- created_at: '2021-11-16T15:44:28.464Z'
- updated_at: '2021-11-16T15:44:28.464Z'
+ created_at: '2021-11-17T08:59:27.241Z'
+ updated_at: '2021-11-17T08:59:27.241Z'
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -11436,8 +11357,8 @@ paths:
type: store_credit_category
attributes:
name: refunded
- created_at: '2021-11-16T15:44:28.556Z'
- updated_at: '2021-11-16T15:44:28.564Z'
+ created_at: '2021-11-17T08:59:27.359Z'
+ updated_at: '2021-11-17T08:59:27.372Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -11549,15 +11470,15 @@ paths:
attributes:
name: Expiring
priority: 1
- created_at: '2021-11-16T15:44:28.770Z'
- updated_at: '2021-11-16T15:44:28.770Z'
+ created_at: '2021-11-17T08:59:27.622Z'
+ updated_at: '2021-11-17T08:59:27.622Z'
- id: '3'
type: store_credit_type
attributes:
name: Expiring
priority: 1
- created_at: '2021-11-16T15:44:28.771Z'
- updated_at: '2021-11-16T15:44:28.771Z'
+ created_at: '2021-11-17T08:59:27.623Z'
+ updated_at: '2021-11-17T08:59:27.623Z'
meta:
count: 2
total_count: 2
@@ -11603,8 +11524,8 @@ paths:
attributes:
name: Expiring
priority: 1
- created_at: '2021-11-16T15:44:28.847Z'
- updated_at: '2021-11-16T15:44:28.847Z'
+ created_at: '2021-11-17T08:59:27.726Z'
+ updated_at: '2021-11-17T08:59:27.726Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -11654,8 +11575,8 @@ paths:
attributes:
name: Expiring
priority: 1
- created_at: '2021-11-16T15:44:28.918Z'
- updated_at: '2021-11-16T15:44:28.918Z'
+ created_at: '2021-11-17T08:59:27.799Z'
+ updated_at: '2021-11-17T08:59:27.799Z'
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -11706,8 +11627,8 @@ paths:
attributes:
name: default
priority: 1
- created_at: '2021-11-16T15:44:29.009Z'
- updated_at: '2021-11-16T15:44:29.017Z'
+ created_at: '2021-11-17T08:59:28.093Z'
+ updated_at: '2021-11-17T08:59:28.104Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -11855,8 +11776,8 @@ paths:
currency: USD
amount_authorized: '0.0'
originator_type:
- created_at: '2021-11-16T15:44:29.227Z'
- updated_at: '2021-11-16T15:44:29.227Z'
+ created_at: '2021-11-17T08:59:28.399Z'
+ updated_at: '2021-11-17T08:59:28.399Z'
public_metadata: {}
private_metadata: {}
display_amount_used: "$0.00"
@@ -11864,11 +11785,11 @@ paths:
relationships:
user:
data:
- id: '107'
+ id: '97'
type: user
created_by:
data:
- id: '108'
+ id: '98'
type: user
store_credit_category:
data:
@@ -11892,8 +11813,8 @@ paths:
currency: USD
amount_authorized: '0.0'
originator_type:
- created_at: '2021-11-16T15:44:29.236Z'
- updated_at: '2021-11-16T15:44:29.236Z'
+ created_at: '2021-11-17T08:59:28.417Z'
+ updated_at: '2021-11-17T08:59:28.417Z'
public_metadata: {}
private_metadata: {}
display_amount_used: "$0.00"
@@ -11901,11 +11822,11 @@ paths:
relationships:
user:
data:
- id: '107'
+ id: '97'
type: user
created_by:
data:
- id: '109'
+ id: '99'
type: user
store_credit_category:
data:
@@ -11976,8 +11897,8 @@ paths:
currency: USD
amount_authorized: '0.0'
originator_type:
- created_at: '2021-11-16T15:44:29.352Z'
- updated_at: '2021-11-16T15:44:29.352Z'
+ created_at: '2021-11-17T08:59:28.621Z'
+ updated_at: '2021-11-17T08:59:28.621Z'
public_metadata: {}
private_metadata: {}
display_amount_used: "$0.00"
@@ -11985,11 +11906,11 @@ paths:
relationships:
user:
data:
- id: '113'
+ id: '103'
type: user
created_by:
data:
- id: '114'
+ id: '104'
type: user
store_credit_category:
data:
@@ -12081,8 +12002,8 @@ paths:
currency: USD
amount_authorized: '0.0'
originator_type:
- created_at: '2021-11-16T15:44:29.439Z'
- updated_at: '2021-11-16T15:44:29.439Z'
+ created_at: '2021-11-17T08:59:28.723Z'
+ updated_at: '2021-11-17T08:59:28.723Z'
public_metadata: {}
private_metadata: {}
display_amount_used: "$0.00"
@@ -12090,11 +12011,11 @@ paths:
relationships:
user:
data:
- id: '115'
+ id: '105'
type: user
created_by:
data:
- id: '116'
+ id: '106'
type: user
store_credit_category:
data:
@@ -12170,8 +12091,8 @@ paths:
currency: CAD
amount_authorized: '0.0'
originator_type:
- created_at: '2021-11-16T15:44:29.558Z'
- updated_at: '2021-11-16T15:44:29.574Z'
+ created_at: '2021-11-17T08:59:28.912Z'
+ updated_at: '2021-11-17T08:59:28.936Z'
public_metadata:
loyalty_reward: true
private_metadata: {}
@@ -12180,11 +12101,11 @@ paths:
relationships:
user:
data:
- id: '119'
+ id: '109'
type: user
created_by:
data:
- id: '120'
+ id: '110'
type: user
store_credit_category:
data:
@@ -12334,29 +12255,28 @@ paths:
Example:
value:
data:
- - id: '134'
+ - id: '123'
type: tax_category
attributes:
- name: TaxCategory - 260920
- description: Possimus rerum ex accusantium soluta.
+ name: TaxCategory - 176683
+ description: Aliquam rem architecto dolorem assumenda delectus.
is_default: false
deleted_at:
- created_at: '2021-11-16T15:44:29.835Z'
- updated_at: '2021-11-16T15:44:29.835Z'
+ created_at: '2021-11-17T08:59:29.278Z'
+ updated_at: '2021-11-17T08:59:29.278Z'
tax_code:
relationships:
tax_rates:
data: []
- - id: '135'
+ - id: '124'
type: tax_category
attributes:
- name: TaxCategory - 921018
- description: Culpa facere et perferendis modi doloremque eos
- dolorum.
+ name: TaxCategory - 291605
+ description: Magni fugit a odio blanditiis id cum aliquid.
is_default: false
deleted_at:
- created_at: '2021-11-16T15:44:29.836Z'
- updated_at: '2021-11-16T15:44:29.836Z'
+ created_at: '2021-11-17T08:59:29.281Z'
+ updated_at: '2021-11-17T08:59:29.281Z'
tax_code:
relationships:
tax_rates:
@@ -12408,15 +12328,15 @@ paths:
Example:
value:
data:
- id: '138'
+ id: '127'
type: tax_category
attributes:
- name: TaxCategory - 826541
- description: Numquam ad dolore ipsa magnam asperiores.
+ name: TaxCategory - 533682
+ description: Ad architecto tempore rem aliquam iure eos.
is_default: false
deleted_at:
- created_at: '2021-11-16T15:44:29.919Z'
- updated_at: '2021-11-16T15:44:29.919Z'
+ created_at: '2021-11-17T08:59:29.571Z'
+ updated_at: '2021-11-17T08:59:29.571Z'
tax_code:
relationships:
tax_rates:
@@ -12472,15 +12392,15 @@ paths:
Example:
value:
data:
- id: '139'
+ id: '128'
type: tax_category
attributes:
- name: TaxCategory - 76211
- description: Minus nemo atque deserunt corporis.
+ name: TaxCategory - 194111
+ description: Harum tenetur ut ullam nobis minus cumque.
is_default: false
deleted_at:
- created_at: '2021-11-16T15:44:29.994Z'
- updated_at: '2021-11-16T15:44:29.994Z'
+ created_at: '2021-11-17T08:59:29.643Z'
+ updated_at: '2021-11-17T08:59:29.643Z'
tax_code:
relationships:
tax_rates:
@@ -12537,15 +12457,15 @@ paths:
Example:
value:
data:
- id: '141'
+ id: '130'
type: tax_category
attributes:
name: Clothing
description: Men's, women's and children's clothing
is_default: true
deleted_at:
- created_at: '2021-11-16T15:44:30.094Z'
- updated_at: '2021-11-16T15:44:30.104Z'
+ created_at: '2021-11-17T08:59:29.766Z'
+ updated_at: '2021-11-17T08:59:29.777Z'
tax_code: 1233K
relationships:
tax_rates:
@@ -12686,38 +12606,38 @@ paths:
attributes:
amount: '0.1'
included_in_price: false
- created_at: '2021-11-16T15:44:30.331Z'
- updated_at: '2021-11-16T15:44:30.331Z'
+ created_at: '2021-11-17T08:59:30.037Z'
+ updated_at: '2021-11-17T08:59:30.037Z'
name:
show_rate_in_label: true
deleted_at:
relationships:
zone:
data:
- id: '99'
+ id: '82'
type: zone
tax_category:
data:
- id: '146'
+ id: '135'
type: tax_category
- id: '13'
type: tax_rate
attributes:
amount: '0.1'
included_in_price: false
- created_at: '2021-11-16T15:44:30.336Z'
- updated_at: '2021-11-16T15:44:30.336Z'
+ created_at: '2021-11-17T08:59:30.042Z'
+ updated_at: '2021-11-17T08:59:30.042Z'
name:
show_rate_in_label: true
deleted_at:
relationships:
zone:
data:
- id: '100'
+ id: '83'
type: zone
tax_category:
data:
- id: '146'
+ id: '135'
type: tax_category
meta:
count: 2
@@ -12771,8 +12691,8 @@ paths:
attributes:
amount: '0.1'
included_in_price: false
- created_at: '2021-11-16T15:44:30.441Z'
- updated_at: '2021-11-16T15:44:30.441Z'
+ created_at: '2021-11-17T08:59:30.173Z'
+ updated_at: '2021-11-17T08:59:30.173Z'
name:
show_rate_in_label: true
deleted_at:
@@ -12781,7 +12701,7 @@ paths:
data:
tax_category:
data:
- id: '148'
+ id: '137'
type: tax_category
schema:
"$ref": "#/components/schemas/resource"
@@ -12844,19 +12764,19 @@ paths:
attributes:
amount: '0.1'
included_in_price: false
- created_at: '2021-11-16T15:44:30.523Z'
- updated_at: '2021-11-16T15:44:30.523Z'
+ created_at: '2021-11-17T08:59:30.262Z'
+ updated_at: '2021-11-17T08:59:30.262Z'
name:
show_rate_in_label: true
deleted_at:
relationships:
zone:
data:
- id: '103'
+ id: '86'
type: zone
tax_category:
data:
- id: '149'
+ id: '138'
type: tax_category
schema:
"$ref": "#/components/schemas/resource"
@@ -12915,19 +12835,19 @@ paths:
attributes:
amount: '25.9'
included_in_price: true
- created_at: '2021-11-16T15:44:30.639Z'
- updated_at: '2021-11-16T15:44:30.652Z'
+ created_at: '2021-11-17T08:59:30.392Z'
+ updated_at: '2021-11-17T08:59:30.408Z'
name:
show_rate_in_label: true
deleted_at:
relationships:
zone:
data:
- id: '106'
+ id: '89'
type: zone
tax_category:
data:
- id: '151'
+ id: '140'
type: tax_category
schema:
"$ref": "#/components/schemas/resource"
@@ -13052,8 +12972,8 @@ paths:
type: taxonomy
attributes:
name: taxonomy_13
- created_at: '2021-11-16T15:44:30.913Z'
- updated_at: '2021-11-16T15:44:30.933Z'
+ created_at: '2021-11-17T08:59:30.694Z'
+ updated_at: '2021-11-17T08:59:30.717Z'
position: 1
public_metadata: {}
private_metadata: {}
@@ -13070,8 +12990,8 @@ paths:
type: taxonomy
attributes:
name: taxonomy_14
- created_at: '2021-11-16T15:44:30.935Z'
- updated_at: '2021-11-16T15:44:30.954Z'
+ created_at: '2021-11-17T08:59:30.721Z'
+ updated_at: '2021-11-17T08:59:30.743Z'
position: 2
public_metadata: {}
private_metadata: {}
@@ -13135,8 +13055,8 @@ paths:
type: taxonomy
attributes:
name: taxonomy_17
- created_at: '2021-11-16T15:44:31.081Z'
- updated_at: '2021-11-16T15:44:31.081Z'
+ created_at: '2021-11-17T08:59:31.102Z'
+ updated_at: '2021-11-17T08:59:31.102Z'
position: 1
public_metadata: {}
private_metadata: {}
@@ -13204,8 +13124,8 @@ paths:
type: taxonomy
attributes:
name: taxonomy_18
- created_at: '2021-11-16T15:44:31.175Z'
- updated_at: '2021-11-16T15:44:31.195Z'
+ created_at: '2021-11-17T08:59:31.246Z'
+ updated_at: '2021-11-17T08:59:31.275Z'
position: 1
public_metadata: {}
private_metadata: {}
@@ -13274,8 +13194,8 @@ paths:
type: taxonomy
attributes:
name: Categories
- created_at: '2021-11-16T15:44:31.316Z'
- updated_at: '2021-11-16T15:44:31.345Z'
+ created_at: '2021-11-17T08:59:31.424Z'
+ updated_at: '2021-11-17T08:59:31.457Z'
position: 1
public_metadata:
balanced: true
@@ -13423,8 +13343,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-11-16T15:44:31.765Z'
- updated_at: '2021-11-16T15:44:31.770Z'
+ created_at: '2021-11-17T08:59:32.034Z'
+ updated_at: '2021-11-17T08:59:32.040Z'
meta_title:
meta_description:
meta_keywords:
@@ -13460,8 +13380,8 @@ paths:
lft: 4
rgt: 5
description:
- created_at: '2021-11-16T15:44:31.859Z'
- updated_at: '2021-11-16T15:44:31.864Z'
+ created_at: '2021-11-17T08:59:32.132Z'
+ updated_at: '2021-11-17T08:59:32.140Z'
meta_title:
meta_description:
meta_keywords:
@@ -13497,8 +13417,8 @@ paths:
lft: 6
rgt: 7
description:
- created_at: '2021-11-16T15:44:31.952Z'
- updated_at: '2021-11-16T15:44:31.957Z'
+ created_at: '2021-11-17T08:59:32.230Z'
+ updated_at: '2021-11-17T08:59:32.235Z'
meta_title:
meta_description:
meta_keywords:
@@ -13534,8 +13454,8 @@ paths:
lft: 1
rgt: 8
description:
- created_at: '2021-11-16T15:44:31.680Z'
- updated_at: '2021-11-16T15:44:31.979Z'
+ created_at: '2021-11-17T08:59:31.932Z'
+ updated_at: '2021-11-17T08:59:32.251Z'
meta_title:
meta_description:
meta_keywords:
@@ -13620,8 +13540,8 @@ paths:
lft: 4
rgt: 5
description:
- created_at: '2021-11-16T15:44:32.553Z'
- updated_at: '2021-11-16T15:44:32.560Z'
+ created_at: '2021-11-17T08:59:32.907Z'
+ updated_at: '2021-11-17T08:59:32.916Z'
meta_title:
meta_description:
meta_keywords:
@@ -13708,8 +13628,8 @@ paths:
lft: 6
rgt: 7
description:
- created_at: '2021-11-16T15:44:32.981Z'
- updated_at: '2021-11-16T15:44:32.987Z'
+ created_at: '2021-11-17T08:59:33.450Z'
+ updated_at: '2021-11-17T08:59:33.469Z'
meta_title:
meta_description:
meta_keywords:
@@ -13799,8 +13719,8 @@ paths:
lft: 6
rgt: 7
description:
- created_at: '2021-11-16T15:44:33.721Z'
- updated_at: '2021-11-16T15:44:33.756Z'
+ created_at: '2021-11-17T08:59:34.468Z'
+ updated_at: '2021-11-17T08:59:34.508Z'
meta_title:
meta_description:
meta_keywords:
@@ -13938,8 +13858,8 @@ paths:
lft: 3
rgt: 4
description:
- created_at: '2021-11-16T15:44:35.530Z'
- updated_at: '2021-11-16T15:44:35.564Z'
+ created_at: '2021-11-17T08:59:36.351Z'
+ updated_at: '2021-11-17T08:59:36.398Z'
meta_title:
meta_description:
meta_keywords:
@@ -14041,12 +13961,12 @@ paths:
Example:
value:
data:
- - id: '129'
+ - id: '119'
type: user
attributes:
- created_at: '2021-11-16T15:44:36.048Z'
- updated_at: '2021-11-16T15:44:36.048Z'
+ created_at: '2021-11-17T08:59:37.031Z'
+ updated_at: '2021-11-17T08:59:37.031Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -14057,12 +13977,12 @@ paths:
data:
ship_address:
data:
- - id: '130'
+ - id: '120'
type: user
attributes:
- created_at: '2021-11-16T15:44:36.057Z'
- updated_at: '2021-11-16T15:44:36.057Z'
+ created_at: '2021-11-17T08:59:37.041Z'
+ updated_at: '2021-11-17T08:59:37.041Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -14073,12 +13993,12 @@ paths:
data:
ship_address:
data:
- - id: '131'
+ - id: '121'
type: user
attributes:
- created_at: '2021-11-16T15:44:36.060Z'
- updated_at: '2021-11-16T15:44:36.060Z'
+ created_at: '2021-11-17T08:59:37.044Z'
+ updated_at: '2021-11-17T08:59:37.044Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -14136,12 +14056,12 @@ paths:
Example:
value:
data:
- id: '136'
+ id: '126'
type: user
attributes:
- created_at: '2021-11-16T15:44:36.202Z'
- updated_at: '2021-11-16T15:44:36.202Z'
+ created_at: '2021-11-17T08:59:37.201Z'
+ updated_at: '2021-11-17T08:59:37.201Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -14203,12 +14123,12 @@ paths:
Example:
value:
data:
- id: '139'
+ id: '129'
type: user
attributes:
- created_at: '2021-11-16T15:44:36.285Z'
- updated_at: '2021-11-16T15:44:36.285Z'
+ created_at: '2021-11-17T08:59:37.307Z'
+ updated_at: '2021-11-17T08:59:37.307Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -14271,12 +14191,12 @@ paths:
Example:
value:
data:
- id: '144'
+ id: '134'
type: user
attributes:
- created_at: '2021-11-16T15:44:36.427Z'
- updated_at: '2021-11-16T15:44:36.439Z'
+ created_at: '2021-11-17T08:59:37.459Z'
+ updated_at: '2021-11-17T08:59:37.472Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -14412,10 +14332,10 @@ paths:
Example:
value:
data:
- - id: '259'
+ - id: '245'
type: variant
attributes:
- sku: SKU-259
+ sku: SKU-245
weight: '0.0'
height:
depth:
@@ -14425,14 +14345,14 @@ paths:
position: 1
cost_currency: USD
track_inventory: true
- updated_at: '2021-11-16T15:44:36.776Z'
+ updated_at: '2021-11-17T08:59:37.865Z'
discontinue_on:
- created_at: '2021-11-16T15:44:36.768Z'
+ created_at: '2021-11-17T08:59:37.857Z'
public_metadata: {}
private_metadata: {}
display_compare_at_price:
display_price: "$19.99"
- name: 'Product #192 - 8637'
+ name: 'Product #178 - 5794'
options_text: ''
total_on_hand: 0
purchasable: true
@@ -14445,7 +14365,7 @@ paths:
relationships:
product:
data:
- id: '192'
+ id: '178'
type: product
tax_category:
data:
@@ -14457,33 +14377,33 @@ paths:
data: []
stock_items:
data:
- - id: '335'
+ - id: '300'
type: stock_item
stock_locations:
data:
- - id: '198'
+ - id: '182'
type: stock_location
- - id: '260'
+ - id: '246'
type: variant
attributes:
- sku: SKU-260
- weight: '36.19'
- height: '101.86'
- depth: '105.45'
+ sku: SKU-246
+ weight: '61.94'
+ height: '99.59'
+ depth: '45.89'
deleted_at:
is_master: false
cost_price: '17.0'
position: 2
cost_currency: USD
track_inventory: true
- updated_at: '2021-11-16T15:44:36.813Z'
+ updated_at: '2021-11-17T08:59:37.907Z'
discontinue_on:
- created_at: '2021-11-16T15:44:36.804Z'
+ created_at: '2021-11-17T08:59:37.898Z'
public_metadata: {}
private_metadata: {}
display_compare_at_price:
display_price: "$19.99"
- name: 'Product #192 - 8637'
+ name: 'Product #178 - 5794'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -14496,7 +14416,7 @@ paths:
relationships:
product:
data:
- id: '192'
+ id: '178'
type: product
tax_category:
data:
@@ -14510,33 +14430,33 @@ paths:
type: option_value
stock_items:
data:
- - id: '336'
+ - id: '301'
type: stock_item
stock_locations:
data:
- - id: '198'
+ - id: '182'
type: stock_location
- - id: '261'
+ - id: '247'
type: variant
attributes:
- sku: SKU-261
- weight: '90.77'
- height: '22.57'
- depth: '126.44'
+ sku: SKU-247
+ weight: '138.2'
+ height: '197.32'
+ depth: '16.38'
deleted_at:
is_master: false
cost_price: '17.0'
position: 3
cost_currency: USD
track_inventory: true
- updated_at: '2021-11-16T15:44:36.837Z'
+ updated_at: '2021-11-17T08:59:37.937Z'
discontinue_on:
- created_at: '2021-11-16T15:44:36.829Z'
+ created_at: '2021-11-17T08:59:37.928Z'
public_metadata: {}
private_metadata: {}
display_compare_at_price:
display_price: "$19.99"
- name: 'Product #192 - 8637'
+ name: 'Product #178 - 5794'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -14549,7 +14469,7 @@ paths:
relationships:
product:
data:
- id: '192'
+ id: '178'
type: product
tax_category:
data:
@@ -14563,11 +14483,11 @@ paths:
type: option_value
stock_items:
data:
- - id: '337'
+ - id: '302'
type: stock_item
stock_locations:
data:
- - id: '198'
+ - id: '182'
type: stock_location
meta:
count: 3
@@ -14622,27 +14542,27 @@ paths:
Example:
value:
data:
- id: '266'
+ id: '252'
type: variant
attributes:
- sku: SKU-266
- weight: '11.32'
- height: '149.44'
- depth: '178.92'
+ sku: SKU-252
+ weight: '57.15'
+ height: '140.2'
+ depth: '173.7'
deleted_at:
is_master: false
cost_price: '17.0'
position: 2
cost_currency: USD
track_inventory: true
- updated_at: '2021-11-16T15:44:37.121Z'
+ updated_at: '2021-11-17T08:59:38.304Z'
discontinue_on:
- created_at: '2021-11-16T15:44:37.113Z'
+ created_at: '2021-11-17T08:59:38.295Z'
public_metadata: {}
private_metadata: {}
display_compare_at_price:
display_price: "$19.99"
- name: 'Product #194 - 8884'
+ name: 'Product #180 - 5235'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -14655,7 +14575,7 @@ paths:
relationships:
product:
data:
- id: '194'
+ id: '180'
type: product
tax_category:
data:
@@ -14669,11 +14589,11 @@ paths:
type: option_value
stock_items:
data:
- - id: '342'
+ - id: '307'
type: stock_item
stock_locations:
data:
- - id: '200'
+ - id: '184'
type: stock_location
schema:
"$ref": "#/components/schemas/resource"
@@ -14803,14 +14723,14 @@ paths:
- id: '1'
type: event
attributes:
- execution_time: 88449
+ execution_time: 90955
name: order.canceled
request_errors: ''
response_code: '200'
success: true
url: https://www.url1.com/
- created_at: '2021-11-16T15:44:37.581Z'
- updated_at: '2021-11-16T15:44:37.581Z'
+ created_at: '2021-11-17T08:59:38.886Z'
+ updated_at: '2021-11-17T08:59:38.886Z'
relationships:
subscriber:
data:
@@ -14819,14 +14739,14 @@ paths:
- id: '2'
type: event
attributes:
- execution_time: 4857
+ execution_time: 96586
name: order.canceled
request_errors: ''
response_code: '200'
success: true
url: https://www.url2.com/
- created_at: '2021-11-16T15:44:37.584Z'
- updated_at: '2021-11-16T15:44:37.584Z'
+ created_at: '2021-11-17T08:59:38.889Z'
+ updated_at: '2021-11-17T08:59:38.889Z'
relationships:
subscriber:
data:
@@ -14902,8 +14822,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-16T15:44:37.677Z'
- updated_at: '2021-11-16T15:44:37.677Z'
+ created_at: '2021-11-17T08:59:38.981Z'
+ updated_at: '2021-11-17T08:59:38.981Z'
- id: '6'
type: subscriber
attributes:
@@ -14911,8 +14831,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-16T15:44:37.678Z'
- updated_at: '2021-11-16T15:44:37.678Z'
+ created_at: '2021-11-17T08:59:38.983Z'
+ updated_at: '2021-11-17T08:59:38.983Z'
meta:
count: 2
total_count: 2
@@ -14960,8 +14880,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-16T15:44:37.759Z'
- updated_at: '2021-11-16T15:44:37.759Z'
+ created_at: '2021-11-17T08:59:39.084Z'
+ updated_at: '2021-11-17T08:59:39.084Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -15016,8 +14936,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-16T15:44:37.819Z'
- updated_at: '2021-11-16T15:44:37.819Z'
+ created_at: '2021-11-17T08:59:39.153Z'
+ updated_at: '2021-11-17T08:59:39.153Z'
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -15070,8 +14990,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-16T15:44:37.926Z'
- updated_at: '2021-11-16T15:44:37.926Z'
+ created_at: '2021-11-17T08:59:39.263Z'
+ updated_at: '2021-11-17T08:59:39.263Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -15192,8 +15112,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-16T15:44:38.301Z'
- updated_at: '2021-11-16T15:44:38.301Z'
+ created_at: '2021-11-17T08:59:39.699Z'
+ updated_at: '2021-11-17T08:59:39.699Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -15201,14 +15121,14 @@ paths:
relationships:
variant:
data:
- id: '276'
+ id: '262'
type: variant
- id: '2'
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-16T15:44:38.360Z'
- updated_at: '2021-11-16T15:44:38.360Z'
+ created_at: '2021-11-17T08:59:39.781Z'
+ updated_at: '2021-11-17T08:59:39.781Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -15216,14 +15136,14 @@ paths:
relationships:
variant:
data:
- id: '278'
+ id: '264'
type: variant
- id: '3'
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-16T15:44:38.420Z'
- updated_at: '2021-11-16T15:44:38.420Z'
+ created_at: '2021-11-17T08:59:39.859Z'
+ updated_at: '2021-11-17T08:59:39.859Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -15231,14 +15151,14 @@ paths:
relationships:
variant:
data:
- id: '280'
+ id: '266'
type: variant
- id: '4'
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-16T15:44:38.478Z'
- updated_at: '2021-11-16T15:44:38.478Z'
+ created_at: '2021-11-17T08:59:39.936Z'
+ updated_at: '2021-11-17T08:59:39.936Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -15246,7 +15166,7 @@ paths:
relationships:
variant:
data:
- id: '282'
+ id: '268'
type: variant
meta:
count: 4
@@ -15299,8 +15219,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-16T15:44:38.967Z'
- updated_at: '2021-11-16T15:44:38.967Z'
+ created_at: '2021-11-17T08:59:40.643Z'
+ updated_at: '2021-11-17T08:59:40.643Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -15308,7 +15228,7 @@ paths:
relationships:
variant:
data:
- id: '294'
+ id: '280'
type: variant
schema:
"$ref": "#/components/schemas/resource"
@@ -15370,8 +15290,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-16T15:44:39.258Z'
- updated_at: '2021-11-16T15:44:39.258Z'
+ created_at: '2021-11-17T08:59:41.225Z'
+ updated_at: '2021-11-17T08:59:41.225Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -15379,7 +15299,7 @@ paths:
relationships:
variant:
data:
- id: '300'
+ id: '286'
type: variant
schema:
"$ref": "#/components/schemas/resource"
@@ -15437,8 +15357,8 @@ paths:
type: wished_item
attributes:
quantity: 3
- created_at: '2021-11-16T15:44:39.714Z'
- updated_at: '2021-11-16T15:44:39.724Z'
+ created_at: '2021-11-17T08:59:42.034Z'
+ updated_at: '2021-11-17T08:59:42.046Z'
display_price: "$19.99"
display_total: "$59.97"
price: '19.99'
@@ -15446,7 +15366,7 @@ paths:
relationships:
variant:
data:
- id: '310'
+ id: '296'
type: variant
schema:
"$ref": "#/components/schemas/resource"
@@ -15573,9 +15493,9 @@ paths:
name: Black Friday
is_private: true
is_default: false
- created_at: '2021-11-16T15:44:40.654Z'
- updated_at: '2021-11-16T15:44:40.654Z'
- token: Z6b6RuRfJ5bx4zT8FVBbQuNy
+ created_at: '2021-11-17T08:59:43.351Z'
+ updated_at: '2021-11-17T08:59:43.351Z'
+ token: 8mdvEux7iJtNG3z63jcT3tpW
variant_included: false
relationships:
wished_items:
@@ -15590,9 +15510,9 @@ paths:
name: Birthday
is_private: true
is_default: false
- created_at: '2021-11-16T15:44:40.657Z'
- updated_at: '2021-11-16T15:44:40.657Z'
- token: e6CagVmuP26fLJcHYEetZ6JF
+ created_at: '2021-11-17T08:59:43.353Z'
+ updated_at: '2021-11-17T08:59:43.353Z'
+ token: a5CX4Y1jmvReQGJ9gGcWdAfJ
variant_included: false
relationships:
wished_items:
@@ -15654,9 +15574,9 @@ paths:
name: Wishlist_26
is_private: true
is_default: false
- created_at: '2021-11-16T15:44:41.257Z'
- updated_at: '2021-11-16T15:44:41.257Z'
- token: hpE3rJbjDbMTYbZzQd8VURgf
+ created_at: '2021-11-17T08:59:44.120Z'
+ updated_at: '2021-11-17T08:59:44.120Z'
+ token: CBSXp32STTNyMygLKnkYmXrx
variant_included: false
relationships:
wished_items:
@@ -15720,9 +15640,9 @@ paths:
name: My Wishlist
is_private: true
is_default: false
- created_at: '2021-11-16T15:44:41.325Z'
- updated_at: '2021-11-16T15:44:41.325Z'
- token: G1hy66WsxjLEtiHcLAFfXygA
+ created_at: '2021-11-17T08:59:44.203Z'
+ updated_at: '2021-11-17T08:59:44.203Z'
+ token: 4vxEJgPt4MhLsX8knVhpmnMe
variant_included: false
relationships:
wished_items:
@@ -15785,9 +15705,9 @@ paths:
name: My Super Wishlist
is_private: true
is_default: false
- created_at: '2021-11-16T15:44:41.445Z'
- updated_at: '2021-11-16T15:44:41.457Z'
- token: NVi2YDigxPpTzecpcqqQxy1Y
+ created_at: '2021-11-17T08:59:44.334Z'
+ updated_at: '2021-11-17T08:59:44.348Z'
+ token: cn6hsHijV8TKDRjd9U2pmxoR
variant_included: false
relationships:
wished_items:
@@ -15911,28 +15831,29 @@ paths:
Example:
value:
data:
- - id: '113'
+ - id: '96'
type: zone
attributes:
- name: Id asperiores perferendis ab ullam rem voluptas.
- description: Facilis placeat inventore accusantium velit.
+ name: Ratione veritatis expedita saepe ipsum eos.
+ description: Vero doloremque expedita ducimus reiciendis.
default_tax: false
zone_members_count: 0
- created_at: '2021-11-16T15:44:41.728Z'
- updated_at: '2021-11-16T15:44:41.728Z'
+ created_at: '2021-11-17T08:59:44.642Z'
+ updated_at: '2021-11-17T08:59:44.642Z'
kind: state
relationships:
zone_members:
data: []
- - id: '114'
+ - id: '97'
type: zone
attributes:
- name: Est eum tenetur et reiciendis architecto repudiandae.
- description: Aliquid reprehenderit alias ipsa optio aliquam.
+ name: Nihil consectetur aspernatur dicta cumque cum.
+ description: Excepturi commodi laudantium perferendis aliquam
+ consequuntur.
default_tax: false
zone_members_count: 0
- created_at: '2021-11-16T15:44:41.730Z'
- updated_at: '2021-11-16T15:44:41.730Z'
+ created_at: '2021-11-17T08:59:44.644Z'
+ updated_at: '2021-11-17T08:59:44.644Z'
kind: state
relationships:
zone_members:
@@ -15984,16 +15905,16 @@ paths:
Example:
value:
data:
- id: '117'
+ id: '100'
type: zone
attributes:
- name: Error eos fugit exercitationem voluptas blanditiis voluptates.
- description: Veritatis impedit odit tempora odio dolorum magni
- praesentium molestias.
+ name: Dicta tempore tempora tenetur sed.
+ description: Debitis quos totam eaque est aut impedit quaerat
+ exercitationem.
default_tax: false
zone_members_count: 0
- created_at: '2021-11-16T15:44:41.833Z'
- updated_at: '2021-11-16T15:44:41.833Z'
+ created_at: '2021-11-17T08:59:44.744Z'
+ updated_at: '2021-11-17T08:59:44.744Z'
kind: state
relationships:
zone_members:
@@ -16049,15 +15970,16 @@ paths:
Example:
value:
data:
- id: '118'
+ id: '101'
type: zone
attributes:
- name: Facilis sapiente aliquam repellat atque fugit quasi.
- description: Magni sunt accusamus assumenda laudantium.
+ name: Consectetur magnam maiores blanditiis ea.
+ description: Earum harum explicabo adipisci cupiditate eum
+ hic commodi ipsum.
default_tax: false
zone_members_count: 0
- created_at: '2021-11-16T15:44:41.899Z'
- updated_at: '2021-11-16T15:44:41.899Z'
+ created_at: '2021-11-17T08:59:44.813Z'
+ updated_at: '2021-11-17T08:59:44.813Z'
kind: state
relationships:
zone_members:
@@ -16114,15 +16036,15 @@ paths:
Example:
value:
data:
- id: '120'
+ id: '103'
type: zone
attributes:
name: EU
description: The zone containing all EU countries
default_tax: false
zone_members_count: 0
- created_at: '2021-11-16T15:44:42.014Z'
- updated_at: '2021-11-16T15:44:42.024Z'
+ created_at: '2021-11-17T08:59:44.932Z'
+ updated_at: '2021-11-17T08:59:44.942Z'
kind: state
relationships:
zone_members:
@@ -16234,6 +16156,7 @@ tags:
- name: Shipments
- name: Shipping Categories
- name: Shipping Methods
+- name: Stock Locations
- name: Store Credit Categories
- name: Store Credit Types
- name: Store Credits
@@ -18132,7 +18055,7 @@ components:
completed_at:
type: string
format: date_time
- example: 2021-11-16 15:43:34 UTC
+ example: 2021-11-17 08:58:25 UTC
bill_address_id:
type: string
example: '1'
@@ -18200,7 +18123,7 @@ components:
approved_at:
type: string
format: date_time
- example: 2021-11-16 15:43:34 UTC
+ example: 2021-11-17 08:58:25 UTC
confirmation_delivered:
type: boolean
example: true
@@ -18271,7 +18194,7 @@ components:
completed_at:
type: string
format: date_time
- example: 2021-11-16 15:43:34 UTC
+ example: 2021-11-17 08:58:25 UTC
bill_address_id:
type: string
example: '1'
@@ -18339,7 +18262,7 @@ components:
approved_at:
type: string
format: date_time
- example: 2021-11-16 15:43:34 UTC
+ example: 2021-11-17 08:58:25 UTC
confirmation_delivered:
type: boolean
example: true
@@ -19078,77 +19001,6 @@ components:
required:
- zone
x-internal: true
- create_shipment_params:
- type: object
- properties:
- shipment:
- type: object
- required:
- - stock_location_id
- - order_id
- - variant_id
- properties:
- stock_location_id:
- type: string
- example: '101'
- order_id:
- type: string
- example: '101'
- variant_id:
- type: string
- example: '101'
- quantity:
- type: integer
- example: 2
- required:
- - shipping_category
- x-internal: true
- update_shipment_params:
- type: object
- properties:
- shipment:
- type: object
- properties:
- tracking:
- type: string
- example: MY-TRACKING-REF-12324
- required:
- - shipping_category
- x-internal: true
- add_item_shipment_params:
- type: object
- properties:
- shipment:
- type: object
- required:
- - variant_id
- properties:
- variant_id:
- type: string
- example: '101'
- quantity:
- type: integer
- example: 2
- required:
- - shipping_category
- x-internal: true
- remove_item_shipment_params:
- type: object
- properties:
- shipment:
- type: object
- required:
- - variant_id
- properties:
- variant_id:
- type: string
- example: '101'
- quantity:
- type: integer
- example: 2
- required:
- - shipping_category
- x-internal: true
create_shipping_category_params:
type: object
properties:
@@ -19283,6 +19135,102 @@ components:
required:
- type
x-internal: true
+ create_stock_location_params:
+ type: object
+ properties:
+ stock_location:
+ type: object
+ required:
+ - name
+ properties:
+ name:
+ type: string
+ example: Warehouse 3
+ default:
+ type: boolean
+ address1:
+ type: string
+ example: South St. 8
+ address2:
+ type: string
+ example: South St. 109
+ country_id:
+ type: string
+ example: '2'
+ state_id:
+ type: string
+ example: '4'
+ city:
+ type: string
+ example: Los Angeles
+ state_name:
+ type: string
+ example: California
+ zipcode:
+ type: string
+ example: '90005'
+ phone:
+ type: string
+ example: '23333456'
+ active:
+ type: boolean
+ backorderable_default:
+ type: boolean
+ propagate_all_variants:
+ type: boolean
+ admin_name:
+ type: string
+ required:
+ - stock_location
+ x-internal: true
+ update_stock_location_params:
+ type: object
+ properties:
+ stock_location:
+ type: object
+ required:
+ - name
+ properties:
+ name:
+ type: string
+ example: Warehouse 3
+ default:
+ type: boolean
+ address1:
+ type: string
+ example: South St. 8
+ address2:
+ type: string
+ example: South St. 109
+ country_id:
+ type: string
+ example: '2'
+ state_id:
+ type: string
+ example: '4'
+ city:
+ type: string
+ example: Los Angeles
+ state_name:
+ type: string
+ example: California
+ zipcode:
+ type: string
+ example: '90005'
+ phone:
+ type: string
+ example: '23333456'
+ active:
+ type: boolean
+ backorderable_default:
+ type: boolean
+ propagate_all_variants:
+ type: boolean
+ admin_name:
+ type: string
+ required:
+ - stock_location
+ x-internal: true
create_store_credit_category_params:
type: object
properties:
diff --git a/api/spec/integration/api/v2/platform/stock_locations_spec.rb b/api/spec/integration/api/v2/platform/stock_locations_spec.rb
new file mode 100644
index 0000000000..332862082f
--- /dev/null
+++ b/api/spec/integration/api/v2/platform/stock_locations_spec.rb
@@ -0,0 +1,32 @@
+require 'swagger_helper'
+
+describe 'Stock Locations API', swagger: true do
+ include_context 'Platform API v2'
+
+ resource_name = 'Stock Location'
+ options = {
+ include_example: 'country',
+ filter_examples: []
+ }
+
+ let(:id) { create(:stock_location).id }
+ let(:records_list) { create_list(:stock_location, 2) }
+ let(:valid_create_param_value) { build(:stock_location).attributes }
+ let(:valid_update_param_value) do
+ {
+ name: 'Warehouse 3',
+ default: true,
+ address1: 'South Street 8/2',
+ city: 'Los Angeles',
+ zipcode: '11223',
+ active: true
+ }
+ end
+ let(:invalid_param_value) do
+ {
+ name: ''
+ }
+ end
+
+ include_examples 'CRUD examples', resource_name, options
+end
diff --git a/api/spec/swagger_helper.rb b/api/spec/swagger_helper.rb
index e1ed219b88..c553a22e02 100644
--- a/api/spec/swagger_helper.rb
+++ b/api/spec/swagger_helper.rb
@@ -64,6 +64,7 @@ RSpec.configure do |config|
{ name: 'Shipments' },
{ name: 'Shipping Categories' },
{ name: 'Shipping Methods' },
+ { name: 'Stock Locations' },
{ name: 'Store Credit Categories' },
{ name: 'Store Credit Types' },
{ name: 'Store Credits' },
@@ -1660,6 +1661,62 @@ RSpec.configure do |config|
'x-internal': true
},
+ # Stock Location
+ create_stock_location_params: {
+ type: :object,
+ properties: {
+ stock_location: {
+ type: :object,
+ required: %w[name],
+ properties: {
+ name: { type: :string, example: 'Warehouse 3' },
+ default: { type: :boolean },
+ address1: { type: :string, example: 'South St. 8' },
+ address2: { type: :string, example: 'South St. 109' },
+ country_id: { type: :string, example: '2' },
+ state_id: { type: :string, example: '4' },
+ city: { type: :string, example: 'Los Angeles' },
+ state_name: { type: :string, example: 'California' },
+ zipcode: { type: :string, example: '90005' },
+ phone: { type: :string, example: '23333456' },
+ active: { type: :boolean },
+ backorderable_default: { type: :boolean },
+ propagate_all_variants: { type: :boolean },
+ admin_name: { type: :string },
+ }
+ }
+ },
+ required: %w[stock_location],
+ 'x-internal': true
+ },
+ update_stock_location_params: {
+ type: :object,
+ properties: {
+ stock_location: {
+ type: :object,
+ required: %w[name],
+ properties: {
+ name: { type: :string, example: 'Warehouse 3' },
+ default: { type: :boolean },
+ address1: { type: :string, example: 'South St. 8' },
+ address2: { type: :string, example: 'South St. 109' },
+ country_id: { type: :string, example: '2' },
+ state_id: { type: :string, example: '4' },
+ city: { type: :string, example: 'Los Angeles' },
+ state_name: { type: :string, example: 'California' },
+ zipcode: { type: :string, example: '90005' },
+ phone: { type: :string, example: '23333456' },
+ active: { type: :boolean },
+ backorderable_default: { type: :boolean },
+ propagate_all_variants: { type: :boolean },
+ admin_name: { type: :string },
+ }
+ }
+ },
+ required: %w[stock_location],
+ 'x-internal': true
+ },
+
# Store Credit Category
create_store_credit_category_params: {
type: :object,