docs/api-reference/platform.yaml

   1 ---
   2 openapi: 3.0.3
   3 info:
   4   title: Platform API
   5   contact:
   6     name: Vendo Connect Inc.
   7     url: https://getvendo.com
   8     email: sales@getvendo.com
   9   description: Spree Platform API
  10   version: v2
  11 paths:
  12   "/api/v2/platform/addresses":
  13     get:
  14       summary: Return a list of Addresses
  15       tags:
  16       - Addresses
  17       security:
  18       - bearer_auth: []
  19       description: Returns a list of Addresses
  20       operationId: addresses-list
  21       parameters:
  22       - name: page
  23         in: query
  24         example: 1
  25         schema:
  26           type: integer
  27       - name: per_page
  28         in: query
  29         example: 50
  30         schema:
  31           type: integer
  32       - name: include
  33         in: query
  34         description: 'Select which associated resources you would like to fetch, see:
  35           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
  36         example: user,country,state
  37         schema:
  38           type: string
  39       - name: filter[user_id_eq]
  40         in: query
  41         description: ''
  42         example: '1'
  43         schema:
  44           type: string
  45       - name: filter[firstname_cont]
  46         in: query
  47         description: ''
  48         example: John
  49         schema:
  50           type: string
  51       responses:
  52         '200':
  53           description: Records returned
  54           content:
  55             application/vnd.api+json:
  56               examples:
  57                 Example:
  58                   value:
  59                     data:
  60                     - id: '1'
  61                       type: address
  62                       attributes:
  63                         firstname: John
  64                         lastname: Doe
  65                         address1: 1 Lovely Street
  66                         address2: Northwest
  67                         city: Herndon
  68                         zipcode: '35005'
  69                         phone: 555-555-0199
  70                         state_name:
  71                         alternative_phone: 555-555-0199
  72                         company: Company
  73                         created_at: '2022-11-08T19:33:50.821Z'
  74                         updated_at: '2022-11-08T19:33:50.821Z'
  75                         deleted_at:
  76                         label:
  77                         public_metadata: {}
  78                         private_metadata: {}
  79                       relationships:
  80                         country:
  81                           data:
  82                             id: '1'
  83                             type: country
  84                         state:
  85                           data:
  86                             id: '1'
  87                             type: state
  88                         user:
  89                           data:
  90                     - id: '2'
  91                       type: address
  92                       attributes:
  93                         firstname: John
  94                         lastname: Doe
  95                         address1: 2 Lovely Street
  96                         address2: Northwest
  97                         city: Herndon
  98                         zipcode: '35005'
  99                         phone: 555-555-0199
 100                         state_name:
 101                         alternative_phone: 555-555-0199
 102                         company: Company
 103                         created_at: '2022-11-08T19:33:50.825Z'
 104                         updated_at: '2022-11-08T19:33:50.825Z'
 105                         deleted_at:
 106                         label:
 107                         public_metadata: {}
 108                         private_metadata: {}
 109                       relationships:
 110                         country:
 111                           data:
 112                             id: '1'
 113                             type: country
 114                         state:
 115                           data:
 116                             id: '2'
 117                             type: state
 118                         user:
 119                           data:
 120                     meta:
 121                       count: 2
 122                       total_count: 2
 123                       total_pages: 1
 124                     links:
 125                       self: http://www.example.com/api/v2/platform/addresses?page=1&per_page=&include=&filter[user_id_eq]=&filter[firstname_cont]=
 126                       next: http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
 127                       prev: http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
 128                       last: http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
 129                       first: http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
 130               schema:
 131                 "$ref": "#/components/schemas/resources_list"
 132         '401':
 133           description: Authentication Failed
 134           content:
 135             application/vnd.api+json:
 136               examples:
 137                 Example:
 138                   value:
 139                     error: The access token is invalid
 140               schema:
 141                 "$ref": "#/components/schemas/error"
 142     post:
 143       summary: Create an Address
 144       tags:
 145       - Addresses
 146       security:
 147       - bearer_auth: []
 148       description: Creates an Address
 149       operationId: create-address
 150       parameters:
 151       - name: include
 152         in: query
 153         description: 'Select which associated resources you would like to fetch, see:
 154           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
 155         example: user,country,state
 156         schema:
 157           type: string
 158       responses:
 159         '201':
 160           description: Record created
 161           content:
 162             application/vnd.api+json:
 163               examples:
 164                 Example:
 165                   value:
 166                     data:
 167                       id: '5'
 168                       type: address
 169                       attributes:
 170                         firstname: John
 171                         lastname: Doe
 172                         address1: 5 Lovely Street
 173                         address2: Northwest
 174                         city: Herndon
 175                         zipcode: '35005'
 176                         phone: 555-555-0199
 177                         state_name:
 178                         alternative_phone: 555-555-0199
 179                         company: Company
 180                         created_at: '2022-11-08T19:33:51.471Z'
 181                         updated_at: '2022-11-08T19:33:51.471Z'
 182                         deleted_at:
 183                         label:
 184                         public_metadata: {}
 185                         private_metadata: {}
 186                       relationships:
 187                         country:
 188                           data:
 189                             id: '4'
 190                             type: country
 191                         state:
 192                           data:
 193                             id: '5'
 194                             type: state
 195                         user:
 196                           data:
 197                             id: '1'
 198                             type: user
 199               schema:
 200                 "$ref": "#/components/schemas/resource"
 201         '422':
 202           description: Invalid request
 203           content:
 204             application/vnd.api+json:
 205               examples:
 206                 Example:
 207                   value:
 208                     error: First Name can't be blank, Last Name can't be blank, Address
 209                       can't be blank, City can't be blank, Country can't be blank,
 210                       Zip Code can't be blank, and Phone can't be blank
 211                     errors:
 212                       firstname:
 213                       - can't be blank
 214                       lastname:
 215                       - can't be blank
 216                       address1:
 217                       - can't be blank
 218                       city:
 219                       - can't be blank
 220                       country:
 221                       - can't be blank
 222                       zipcode:
 223                       - can't be blank
 224                       phone:
 225                       - can't be blank
 226               schema:
 227                 "$ref": "#/components/schemas/validation_errors"
 228       requestBody:
 229         content:
 230           application/json:
 231             schema:
 232               "$ref": "#/components/schemas/create_address_params"
 233   "/api/v2/platform/addresses/{id}":
 234     get:
 235       summary: Return an Address
 236       tags:
 237       - Addresses
 238       security:
 239       - bearer_auth: []
 240       description: Returns an Address
 241       operationId: show-address
 242       parameters:
 243       - name: id
 244         in: path
 245         required: true
 246         schema:
 247           type: string
 248       - name: include
 249         in: query
 250         description: 'Select which associated resources you would like to fetch, see:
 251           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
 252         example: user,country,state
 253         schema:
 254           type: string
 255       responses:
 256         '200':
 257           description: Record found
 258           content:
 259             application/vnd.api+json:
 260               examples:
 261                 Example:
 262                   value:
 263                     data:
 264                       id: '6'
 265                       type: address
 266                       attributes:
 267                         firstname: John
 268                         lastname: Doe
 269                         address1: 6 Lovely Street
 270                         address2: Northwest
 271                         city: Herndon
 272                         zipcode: '35005'
 273                         phone: 555-555-0199
 274                         state_name:
 275                         alternative_phone: 555-555-0199
 276                         company: Company
 277                         created_at: '2022-11-08T19:33:51.740Z'
 278                         updated_at: '2022-11-08T19:33:51.740Z'
 279                         deleted_at:
 280                         label:
 281                         public_metadata: {}
 282                         private_metadata: {}
 283                       relationships:
 284                         country:
 285                           data:
 286                             id: '6'
 287                             type: country
 288                         state:
 289                           data:
 290                             id: '6'
 291                             type: state
 292                         user:
 293                           data:
 294               schema:
 295                 "$ref": "#/components/schemas/resource"
 296         '404':
 297           description: Record not found
 298           content:
 299             application/vnd.api+json:
 300               examples:
 301                 Example:
 302                   value:
 303                     error: The resource you were looking for could not be found.
 304               schema:
 305                 "$ref": "#/components/schemas/error"
 306         '401':
 307           description: Authentication Failed
 308           content:
 309             application/vnd.api+json:
 310               examples:
 311                 Example:
 312                   value:
 313                     error: The access token is invalid
 314               schema:
 315                 "$ref": "#/components/schemas/error"
 316     patch:
 317       summary: Update an Address
 318       tags:
 319       - Addresses
 320       security:
 321       - bearer_auth: []
 322       description: Updates an Address
 323       operationId: update-address
 324       parameters:
 325       - name: id
 326         in: path
 327         required: true
 328         schema:
 329           type: string
 330       - name: include
 331         in: query
 332         description: 'Select which associated resources you would like to fetch, see:
 333           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
 334         example: user,country,state
 335         schema:
 336           type: string
 337       responses:
 338         '200':
 339           description: Record updated
 340           content:
 341             application/vnd.api+json:
 342               examples:
 343                 Example:
 344                   value:
 345                     data:
 346                       id: '8'
 347                       type: address
 348                       attributes:
 349                         firstname: Jack
 350                         lastname: Doe
 351                         address1: 8 Lovely Street
 352                         address2: Northwest
 353                         city: Herndon
 354                         zipcode: '35005'
 355                         phone: 555-555-0199
 356                         state_name:
 357                         alternative_phone: 555-555-0199
 358                         company: Company
 359                         created_at: '2022-11-08T19:33:52.269Z'
 360                         updated_at: '2022-11-08T19:33:52.501Z'
 361                         deleted_at:
 362                         label:
 363                         public_metadata: {}
 364                         private_metadata: {}
 365                       relationships:
 366                         country:
 367                           data:
 368                             id: '9'
 369                             type: country
 370                         state:
 371                           data:
 372                             id: '8'
 373                             type: state
 374                         user:
 375                           data:
 376               schema:
 377                 "$ref": "#/components/schemas/resource"
 378         '422':
 379           description: Invalid request
 380           content:
 381             application/vnd.api+json:
 382               examples:
 383                 Example:
 384                   value:
 385                     error: First Name can't be blank and Last Name can't be blank
 386                     errors:
 387                       firstname:
 388                       - can't be blank
 389                       lastname:
 390                       - can't be blank
 391               schema:
 392                 "$ref": "#/components/schemas/validation_errors"
 393         '404':
 394           description: Record not found
 395           content:
 396             application/vnd.api+json:
 397               examples:
 398                 Example:
 399                   value:
 400                     error: The resource you were looking for could not be found.
 401               schema:
 402                 "$ref": "#/components/schemas/error"
 403         '401':
 404           description: Authentication Failed
 405           content:
 406             application/vnd.api+json:
 407               examples:
 408                 Example:
 409                   value:
 410                     error: The access token is invalid
 411               schema:
 412                 "$ref": "#/components/schemas/error"
 413       requestBody:
 414         content:
 415           application/json:
 416             schema:
 417               "$ref": "#/components/schemas/update_address_params"
 418     delete:
 419       summary: Delete an Address
 420       tags:
 421       - Addresses
 422       security:
 423       - bearer_auth: []
 424       description: Deletes an Address
 425       operationId: delete-address
 426       parameters:
 427       - name: id
 428         in: path
 429         required: true
 430         schema:
 431           type: string
 432       responses:
 433         '204':
 434           description: Record deleted
 435         '404':
 436           description: Record not found
 437           content:
 438             application/vnd.api+json:
 439               examples:
 440                 Example:
 441                   value:
 442                     error: The resource you were looking for could not be found.
 443               schema:
 444                 "$ref": "#/components/schemas/error"
 445         '401':
 446           description: Authentication Failed
 447           content:
 448             application/vnd.api+json:
 449               examples:
 450                 Example:
 451                   value:
 452                     error: The access token is invalid
 453               schema:
 454                 "$ref": "#/components/schemas/error"
 455   "/api/v2/platform/adjustments":
 456     get:
 457       summary: Return a list of Adjustments
 458       tags:
 459       - Adjustments
 460       security:
 461       - bearer_auth: []
 462       description: Returns a list of Adjustments
 463       operationId: adjustments-list
 464       parameters:
 465       - name: page
 466         in: query
 467         example: 1
 468         schema:
 469           type: integer
 470       - name: per_page
 471         in: query
 472         example: 50
 473         schema:
 474           type: integer
 475       - name: include
 476         in: query
 477         description: 'Select which associated resources you would like to fetch, see:
 478           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
 479         example: order,adjustable
 480         schema:
 481           type: string
 482       - name: filter[order_id]
 483         in: query
 484         description: ''
 485         example: '1234'
 486         schema:
 487           type: string
 488       responses:
 489         '200':
 490           description: Records returned
 491           content:
 492             application/vnd.api+json:
 493               examples:
 494                 Example:
 495                   value:
 496                     data:
 497                     - id: '1'
 498                       type: adjustment
 499                       attributes:
 500                         source_type: Spree::TaxRate
 501                         adjustable_type: Spree::Order
 502                         amount: '100.0'
 503                         label: Shipping
 504                         mandatory:
 505                         eligible: true
 506                         created_at: '2022-11-08T19:33:53.732Z'
 507                         updated_at: '2022-11-08T19:33:53.732Z'
 508                         state: open
 509                         included: false
 510                         display_amount: "$100.00"
 511                       relationships:
 512                         order:
 513                           data:
 514                             id: '1'
 515                             type: order
 516                         adjustable:
 517                           data:
 518                             id: '2'
 519                             type: order
 520                         source:
 521                           data:
 522                             id: '1'
 523                             type: tax_rate
 524                     - id: '2'
 525                       type: adjustment
 526                       attributes:
 527                         source_type: Spree::TaxRate
 528                         adjustable_type: Spree::Order
 529                         amount: '100.0'
 530                         label: Shipping
 531                         mandatory:
 532                         eligible: true
 533                         created_at: '2022-11-08T19:33:53.754Z'
 534                         updated_at: '2022-11-08T19:33:53.754Z'
 535                         state: open
 536                         included: false
 537                         display_amount: "$100.00"
 538                       relationships:
 539                         order:
 540                           data:
 541                             id: '1'
 542                             type: order
 543                         adjustable:
 544                           data:
 545                             id: '3'
 546                             type: order
 547                         source:
 548                           data:
 549                             id: '2'
 550                             type: tax_rate
 551                     meta:
 552                       count: 2
 553                       total_count: 2
 554                       total_pages: 1
 555                     links:
 556                       self: http://www.example.com/api/v2/platform/adjustments?page=1&per_page=&include=&filter[order_id]=
 557                       next: http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=
 558                       prev: http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=
 559                       last: http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=
 560                       first: http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=
 561               schema:
 562                 "$ref": "#/components/schemas/resources_list"
 563         '401':
 564           description: Authentication Failed
 565           content:
 566             application/vnd.api+json:
 567               examples:
 568                 Example:
 569                   value:
 570                     error: The access token is invalid
 571               schema:
 572                 "$ref": "#/components/schemas/error"
 573     post:
 574       summary: Create an Adjustment
 575       tags:
 576       - Adjustments
 577       security:
 578       - bearer_auth: []
 579       description: Creates an Adjustment
 580       operationId: create-adjustment
 581       parameters:
 582       - name: include
 583         in: query
 584         description: 'Select which associated resources you would like to fetch, see:
 585           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
 586         example: order,adjustable
 587         schema:
 588           type: string
 589       responses:
 590         '201':
 591           description: Record created
 592           content:
 593             application/vnd.api+json:
 594               examples:
 595                 Example:
 596                   value:
 597                     data:
 598                       id: '5'
 599                       type: adjustment
 600                       attributes:
 601                         source_type: Spree::TaxRate
 602                         adjustable_type: Spree::LineItem
 603                         amount: '100.0'
 604                         label: Shipping
 605                         mandatory:
 606                         eligible: true
 607                         created_at: '2022-11-08T19:33:54.527Z'
 608                         updated_at: '2022-11-08T19:33:54.527Z'
 609                         state: open
 610                         included: false
 611                         display_amount: "$100.00"
 612                       relationships:
 613                         order:
 614                           data:
 615                             id: '7'
 616                             type: order
 617                         adjustable:
 618                           data:
 619                             id: '1'
 620                             type: line_item
 621                         source:
 622                           data:
 623               schema:
 624                 "$ref": "#/components/schemas/resource"
 625         '422':
 626           description: Invalid request
 627           content:
 628             application/vnd.api+json:
 629               examples:
 630                 Example:
 631                   value:
 632                     error: Adjustable can't be blank, Order can't be blank, Label
 633                       can't be blank, and Amount is not a number
 634                     errors:
 635                       adjustable:
 636                       - can't be blank
 637                       order:
 638                       - can't be blank
 639                       label:
 640                       - can't be blank
 641                       amount:
 642                       - is not a number
 643               schema:
 644                 "$ref": "#/components/schemas/validation_errors"
 645       requestBody:
 646         content:
 647           application/json:
 648             schema:
 649               "$ref": "#/components/schemas/create_adjustment_params"
 650   "/api/v2/platform/adjustments/{id}":
 651     get:
 652       summary: Return an Adjustment
 653       tags:
 654       - Adjustments
 655       security:
 656       - bearer_auth: []
 657       description: Returns an Adjustment
 658       operationId: show-adjustment
 659       parameters:
 660       - name: id
 661         in: path
 662         required: true
 663         schema:
 664           type: string
 665       - name: include
 666         in: query
 667         description: 'Select which associated resources you would like to fetch, see:
 668           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
 669         example: order,adjustable
 670         schema:
 671           type: string
 672       responses:
 673         '200':
 674           description: Record found
 675           content:
 676             application/vnd.api+json:
 677               examples:
 678                 Example:
 679                   value:
 680                     data:
 681                       id: '6'
 682                       type: adjustment
 683                       attributes:
 684                         source_type: Spree::TaxRate
 685                         adjustable_type: Spree::LineItem
 686                         amount: '1.0'
 687                         label: Shipping
 688                         mandatory:
 689                         eligible: true
 690                         created_at: '2022-11-08T19:33:54.871Z'
 691                         updated_at: '2022-11-08T19:33:54.875Z'
 692                         state: open
 693                         included: false
 694                         display_amount: "$1.00"
 695                       relationships:
 696                         order:
 697                           data:
 698                             id: '8'
 699                             type: order
 700                         adjustable:
 701                           data:
 702                             id: '2'
 703                             type: line_item
 704                         source:
 705                           data:
 706                             id: '5'
 707                             type: tax_rate
 708               schema:
 709                 "$ref": "#/components/schemas/resource"
 710         '404':
 711           description: Record not found
 712           content:
 713             application/vnd.api+json:
 714               examples:
 715                 Example:
 716                   value:
 717                     error: The resource you were looking for could not be found.
 718               schema:
 719                 "$ref": "#/components/schemas/error"
 720         '401':
 721           description: Authentication Failed
 722           content:
 723             application/vnd.api+json:
 724               examples:
 725                 Example:
 726                   value:
 727                     error: The access token is invalid
 728               schema:
 729                 "$ref": "#/components/schemas/error"
 730     patch:
 731       summary: Update an Adjustment
 732       tags:
 733       - Adjustments
 734       security:
 735       - bearer_auth: []
 736       description: Updates an Adjustment
 737       operationId: update-adjustment
 738       parameters:
 739       - name: id
 740         in: path
 741         required: true
 742         schema:
 743           type: string
 744       - name: include
 745         in: query
 746         description: 'Select which associated resources you would like to fetch, see:
 747           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
 748         example: order,adjustable
 749         schema:
 750           type: string
 751       responses:
 752         '200':
 753           description: Record updated
 754           content:
 755             application/vnd.api+json:
 756               examples:
 757                 Example:
 758                   value:
 759                     data:
 760                       id: '8'
 761                       type: adjustment
 762                       attributes:
 763                         source_type: Spree::TaxRate
 764                         adjustable_type: Spree::LineItem
 765                         amount: '15.0'
 766                         label: New label
 767                         mandatory:
 768                         eligible: true
 769                         created_at: '2022-11-08T19:33:55.540Z'
 770                         updated_at: '2022-11-08T19:33:55.775Z'
 771                         state: open
 772                         included: false
 773                         display_amount: "$15.00"
 774                       relationships:
 775                         order:
 776                           data:
 777                             id: '10'
 778                             type: order
 779                         adjustable:
 780                           data:
 781                             id: '4'
 782                             type: line_item
 783                         source:
 784                           data:
 785                             id: '7'
 786                             type: tax_rate
 787               schema:
 788                 "$ref": "#/components/schemas/resource"
 789         '422':
 790           description: Invalid request
 791           content:
 792             application/vnd.api+json:
 793               examples:
 794                 Example:
 795                   value:
 796                     error: Label can't be blank
 797                     errors:
 798                       label:
 799                       - can't be blank
 800               schema:
 801                 "$ref": "#/components/schemas/validation_errors"
 802         '404':
 803           description: Record not found
 804           content:
 805             application/vnd.api+json:
 806               examples:
 807                 Example:
 808                   value:
 809                     error: The resource you were looking for could not be found.
 810               schema:
 811                 "$ref": "#/components/schemas/error"
 812         '401':
 813           description: Authentication Failed
 814           content:
 815             application/vnd.api+json:
 816               examples:
 817                 Example:
 818                   value:
 819                     error: The access token is invalid
 820               schema:
 821                 "$ref": "#/components/schemas/error"
 822       requestBody:
 823         content:
 824           application/json:
 825             schema:
 826               "$ref": "#/components/schemas/update_adjustment_params"
 827     delete:
 828       summary: Delete an Adjustment
 829       tags:
 830       - Adjustments
 831       security:
 832       - bearer_auth: []
 833       description: Deletes an Adjustment
 834       operationId: delete-adjustment
 835       parameters:
 836       - name: id
 837         in: path
 838         required: true
 839         schema:
 840           type: string
 841       responses:
 842         '204':
 843           description: Record deleted
 844         '404':
 845           description: Record not found
 846           content:
 847             application/vnd.api+json:
 848               examples:
 849                 Example:
 850                   value:
 851                     error: The resource you were looking for could not be found.
 852               schema:
 853                 "$ref": "#/components/schemas/error"
 854         '401':
 855           description: Authentication Failed
 856           content:
 857             application/vnd.api+json:
 858               examples:
 859                 Example:
 860                   value:
 861                     error: The access token is invalid
 862               schema:
 863                 "$ref": "#/components/schemas/error"
 864   "/api/v2/platform/classifications":
 865     get:
 866       summary: Return a list of Classifications
 867       tags:
 868       - Classifications
 869       security:
 870       - bearer_auth: []
 871       description: Returns a list of Classifications
 872       operationId: classifications-list
 873       parameters:
 874       - name: page
 875         in: query
 876         example: 1
 877         schema:
 878           type: integer
 879       - name: per_page
 880         in: query
 881         example: 50
 882         schema:
 883           type: integer
 884       - name: include
 885         in: query
 886         description: 'Select which associated resources you would like to fetch, see:
 887           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
 888         example: product,taxon
 889         schema:
 890           type: string
 891       - name: filter[taxon_id_eq]
 892         in: query
 893         description: ''
 894         example: '1'
 895         schema:
 896           type: string
 897       responses:
 898         '200':
 899           description: Records returned
 900           content:
 901             application/vnd.api+json:
 902               examples:
 903                 Example:
 904                   value:
 905                     data:
 906                     - id: '1'
 907                       type: classification
 908                       attributes:
 909                         position: 1
 910                         created_at: '2022-11-08T19:33:57.238Z'
 911                         updated_at: '2022-11-08T19:33:57.238Z'
 912                       relationships:
 913                         product:
 914                           data:
 915                             id: '9'
 916                             type: product
 917                         taxon:
 918                           data:
 919                             id: '2'
 920                             type: taxon
 921                     - id: '2'
 922                       type: classification
 923                       attributes:
 924                         position: 1
 925                         created_at: '2022-11-08T19:33:57.322Z'
 926                         updated_at: '2022-11-08T19:33:57.322Z'
 927                       relationships:
 928                         product:
 929                           data:
 930                             id: '10'
 931                             type: product
 932                         taxon:
 933                           data:
 934                             id: '4'
 935                             type: taxon
 936                     meta:
 937                       count: 2
 938                       total_count: 2
 939                       total_pages: 1
 940                     links:
 941                       self: http://www.example.com/api/v2/platform/classifications?page=1&per_page=&include=&filter[taxon_id_eq]=
 942                       next: http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=
 943                       prev: http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=
 944                       last: http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=
 945                       first: http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=
 946               schema:
 947                 "$ref": "#/components/schemas/resources_list"
 948         '401':
 949           description: Authentication Failed
 950           content:
 951             application/vnd.api+json:
 952               examples:
 953                 Example:
 954                   value:
 955                     error: The access token is invalid
 956               schema:
 957                 "$ref": "#/components/schemas/error"
 958     post:
 959       summary: Create a Classification
 960       tags:
 961       - Classifications
 962       security:
 963       - bearer_auth: []
 964       description: Creates a Classification
 965       operationId: create-classification
 966       parameters:
 967       - name: include
 968         in: query
 969         description: 'Select which associated resources you would like to fetch, see:
 970           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
 971         example: product,taxon
 972         schema:
 973           type: string
 974       responses:
 975         '201':
 976           description: Record created
 977           content:
 978             application/vnd.api+json:
 979               examples:
 980                 Example:
 981                   value:
 982                     data:
 983                       id: '5'
 984                       type: classification
 985                       attributes:
 986                         position: 1
 987                         created_at: '2022-11-08T19:33:58.099Z'
 988                         updated_at: '2022-11-08T19:33:58.099Z'
 989                       relationships:
 990                         product:
 991                           data:
 992                             id: '13'
 993                             type: product
 994                         taxon:
 995                           data:
 996                             id: '10'
 997                             type: taxon
 998               schema:
 999                 "$ref": "#/components/schemas/resource"
1000         '422':
1001           description: Invalid request
1002           content:
1003             application/vnd.api+json:
1004               examples:
1005                 Example:
1006                   value:
1007                     error: Taxon can't be blank and Product can't be blank
1008                     errors:
1009                       taxon:
1010                       - can't be blank
1011                       product:
1012                       - can't be blank
1013               schema:
1014                 "$ref": "#/components/schemas/validation_errors"
1015       requestBody:
1016         content:
1017           application/json:
1018             schema:
1019               "$ref": "#/components/schemas/create_classification_params"
1020   "/api/v2/platform/classifications/{id}":
1021     get:
1022       summary: Return a Classification
1023       tags:
1024       - Classifications
1025       security:
1026       - bearer_auth: []
1027       description: Returns a Classification
1028       operationId: show-classification
1029       parameters:
1030       - name: id
1031         in: path
1032         required: true
1033         schema:
1034           type: string
1035       - name: include
1036         in: query
1037         description: 'Select which associated resources you would like to fetch, see:
1038           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1039         example: product,taxon
1040         schema:
1041           type: string
1042       responses:
1043         '200':
1044           description: Record found
1045           content:
1046             application/vnd.api+json:
1047               examples:
1048                 Example:
1049                   value:
1050                     data:
1051                       id: '6'
1052                       type: classification
1053                       attributes:
1054                         position: 1
1055                         created_at: '2022-11-08T19:33:58.452Z'
1056                         updated_at: '2022-11-08T19:33:58.452Z'
1057                       relationships:
1058                         product:
1059                           data:
1060                             id: '14'
1061                             type: product
1062                         taxon:
1063                           data:
1064                             id: '12'
1065                             type: taxon
1066               schema:
1067                 "$ref": "#/components/schemas/resource"
1068         '404':
1069           description: Record not found
1070           content:
1071             application/vnd.api+json:
1072               examples:
1073                 Example:
1074                   value:
1075                     error: The resource you were looking for could not be found.
1076               schema:
1077                 "$ref": "#/components/schemas/error"
1078         '401':
1079           description: Authentication Failed
1080           content:
1081             application/vnd.api+json:
1082               examples:
1083                 Example:
1084                   value:
1085                     error: The access token is invalid
1086               schema:
1087                 "$ref": "#/components/schemas/error"
1088     patch:
1089       summary: Update a Classification
1090       tags:
1091       - Classifications
1092       security:
1093       - bearer_auth: []
1094       description: Updates a Classification
1095       operationId: update-classification
1096       parameters:
1097       - name: id
1098         in: path
1099         required: true
1100         schema:
1101           type: string
1102       - name: include
1103         in: query
1104         description: 'Select which associated resources you would like to fetch, see:
1105           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1106         example: product,taxon
1107         schema:
1108           type: string
1109       responses:
1110         '200':
1111           description: Record updated
1112           content:
1113             application/vnd.api+json:
1114               examples:
1115                 Example:
1116                   value:
1117                     data:
1118                       id: '8'
1119                       type: classification
1120                       attributes:
1121                         position: 1
1122                         created_at: '2022-11-08T19:33:59.135Z'
1123                         updated_at: '2022-11-08T19:33:59.135Z'
1124                       relationships:
1125                         product:
1126                           data:
1127                             id: '16'
1128                             type: product
1129                         taxon:
1130                           data:
1131                             id: '16'
1132                             type: taxon
1133               schema:
1134                 "$ref": "#/components/schemas/resource"
1135         '422':
1136           description: Invalid request
1137           content:
1138             application/vnd.api+json:
1139               examples:
1140                 Example:
1141                   value:
1142                     error: Product can't be blank
1143                     errors:
1144                       product:
1145                       - can't be blank
1146               schema:
1147                 "$ref": "#/components/schemas/validation_errors"
1148         '404':
1149           description: Record not found
1150           content:
1151             application/vnd.api+json:
1152               examples:
1153                 Example:
1154                   value:
1155                     error: The resource you were looking for could not be found.
1156               schema:
1157                 "$ref": "#/components/schemas/error"
1158         '401':
1159           description: Authentication Failed
1160           content:
1161             application/vnd.api+json:
1162               examples:
1163                 Example:
1164                   value:
1165                     error: The access token is invalid
1166               schema:
1167                 "$ref": "#/components/schemas/error"
1168       requestBody:
1169         content:
1170           application/json:
1171             schema:
1172               "$ref": "#/components/schemas/update_classification_params"
1173     delete:
1174       summary: Delete a Classification
1175       tags:
1176       - Classifications
1177       security:
1178       - bearer_auth: []
1179       description: Deletes a Classification
1180       operationId: delete-classification
1181       parameters:
1182       - name: id
1183         in: path
1184         required: true
1185         schema:
1186           type: string
1187       responses:
1188         '204':
1189           description: Record deleted
1190         '404':
1191           description: Record not found
1192           content:
1193             application/vnd.api+json:
1194               examples:
1195                 Example:
1196                   value:
1197                     error: The resource you were looking for could not be found.
1198               schema:
1199                 "$ref": "#/components/schemas/error"
1200         '401':
1201           description: Authentication Failed
1202           content:
1203             application/vnd.api+json:
1204               examples:
1205                 Example:
1206                   value:
1207                     error: The access token is invalid
1208               schema:
1209                 "$ref": "#/components/schemas/error"
1210   "/api/v2/platform/cms_pages":
1211     get:
1212       summary: Return a list of CMS Pages
1213       tags:
1214       - CMS Pages
1215       security:
1216       - bearer_auth: []
1217       description: Returns a list of CMS Pages
1218       operationId: cms-pages-list
1219       parameters:
1220       - name: page
1221         in: query
1222         example: 1
1223         schema:
1224           type: integer
1225       - name: per_page
1226         in: query
1227         example: 50
1228         schema:
1229           type: integer
1230       - name: include
1231         in: query
1232         description: 'Select which associated resources you would like to fetch, see:
1233           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1234         example: cms_sections
1235         schema:
1236           type: string
1237       - name: filter[type_eq]
1238         in: query
1239         description: ''
1240         example: Spree::Cms::Pages::FeaturePage
1241         schema:
1242           type: string
1243       - name: filter[locale_eq]
1244         in: query
1245         description: ''
1246         example: en
1247         schema:
1248           type: string
1249       - name: filter[title_cont]
1250         in: query
1251         description: ''
1252         example: About Us
1253         schema:
1254           type: string
1255       responses:
1256         '200':
1257           description: Records returned
1258           content:
1259             application/vnd.api+json:
1260               examples:
1261                 Example:
1262                   value:
1263                     data:
1264                     - id: '1'
1265                       type: cms_page
1266                       attributes:
1267                         title: Modi soluta tenetur velit odit corporis aut.
1268                         meta_title:
1269                         content:
1270                         meta_description:
1271                         visible: true
1272                         slug: modi-soluta-tenetur-velit-odit-corporis-aut
1273                         type: Spree::Cms::Pages::StandardPage
1274                         locale: en
1275                         deleted_at:
1276                         created_at: '2022-11-08T19:34:00.831Z'
1277                         updated_at: '2022-11-08T19:34:00.831Z'
1278                       relationships:
1279                         cms_sections:
1280                           data: []
1281                     - id: '2'
1282                       type: cms_page
1283                       attributes:
1284                         title: Distinctio alias numquam porro corrupti enim perferendis
1285                           fugiat.
1286                         meta_title:
1287                         content:
1288                         meta_description:
1289                         visible: true
1290                         slug: distinctio-alias-numquam-porro-corrupti-enim-perferendis-fugiat
1291                         type: Spree::Cms::Pages::StandardPage
1292                         locale: en
1293                         deleted_at:
1294                         created_at: '2022-11-08T19:34:00.836Z'
1295                         updated_at: '2022-11-08T19:34:00.836Z'
1296                       relationships:
1297                         cms_sections:
1298                           data: []
1299                     meta:
1300                       count: 2
1301                       total_count: 2
1302                       total_pages: 1
1303                     links:
1304                       self: http://www.example.com/api/v2/platform/cms_pages?page=1&per_page=&include=&filter[type_eq]=&filter[locale_eq]=&filter[title_cont]=
1305                       next: http://www.example.com/api/v2/platform/cms_pages?filter%5Blocale_eq%5D=&filter%5Btitle_cont%5D=&filter%5Btype_eq%5D=&include=&page=1&per_page=
1306                       prev: http://www.example.com/api/v2/platform/cms_pages?filter%5Blocale_eq%5D=&filter%5Btitle_cont%5D=&filter%5Btype_eq%5D=&include=&page=1&per_page=
1307                       last: http://www.example.com/api/v2/platform/cms_pages?filter%5Blocale_eq%5D=&filter%5Btitle_cont%5D=&filter%5Btype_eq%5D=&include=&page=1&per_page=
1308                       first: http://www.example.com/api/v2/platform/cms_pages?filter%5Blocale_eq%5D=&filter%5Btitle_cont%5D=&filter%5Btype_eq%5D=&include=&page=1&per_page=
1309               schema:
1310                 "$ref": "#/components/schemas/resources_list"
1311         '401':
1312           description: Authentication Failed
1313           content:
1314             application/vnd.api+json:
1315               examples:
1316                 Example:
1317                   value:
1318                     error: The access token is invalid
1319               schema:
1320                 "$ref": "#/components/schemas/error"
1321     post:
1322       summary: Create a CMS Page
1323       tags:
1324       - CMS Pages
1325       security:
1326       - bearer_auth: []
1327       description: Creates a CMS Page
1328       operationId: create-cms-page
1329       parameters:
1330       - name: include
1331         in: query
1332         description: 'Select which associated resources you would like to fetch, see:
1333           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1334         example: cms_sections
1335         schema:
1336           type: string
1337       responses:
1338         '201':
1339           description: Record created
1340           content:
1341             application/vnd.api+json:
1342               examples:
1343                 Example:
1344                   value:
1345                     data:
1346                       id: '5'
1347                       type: cms_page
1348                       attributes:
1349                         title: Eligendi recusandae hic magnam at voluptates delectus
1350                           quis.
1351                         meta_title:
1352                         content:
1353                         meta_description:
1354                         visible: true
1355                         slug: eligendi-recusandae-hic-magnam-at-voluptates-delectus-quis
1356                         type: Spree::Cms::Pages::StandardPage
1357                         locale: en
1358                         deleted_at:
1359                         created_at: '2022-11-08T19:34:01.378Z'
1360                         updated_at: '2022-11-08T19:34:01.378Z'
1361                       relationships:
1362                         cms_sections:
1363                           data: []
1364               schema:
1365                 "$ref": "#/components/schemas/resource"
1366         '422':
1367           description: Invalid request
1368           content:
1369             application/vnd.api+json:
1370               examples:
1371                 Example:
1372                   value:
1373                     error: Title can't be blank, Locale can't be blank, and Type can't
1374                       be blank
1375                     errors:
1376                       title:
1377                       - can't be blank
1378                       locale:
1379                       - can't be blank
1380                       type:
1381                       - can't be blank
1382               schema:
1383                 "$ref": "#/components/schemas/validation_errors"
1384       requestBody:
1385         content:
1386           application/json:
1387             schema:
1388               oneOf:
1389               - "$ref": "#/components/schemas/create_standard_cms_page_params"
1390               - "$ref": "#/components/schemas/create_homepage_cms_page_params"
1391               - "$ref": "#/components/schemas/create_feature_cms_page_params"
1392   "/api/v2/platform/cms_pages/{id}":
1393     get:
1394       summary: Return a CMS Page
1395       tags:
1396       - CMS Pages
1397       security:
1398       - bearer_auth: []
1399       description: Returns a CMS Page
1400       operationId: show-cms-page
1401       parameters:
1402       - name: id
1403         in: path
1404         required: true
1405         schema:
1406           type: string
1407       - name: include
1408         in: query
1409         description: 'Select which associated resources you would like to fetch, see:
1410           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1411         example: cms_sections
1412         schema:
1413           type: string
1414       responses:
1415         '200':
1416           description: Record found
1417           content:
1418             application/vnd.api+json:
1419               examples:
1420                 Example:
1421                   value:
1422                     data:
1423                       id: '6'
1424                       type: cms_page
1425                       attributes:
1426                         title: Tempora ut laudantium occaecati sunt magnam quae consequuntur.
1427                         meta_title:
1428                         content:
1429                         meta_description:
1430                         visible: true
1431                         slug: tempora-ut-laudantium-occaecati-sunt-magnam-quae-consequuntur
1432                         type: Spree::Cms::Pages::StandardPage
1433                         locale: en
1434                         deleted_at:
1435                         created_at: '2022-11-08T19:34:01.659Z'
1436                         updated_at: '2022-11-08T19:34:01.659Z'
1437                       relationships:
1438                         cms_sections:
1439                           data: []
1440               schema:
1441                 "$ref": "#/components/schemas/resource"
1442         '404':
1443           description: Record not found
1444           content:
1445             application/vnd.api+json:
1446               examples:
1447                 Example:
1448                   value:
1449                     error: The resource you were looking for could not be found.
1450               schema:
1451                 "$ref": "#/components/schemas/error"
1452         '401':
1453           description: Authentication Failed
1454           content:
1455             application/vnd.api+json:
1456               examples:
1457                 Example:
1458                   value:
1459                     error: The access token is invalid
1460               schema:
1461                 "$ref": "#/components/schemas/error"
1462     patch:
1463       summary: Update a CMS Page
1464       tags:
1465       - CMS Pages
1466       security:
1467       - bearer_auth: []
1468       description: Updates a CMS Page
1469       operationId: update-cms-page
1470       parameters:
1471       - name: id
1472         in: path
1473         required: true
1474         schema:
1475           type: string
1476       - name: include
1477         in: query
1478         description: 'Select which associated resources you would like to fetch, see:
1479           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1480         example: cms_sections
1481         schema:
1482           type: string
1483       responses:
1484         '200':
1485           description: Record updated
1486           content:
1487             application/vnd.api+json:
1488               examples:
1489                 Example:
1490                   value:
1491                     data:
1492                       id: '8'
1493                       type: cms_page
1494                       attributes:
1495                         title: My Super Page
1496                         meta_title:
1497                         content:
1498                         meta_description:
1499                         visible: true
1500                         slug: cumque-excepturi-nisi-cupiditate-dolore
1501                         type: Spree::Cms::Pages::StandardPage
1502                         locale: en
1503                         deleted_at:
1504                         created_at: '2022-11-08T19:34:02.188Z'
1505                         updated_at: '2022-11-08T19:34:02.420Z'
1506                       relationships:
1507                         cms_sections:
1508                           data: []
1509               schema:
1510                 "$ref": "#/components/schemas/resource"
1511         '422':
1512           description: Invalid request
1513           content:
1514             application/vnd.api+json:
1515               examples:
1516                 Example:
1517                   value:
1518                     error: Title can't be blank
1519                     errors:
1520                       title:
1521                       - can't be blank
1522               schema:
1523                 "$ref": "#/components/schemas/validation_errors"
1524         '404':
1525           description: Record not found
1526           content:
1527             application/vnd.api+json:
1528               examples:
1529                 Example:
1530                   value:
1531                     error: The resource you were looking for could not be found.
1532               schema:
1533                 "$ref": "#/components/schemas/error"
1534         '401':
1535           description: Authentication Failed
1536           content:
1537             application/vnd.api+json:
1538               examples:
1539                 Example:
1540                   value:
1541                     error: The access token is invalid
1542               schema:
1543                 "$ref": "#/components/schemas/error"
1544       requestBody:
1545         content:
1546           application/json:
1547             schema:
1548               oneOf:
1549               - "$ref": "#/components/schemas/update_standard_cms_page_params"
1550               - "$ref": "#/components/schemas/update_homepage_cms_page_params"
1551               - "$ref": "#/components/schemas/update_feature_cms_page_params"
1552     delete:
1553       summary: Delete a CMS Page
1554       tags:
1555       - CMS Pages
1556       security:
1557       - bearer_auth: []
1558       description: Deletes a CMS Page
1559       operationId: delete-cms-page
1560       parameters:
1561       - name: id
1562         in: path
1563         required: true
1564         schema:
1565           type: string
1566       responses:
1567         '204':
1568           description: Record deleted
1569         '404':
1570           description: Record not found
1571           content:
1572             application/vnd.api+json:
1573               examples:
1574                 Example:
1575                   value:
1576                     error: The resource you were looking for could not be found.
1577               schema:
1578                 "$ref": "#/components/schemas/error"
1579         '401':
1580           description: Authentication Failed
1581           content:
1582             application/vnd.api+json:
1583               examples:
1584                 Example:
1585                   value:
1586                     error: The access token is invalid
1587               schema:
1588                 "$ref": "#/components/schemas/error"
1589   "/api/v2/platform/cms_sections":
1590     get:
1591       summary: Return a list of CMS Sections
1592       tags:
1593       - CMS Sections
1594       security:
1595       - bearer_auth: []
1596       description: Returns a list of CMS Sections
1597       operationId: cms-sections-list
1598       parameters:
1599       - name: page
1600         in: query
1601         example: 1
1602         schema:
1603           type: integer
1604       - name: per_page
1605         in: query
1606         example: 50
1607         schema:
1608           type: integer
1609       - name: include
1610         in: query
1611         description: 'Select which associated resources you would like to fetch, see:
1612           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1613         example: product
1614         schema:
1615           type: string
1616       - name: filter[name_eq]
1617         in: query
1618         description: ''
1619         example: Hero
1620         schema:
1621           type: string
1622       responses:
1623         '200':
1624           description: Records returned
1625           content:
1626             application/vnd.api+json:
1627               examples:
1628                 Example:
1629                   value:
1630                     data:
1631                     - id: '1'
1632                       type: cms_section
1633                       attributes:
1634                         name: Culpa natus incidunt nisi itaque quod harum quisquam
1635                           nesciunt.
1636                         content: {}
1637                         settings:
1638                           gutters: No Gutters
1639                         fit: Screen
1640                         destination:
1641                         type: Spree::Cms::Sections::HeroImage
1642                         position: 1
1643                         linked_resource_type: Spree::Taxon
1644                         created_at: '2022-11-08T19:34:03.525Z'
1645                         updated_at: '2022-11-08T19:34:03.525Z'
1646                       relationships:
1647                         cms_page:
1648                           data:
1649                             id: '13'
1650                             type: cms_page
1651                         linked_resource:
1652                           data:
1653                     - id: '2'
1654                       type: cms_section
1655                       attributes:
1656                         name: Aperiam quo deserunt qui quidem unde ratione.
1657                         content:
1658                           link_type_one: Spree::Taxon
1659                           link_type_two: Spree::Taxon
1660                           link_type_three: Spree::Taxon
1661                         settings:
1662                           layout_style: Default
1663                         fit: Container
1664                         destination:
1665                         type: Spree::Cms::Sections::ImageGallery
1666                         position: 2
1667                         linked_resource_type:
1668                         created_at: '2022-11-08T19:34:03.529Z'
1669                         updated_at: '2022-11-08T19:34:03.529Z'
1670                       relationships:
1671                         cms_page:
1672                           data:
1673                             id: '13'
1674                             type: cms_page
1675                         linked_resource:
1676                           data:
1677                     - id: '3'
1678                       type: cms_section
1679                       attributes:
1680                         name: Molestiae quo distinctio enim dignissimos laborum cumque.
1681                         content: {}
1682                         settings:
1683                           gutters: No Gutters
1684                         fit: Screen
1685                         destination:
1686                         type: Spree::Cms::Sections::FeaturedArticle
1687                         position: 3
1688                         linked_resource_type: Spree::Taxon
1689                         created_at: '2022-11-08T19:34:03.534Z'
1690                         updated_at: '2022-11-08T19:34:03.534Z'
1691                       relationships:
1692                         cms_page:
1693                           data:
1694                             id: '13'
1695                             type: cms_page
1696                         linked_resource:
1697                           data:
1698                     - id: '4'
1699                       type: cms_section
1700                       attributes:
1701                         name: Quaerat ad enim consequuntur vitae.
1702                         content: {}
1703                         settings:
1704                           gutters: No Gutters
1705                         fit: Screen
1706                         destination:
1707                         type: Spree::Cms::Sections::HeroImage
1708                         position: 4
1709                         linked_resource_type: Spree::Product
1710                         created_at: '2022-11-08T19:34:03.539Z'
1711                         updated_at: '2022-11-08T19:34:03.539Z'
1712                       relationships:
1713                         cms_page:
1714                           data:
1715                             id: '13'
1716                             type: cms_page
1717                         linked_resource:
1718                           data:
1719                             id: '21'
1720                             type: product
1721                     - id: '5'
1722                       type: cms_section
1723                       attributes:
1724                         name: Quod saepe occaecati et eaque eum expedita ut.
1725                         content: {}
1726                         settings:
1727                           gutters: No Gutters
1728                         fit: Screen
1729                         destination:
1730                         type: Spree::Cms::Sections::HeroImage
1731                         position: 5
1732                         linked_resource_type: Spree::Product
1733                         created_at: '2022-11-08T19:34:03.543Z'
1734                         updated_at: '2022-11-08T19:34:03.543Z'
1735                       relationships:
1736                         cms_page:
1737                           data:
1738                             id: '13'
1739                             type: cms_page
1740                         linked_resource:
1741                           data:
1742                             id: '21'
1743                             type: product
1744                     meta:
1745                       count: 5
1746                       total_count: 5
1747                       total_pages: 1
1748                     links:
1749                       self: http://www.example.com/api/v2/platform/cms_sections?page=1&per_page=&include=&filter[name_eq]=
1750                       next: http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=
1751                       prev: http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=
1752                       last: http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=
1753                       first: http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=
1754               schema:
1755                 "$ref": "#/components/schemas/resources_list"
1756         '401':
1757           description: Authentication Failed
1758           content:
1759             application/vnd.api+json:
1760               examples:
1761                 Example:
1762                   value:
1763                     error: The access token is invalid
1764               schema:
1765                 "$ref": "#/components/schemas/error"
1766     post:
1767       summary: Create a CMS Section
1768       tags:
1769       - CMS Sections
1770       security:
1771       - bearer_auth: []
1772       description: Creates a CMS Section
1773       operationId: create-cms-section
1774       parameters:
1775       - name: include
1776         in: query
1777         description: 'Select which associated resources you would like to fetch, see:
1778           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1779         example: product
1780         schema:
1781           type: string
1782       responses:
1783         '201':
1784           description: Record created
1785           content:
1786             application/vnd.api+json:
1787               examples:
1788                 Example:
1789                   value:
1790                     data:
1791                       id: '13'
1792                       type: cms_section
1793                       attributes:
1794                         name: Hic iste cupiditate corrupti esse minima.
1795                         content: {}
1796                         settings:
1797                           gutters: No Gutters
1798                         fit: Screen
1799                         destination:
1800                         type: Spree::Cms::Sections::HeroImage
1801                         position: 3
1802                         linked_resource_type: Spree::Product
1803                         created_at: '2022-11-08T19:34:04.185Z'
1804                         updated_at: '2022-11-08T19:34:04.185Z'
1805                       relationships:
1806                         cms_page:
1807                           data:
1808                             id: '15'
1809                             type: cms_page
1810                         linked_resource:
1811                           data:
1812                             id: '23'
1813                             type: product
1814               schema:
1815                 "$ref": "#/components/schemas/resource"
1816         '422':
1817           description: Invalid request
1818           content:
1819             application/vnd.api+json:
1820               examples:
1821                 Example:
1822                   value:
1823                     error: Name can't be blank, Cms page can't be blank, and Type
1824                       can't be blank
1825                     errors:
1826                       name:
1827                       - can't be blank
1828                       cms_page:
1829                       - can't be blank
1830                       type:
1831                       - can't be blank
1832               schema:
1833                 "$ref": "#/components/schemas/validation_errors"
1834       requestBody:
1835         content:
1836           application/json:
1837             schema:
1838               oneOf:
1839               - "$ref": "#/components/schemas/create_hero_image_cms_section_params"
1840               - "$ref": "#/components/schemas/create_product_carousel_cms_section_params"
1841               - "$ref": "#/components/schemas/create_side_by_side_images_cms_section_params"
1842               - "$ref": "#/components/schemas/create_featured_article_cms_section_params"
1843               - "$ref": "#/components/schemas/create_image_gallery_cms_section_params"
1844               - "$ref": "#/components/schemas/create_rich_text_cms_section_params"
1845   "/api/v2/platform/cms_sections/{id}":
1846     get:
1847       summary: Return a CMS Section
1848       tags:
1849       - CMS Sections
1850       security:
1851       - bearer_auth: []
1852       description: Returns a CMS Section
1853       operationId: show-cms-section
1854       parameters:
1855       - name: id
1856         in: path
1857         required: true
1858         schema:
1859           type: string
1860       - name: include
1861         in: query
1862         description: 'Select which associated resources you would like to fetch, see:
1863           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1864         example: product
1865         schema:
1866           type: string
1867       responses:
1868         '200':
1869           description: Record found
1870           content:
1871             application/vnd.api+json:
1872               examples:
1873                 Example:
1874                   value:
1875                     data:
1876                       id: '19'
1877                       type: cms_section
1878                       attributes:
1879                         name: Debitis rerum nulla maiores quam ut impedit.
1880                         content: {}
1881                         settings:
1882                           gutters: No Gutters
1883                         fit: Screen
1884                         destination:
1885                         type: Spree::Cms::Sections::HeroImage
1886                         position: 4
1887                         linked_resource_type: Spree::Product
1888                         created_at: '2022-11-08T19:34:04.573Z'
1889                         updated_at: '2022-11-08T19:34:04.573Z'
1890                       relationships:
1891                         cms_page:
1892                           data:
1893                             id: '17'
1894                             type: cms_page
1895                         linked_resource:
1896                           data:
1897                             id: '25'
1898                             type: product
1899               schema:
1900                 "$ref": "#/components/schemas/resource"
1901         '404':
1902           description: Record not found
1903           content:
1904             application/vnd.api+json:
1905               examples:
1906                 Example:
1907                   value:
1908                     error: The resource you were looking for could not be found.
1909               schema:
1910                 "$ref": "#/components/schemas/error"
1911         '401':
1912           description: Authentication Failed
1913           content:
1914             application/vnd.api+json:
1915               examples:
1916                 Example:
1917                   value:
1918                     error: The access token is invalid
1919               schema:
1920                 "$ref": "#/components/schemas/error"
1921     patch:
1922       summary: Update a CMS Section
1923       tags:
1924       - CMS Sections
1925       security:
1926       - bearer_auth: []
1927       description: Updates a CMS Section
1928       operationId: update-cms-section
1929       parameters:
1930       - name: id
1931         in: path
1932         required: true
1933         schema:
1934           type: string
1935       - name: include
1936         in: query
1937         description: 'Select which associated resources you would like to fetch, see:
1938           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
1939         example: product
1940         schema:
1941           type: string
1942       responses:
1943         '200':
1944           description: Record updated
1945           content:
1946             application/vnd.api+json:
1947               examples:
1948                 Example:
1949                   value:
1950                     data:
1951                       id: '29'
1952                       type: cms_section
1953                       attributes:
1954                         name: Super Hero
1955                         content: {}
1956                         settings:
1957                           gutters: No Gutters
1958                         fit: Screen
1959                         destination:
1960                         type: Spree::Cms::Sections::HeroImage
1961                         position: 1
1962                         linked_resource_type: Spree::Product
1963                         created_at: '2022-11-08T19:34:05.290Z'
1964                         updated_at: '2022-11-08T19:34:05.525Z'
1965                       relationships:
1966                         cms_page:
1967                           data:
1968                             id: '20'
1969                             type: cms_page
1970                         linked_resource:
1971                           data:
1972                             id: '28'
1973                             type: product
1974               schema:
1975                 "$ref": "#/components/schemas/resource"
1976         '422':
1977           description: Invalid request
1978           content:
1979             application/vnd.api+json:
1980               examples:
1981                 Example:
1982                   value:
1983                     error: Name can't be blank
1984                     errors:
1985                       name:
1986                       - can't be blank
1987               schema:
1988                 "$ref": "#/components/schemas/validation_errors"
1989         '404':
1990           description: Record not found
1991           content:
1992             application/vnd.api+json:
1993               examples:
1994                 Example:
1995                   value:
1996                     error: The resource you were looking for could not be found.
1997               schema:
1998                 "$ref": "#/components/schemas/error"
1999         '401':
2000           description: Authentication Failed
2001           content:
2002             application/vnd.api+json:
2003               examples:
2004                 Example:
2005                   value:
2006                     error: The access token is invalid
2007               schema:
2008                 "$ref": "#/components/schemas/error"
2009       requestBody:
2010         content:
2011           application/json:
2012             schema:
2013               oneOf:
2014               - "$ref": "#/components/schemas/update_hero_image_cms_section_params"
2015               - "$ref": "#/components/schemas/update_product_carousel_cms_section_params"
2016               - "$ref": "#/components/schemas/update_side_by_side_images_cms_section_params"
2017               - "$ref": "#/components/schemas/update_featured_article_cms_section_params"
2018               - "$ref": "#/components/schemas/update_image_gallery_cms_section_params"
2019               - "$ref": "#/components/schemas/update_rich_text_cms_section_params"
2020     delete:
2021       summary: Delete a CMS Section
2022       tags:
2023       - CMS Sections
2024       security:
2025       - bearer_auth: []
2026       description: Deletes a CMS Section
2027       operationId: delete-cms-section
2028       parameters:
2029       - name: id
2030         in: path
2031         required: true
2032         schema:
2033           type: string
2034       responses:
2035         '204':
2036           description: Record deleted
2037         '404':
2038           description: Record not found
2039           content:
2040             application/vnd.api+json:
2041               examples:
2042                 Example:
2043                   value:
2044                     error: The resource you were looking for could not be found.
2045               schema:
2046                 "$ref": "#/components/schemas/error"
2047         '401':
2048           description: Authentication Failed
2049           content:
2050             application/vnd.api+json:
2051               examples:
2052                 Example:
2053                   value:
2054                     error: The access token is invalid
2055               schema:
2056                 "$ref": "#/components/schemas/error"
2057   "/api/v2/platform/countries":
2058     get:
2059       summary: Returns a list of Countries
2060       tags:
2061       - Countries
2062       security:
2063       - bearer_auth: []
2064       operationId: countries-list
2065       description: Returns a list of Countries
2066       responses:
2067         '200':
2068           description: Records returned
2069           content:
2070             application/vnd.api+json:
2071               examples:
2072                 Example:
2073                   value:
2074                     data:
2075                     - id: '72'
2076                       type: country
2077                       attributes:
2078                         iso_name: UNITED STATES
2079                         iso: US
2080                         iso3: USA
2081                         name: United States of America
2082                         numcode: 840
2083                         states_required: true
2084                         updated_at: '2022-11-08T19:34:06.932Z'
2085                         zipcode_required: true
2086                         created_at: '2022-11-08T19:34:06.932Z'
2087                       relationships:
2088                         states:
2089                           data: []
2090                     - id: '73'
2091                       type: country
2092                       attributes:
2093                         iso_name: ISO_NAME_2
2094                         iso: I2
2095                         iso3: IS2
2096                         name: NAME_2
2097                         numcode: 840
2098                         states_required: false
2099                         updated_at: '2022-11-08T19:34:06.937Z'
2100                         zipcode_required: true
2101                         created_at: '2022-11-08T19:34:06.937Z'
2102                       relationships:
2103                         states:
2104                           data: []
2105                     - id: '74'
2106                       type: country
2107                       attributes:
2108                         iso_name: ISO_NAME_3
2109                         iso: I3
2110                         iso3: IS3
2111                         name: NAME_3
2112                         numcode: 840
2113                         states_required: false
2114                         updated_at: '2022-11-08T19:34:06.939Z'
2115                         zipcode_required: true
2116                         created_at: '2022-11-08T19:34:06.939Z'
2117                       relationships:
2118                         states:
2119                           data: []
2120                     meta:
2121                       count: 3
2122                       total_count: 3
2123                       total_pages: 1
2124                     links:
2125                       self: http://www.example.com/api/v2/platform/countries
2126                       next: http://www.example.com/api/v2/platform/countries?page=1
2127                       prev: http://www.example.com/api/v2/platform/countries?page=1
2128                       last: http://www.example.com/api/v2/platform/countries?page=1
2129                       first: http://www.example.com/api/v2/platform/countries?page=1
2130               schema:
2131                 "$ref": "#/components/schemas/resources_list"
2132         '401':
2133           description: Authentication Failed
2134           content:
2135             application/vnd.api+json:
2136               examples:
2137                 Example:
2138                   value:
2139                     error: The access token is invalid
2140               schema:
2141                 "$ref": "#/components/schemas/error"
2142   "/api/v2/platform/countries/{id}":
2143     get:
2144       summary: Returns a Country
2145       tags:
2146       - Countries
2147       security:
2148       - bearer_auth: []
2149       operationId: show-country
2150       description: Returns a Country
2151       parameters:
2152       - name: id
2153         in: path
2154         required: true
2155         schema:
2156           type: string
2157       responses:
2158         '200':
2159           description: Record found
2160           content:
2161             application/vnd.api+json:
2162               examples:
2163                 Example:
2164                   value:
2165                     data:
2166                       id: '79'
2167                       type: country
2168                       attributes:
2169                         iso_name: ISO_NAME_6
2170                         iso: I6
2171                         iso3: IS6
2172                         name: NAME_6
2173                         numcode: 840
2174                         states_required: false
2175                         updated_at: '2022-11-08T19:34:07.232Z'
2176                         zipcode_required: true
2177                         created_at: '2022-11-08T19:34:07.232Z'
2178                       relationships:
2179                         states:
2180                           data: []
2181               schema:
2182                 "$ref": "#/components/schemas/resource"
2183         '404':
2184           description: Record not found
2185           content:
2186             application/vnd.api+json:
2187               examples:
2188                 Example:
2189                   value:
2190                     error: The resource you were looking for could not be found.
2191               schema:
2192                 "$ref": "#/components/schemas/error"
2193         '401':
2194           description: Authentication Failed
2195           content:
2196             application/vnd.api+json:
2197               examples:
2198                 Example:
2199                   value:
2200                     error: The access token is invalid
2201               schema:
2202                 "$ref": "#/components/schemas/error"
2203   "/api/v2/platform/data_feeds":
2204     get:
2205       summary: Return a list of Data Feeds
2206       tags:
2207         - Data Feeds
2208       security:
2209         - bearer_auth: [ ]
2210       operationId: data-feeds-list
2211       parameters:
2212         - name: page
2213           in: query
2214           example: 1
2215           schema:
2216             type: integer
2217         - name: per_page
2218           in: query
2219           example: 50
2220           schema:
2221             type: integer
2222       responses:
2223         '200':
2224           description: Records returned
2225           content:
2226             application/vnd.api+json:
2227               examples:
2228                 Example:
2229                   value:
2230                     data:
2231                       - id: '1'
2232                         type: data_feed
2233                         attributes:
2234                           name: First Data Feed
2235                           type: Spree::DataFeed::Google
2236                           slug: e593ae1f-630a-4f77-832f-0489da1c921b
2237                           active: true
2238                       - id: '2'
2239                         type: data_feed
2240                         attributes:
2241                           name: Second Data Feed
2242                           type: Spree::DataFeed::Google
2243                           slug: 52f060f2-76cf-4983-89a3-714419941463
2244                           active: true
2245                     meta:
2246                       count: 2
2247                       total_count: 2
2248                       total_pages: 1
2249                     links:
2250                       self: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
2251                       next: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
2252                       prev: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
2253                       last: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
2254                       first: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
2255               schema:
2256                 "$ref": "#/components/schemas/resources_list"
2257         '401':
2258           description: Authentication Failed
2259           content:
2260             application/vnd.api+json:
2261               examples:
2262                 Example:
2263                   value:
2264                     error: The access token is invalid
2265               schema:
2266                 "$ref": "#/components/schemas/error"
2267     post:
2268       summary: Create a Data Feed
2269       tags:
2270         - Data Feeds
2271       security:
2272         - bearer_auth: [ ]
2273       description: Creates a Data Feed
2274       operationId: create-data-feed
2275       parameters: [ ]
2276       responses:
2277         '201':
2278           description: Record created
2279           content:
2280             application/vnd.api+json:
2281               examples:
2282                 Example:
2283                   value:
2284                     data:
2285                       id: '1'
2286                       type: data_feed
2287                       attributes:
2288                         name: First Data Feed
2289                         type: Spree::DataFeed::Google
2290                         slug: e593ae1f-630a-4f77-832f-0489da1c921b
2291                         active: true
2292               schema:
2293                 "$ref": "#/components/schemas/resource"
2294         '422':
2295           description: Invalid request
2296           content:
2297             application/vnd.api+json:
2298               examples:
2299                 Example:
2300                   value:
2301                     error: Data Feed name can't be blank
2302                     errors:
2303                       name:
2304                         - can't be blank
2305                       type:
2306                         - can't be blank
2307               schema:
2308                 "$ref": "#/components/schemas/validation_errors"
2309       requestBody:
2310         content:
2311           application/json:
2312             schema:
2313               "$ref": "#/components/schemas/create_data_feed_params"
2314   "/api/v2/platform/data_feeds/{id}":
2315     get:
2316       summary: Return a Data Feed
2317       tags:
2318         - Data Feeds
2319       security:
2320         - bearer_auth: [ ]
2321       description: Returns a Data Feed
2322       operationId: show-data-feed
2323       parameters:
2324         - name: id
2325           in: path
2326           required: true
2327           schema:
2328             type: string
2329       responses:
2330         '200':
2331           description: Record found
2332           content:
2333             application/vnd.api+json:
2334               examples:
2335                 Example:
2336                   value:
2337                     data:
2338                       id: '1'
2339                       type: data_feed
2340                       attributes:
2341                         name: First Data Feed
2342                         type: Spree::DataFeed::Google
2343                         slug: e593ae1f-630a-4f77-832f-0489da1c921b
2344                         active: true
2345                       relationships:
2346                         store:
2347                           data:
2348                             id: '1'
2349                             type: store
2350               schema:
2351                 "$ref": "#/components/schemas/resource"
2352         '404':
2353           description: Record not found
2354           content:
2355             application/vnd.api+json:
2356               examples:
2357                 Example:
2358                   value:
2359                     error: The resource you were looking for could not be found.
2360               schema:
2361                 "$ref": "#/components/schemas/error"
2362         '401':
2363           description: Authentication Failed
2364           content:
2365             application/vnd.api+json:
2366               examples:
2367                 Example:
2368                   value:
2369                     error: The access token is invalid
2370               schema:
2371                 "$ref": "#/components/schemas/error"
2372     patch:
2373       summary: Update a Data Feed
2374       tags:
2375         - Data Feeds
2376       security:
2377         - bearer_auth: [ ]
2378       description: Updates a Data Feed
2379       operationId: update-data-feed
2380       parameters:
2381         - name: id
2382           in: path
2383           required: true
2384           schema:
2385             type: string
2386       responses:
2387         '200':
2388           description: Record updated
2389           content:
2390             application/vnd.api+json:
2391               examples:
2392                 Example:
2393                   value:
2394                     data:
2395                       id: '1'
2396                       type: data_feed
2397                       attributes:
2398                         name: First Data Feed
2399                         type: Spree::DataFeed::Google
2400                         slug: e593ae1f-630a-4f77-832f-0489da1c921b
2401                         active: true
2402               schema:
2403                 "$ref": "#/components/schemas/resource"
2404         '422':
2405           description: Invalid request
2406           content:
2407             application/vnd.api+json:
2408               examples:
2409                 Example:
2410                   value:
2411                     error: Name is blank
2412                     errors:
2413                       name:
2414                         - is blank
2415               schema:
2416                 "$ref": "#/components/schemas/validation_errors"
2417         '404':
2418           description: Record not found
2419           content:
2420             application/vnd.api+json:
2421               examples:
2422                 Example:
2423                   value:
2424                     error: The resource you were looking for could not be found.
2425               schema:
2426                 "$ref": "#/components/schemas/error"
2427         '401':
2428           description: Authentication Failed
2429           content:
2430             application/vnd.api+json:
2431               examples:
2432                 Example:
2433                   value:
2434                     error: The access token is invalid
2435               schema:
2436                 "$ref": "#/components/schemas/error"
2437       requestBody:
2438         content:
2439           application/json:
2440             schema:
2441               "$ref": "#/components/schemas/update_data_feed_params"
2442     delete:
2443       summary: Delete a Data Feed
2444       tags:
2445         - Data Feeds
2446       security:
2447         - bearer_auth: [ ]
2448       description: Deletes a Data Feed
2449       operationId: delete-data-feed
2450       parameters:
2451         - name: id
2452           in: path
2453           required: true
2454           schema:
2455             type: string
2456       responses:
2457         '204':
2458           description: Record deleted
2459         '404':
2460           description: Record not found
2461           content:
2462             application/vnd.api+json:
2463               examples:
2464                 Example:
2465                   value:
2466                     error: The resource you were looking for could not be found.
2467               schema:
2468                 "$ref": "#/components/schemas/error"
2469         '401':
2470           description: Authentication Failed
2471           content:
2472             application/vnd.api+json:
2473               examples:
2474                 Example:
2475                   value:
2476                     error: The access token is invalid
2477               schema:
2478                 "$ref": "#/components/schemas/error"
2479   "/api/v2/platform/digital_links":
2480     get:
2481       summary: Return a list of Digital Links
2482       tags:
2483       - Digital Links
2484       security:
2485       - bearer_auth: []
2486       description: Returns a list of Digital Links
2487       operationId: digital-links-list
2488       parameters:
2489       - name: page
2490         in: query
2491         example: 1
2492         schema:
2493           type: integer
2494       - name: per_page
2495         in: query
2496         example: 50
2497         schema:
2498           type: integer
2499       responses:
2500         '200':
2501           description: Records returned
2502           content:
2503             application/vnd.api+json:
2504               examples:
2505                 Example:
2506                   value:
2507                     data:
2508                     - id: '1'
2509                       type: digital_link
2510                       attributes:
2511                         token: K5s8uUkdD2TjL8MySKcT3d4Y
2512                         access_counter: 0
2513                       relationships:
2514                         digital:
2515                           data:
2516                             id: '1'
2517                             type: digital
2518                         line_item:
2519                           data:
2520                             id: '9'
2521                             type: line_item
2522                     - id: '2'
2523                       type: digital_link
2524                       attributes:
2525                         token: kCrqhTH4d6jUnzGnvx6vRjMH
2526                         access_counter: 0
2527                       relationships:
2528                         digital:
2529                           data:
2530                             id: '2'
2531                             type: digital
2532                         line_item:
2533                           data:
2534                             id: '10'
2535                             type: line_item
2536                     meta:
2537                       count: 2
2538                       total_count: 2
2539                       total_pages: 1
2540                     links:
2541                       self: http://www.example.com/api/v2/platform/digital_links?page=1&per_page=
2542                       next: http://www.example.com/api/v2/platform/digital_links?page=1&per_page=
2543                       prev: http://www.example.com/api/v2/platform/digital_links?page=1&per_page=
2544                       last: http://www.example.com/api/v2/platform/digital_links?page=1&per_page=
2545                       first: http://www.example.com/api/v2/platform/digital_links?page=1&per_page=
2546               schema:
2547                 "$ref": "#/components/schemas/resources_list"
2548         '401':
2549           description: Authentication Failed
2550           content:
2551             application/vnd.api+json:
2552               examples:
2553                 Example:
2554                   value:
2555                     error: The access token is invalid
2556               schema:
2557                 "$ref": "#/components/schemas/error"
2558     post:
2559       summary: Create a Digital Link
2560       tags:
2561       - Digital Links
2562       security:
2563       - bearer_auth: []
2564       description: Creates a Digital Link
2565       operationId: create-digital-link
2566       parameters: []
2567       responses:
2568         '201':
2569           description: Record created
2570           content:
2571             application/vnd.api+json:
2572               examples:
2573                 Example:
2574                   value:
2575                     data:
2576                       id: '5'
2577                       type: digital_link
2578                       attributes:
2579                         token: 6bPn1uP9HWaYecdMFkFAkcc3
2580                         access_counter: 0
2581                       relationships:
2582                         digital:
2583                           data:
2584                             id: '5'
2585                             type: digital
2586                         line_item:
2587                           data:
2588                             id: '13'
2589                             type: line_item
2590               schema:
2591                 "$ref": "#/components/schemas/resource"
2592         '422':
2593           description: Invalid request
2594           content:
2595             application/vnd.api+json:
2596               examples:
2597                 Example:
2598                   value:
2599                     error: Digital can't be blank, Line item can't be blank, and Access
2600                       counter is not a number
2601                     errors:
2602                       digital:
2603                       - can't be blank
2604                       line_item:
2605                       - can't be blank
2606                       access_counter:
2607                       - is not a number
2608               schema:
2609                 "$ref": "#/components/schemas/validation_errors"
2610       requestBody:
2611         content:
2612           application/json:
2613             schema:
2614               "$ref": "#/components/schemas/create_digital_link_params"
2615   "/api/v2/platform/digital_links/{id}":
2616     get:
2617       summary: Return a Digital Link
2618       tags:
2619       - Digital Links
2620       security:
2621       - bearer_auth: []
2622       description: Returns a Digital Link
2623       operationId: show-digital-link
2624       parameters:
2625       - name: id
2626         in: path
2627         required: true
2628         schema:
2629           type: string
2630       responses:
2631         '200':
2632           description: Record found
2633           content:
2634             application/vnd.api+json:
2635               examples:
2636                 Example:
2637                   value:
2638                     data:
2639                       id: '6'
2640                       type: digital_link
2641                       attributes:
2642                         token: vxRU3WSqXJ2J2WbjaC2kLHpg
2643                         access_counter: 0
2644                       relationships:
2645                         digital:
2646                           data:
2647                             id: '6'
2648                             type: digital
2649                         line_item:
2650                           data:
2651                             id: '14'
2652                             type: line_item
2653               schema:
2654                 "$ref": "#/components/schemas/resource"
2655         '404':
2656           description: Record not found
2657           content:
2658             application/vnd.api+json:
2659               examples:
2660                 Example:
2661                   value:
2662                     error: The resource you were looking for could not be found.
2663               schema:
2664                 "$ref": "#/components/schemas/error"
2665         '401':
2666           description: Authentication Failed
2667           content:
2668             application/vnd.api+json:
2669               examples:
2670                 Example:
2671                   value:
2672                     error: The access token is invalid
2673               schema:
2674                 "$ref": "#/components/schemas/error"
2675     patch:
2676       summary: Update a Digital Link
2677       tags:
2678       - Digital Links
2679       security:
2680       - bearer_auth: []
2681       description: Updates a Digital Link
2682       operationId: update-digital-link
2683       parameters:
2684       - name: id
2685         in: path
2686         required: true
2687         schema:
2688           type: string
2689       responses:
2690         '200':
2691           description: Record updated
2692           content:
2693             application/vnd.api+json:
2694               examples:
2695                 Example:
2696                   value:
2697                     data:
2698                       id: '8'
2699                       type: digital_link
2700                       attributes:
2701                         token: hv6VNk8yK2oiZRPsB1pQnazN
2702                         access_counter: 0
2703                       relationships:
2704                         digital:
2705                           data:
2706                             id: '8'
2707                             type: digital
2708                         line_item:
2709                           data:
2710                             id: '16'
2711                             type: line_item
2712               schema:
2713                 "$ref": "#/components/schemas/resource"
2714         '422':
2715           description: Invalid request
2716           content:
2717             application/vnd.api+json:
2718               examples:
2719                 Example:
2720                   value:
2721                     error: Access counter is not a number
2722                     errors:
2723                       access_counter:
2724                       - is not a number
2725               schema:
2726                 "$ref": "#/components/schemas/validation_errors"
2727         '404':
2728           description: Record not found
2729           content:
2730             application/vnd.api+json:
2731               examples:
2732                 Example:
2733                   value:
2734                     error: The resource you were looking for could not be found.
2735               schema:
2736                 "$ref": "#/components/schemas/error"
2737         '401':
2738           description: Authentication Failed
2739           content:
2740             application/vnd.api+json:
2741               examples:
2742                 Example:
2743                   value:
2744                     error: The access token is invalid
2745               schema:
2746                 "$ref": "#/components/schemas/error"
2747       requestBody:
2748         content:
2749           application/json:
2750             schema:
2751               "$ref": "#/components/schemas/update_digital_link_params"
2752     delete:
2753       summary: Delete a Digital Link
2754       tags:
2755       - Digital Links
2756       security:
2757       - bearer_auth: []
2758       description: Deletes a Digital Link
2759       operationId: delete-digital-link
2760       parameters:
2761       - name: id
2762         in: path
2763         required: true
2764         schema:
2765           type: string
2766       responses:
2767         '204':
2768           description: Record deleted
2769         '404':
2770           description: Record not found
2771           content:
2772             application/vnd.api+json:
2773               examples:
2774                 Example:
2775                   value:
2776                     error: The resource you were looking for could not be found.
2777               schema:
2778                 "$ref": "#/components/schemas/error"
2779         '401':
2780           description: Authentication Failed
2781           content:
2782             application/vnd.api+json:
2783               examples:
2784                 Example:
2785                   value:
2786                     error: The access token is invalid
2787               schema:
2788                 "$ref": "#/components/schemas/error"
2789   "/api/v2/platform/digital_links/{id}/reset":
2790     patch:
2791       summary: Reset a Digital Link
2792       tags:
2793       - Digital Links
2794       security:
2795       - bearer_auth: []
2796       operationId: reset-digital-link
2797       description: Resets a digital link, allowing further downloads.
2798       parameters:
2799       - name: id
2800         in: path
2801         required: true
2802         schema:
2803           type: string
2804       responses:
2805         '200':
2806           description: Record updated
2807           content:
2808             application/vnd.api+json:
2809               examples:
2810                 Example:
2811                   value:
2812                     data:
2813                       id: '13'
2814                       type: digital_link
2815                       attributes:
2816                         token: NBDYF1WRkrnFJewp4PqjATdQ
2817                         access_counter: 0
2818                       relationships:
2819                         digital:
2820                           data:
2821                             id: '13'
2822                             type: digital
2823                         line_item:
2824                           data:
2825                             id: '21'
2826                             type: line_item
2827               schema:
2828                 "$ref": "#/components/schemas/resource"
2829         '404':
2830           description: Record not found
2831           content:
2832             application/vnd.api+json:
2833               examples:
2834                 Example:
2835                   value:
2836                     error: The resource you were looking for could not be found.
2837               schema:
2838                 "$ref": "#/components/schemas/error"
2839         '401':
2840           description: Authentication Failed
2841           content:
2842             application/vnd.api+json:
2843               examples:
2844                 Example:
2845                   value:
2846                     error: The access token is invalid
2847               schema:
2848                 "$ref": "#/components/schemas/error"
2849   "/api/v2/platform/digitals":
2850     get:
2851       summary: Return a list of Digital Assets
2852       tags:
2853       - Digital Assets
2854       security:
2855       - bearer_auth: []
2856       description: Returns a list of Digital Assets
2857       operationId: digitals-list
2858       parameters:
2859       - name: page
2860         in: query
2861         example: 1
2862         schema:
2863           type: integer
2864       - name: per_page
2865         in: query
2866         example: 50
2867         schema:
2868           type: integer
2869       - name: include
2870         in: query
2871         description: 'Select which associated resources you would like to fetch, see:
2872           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
2873         example: variant
2874         schema:
2875           type: string
2876       responses:
2877         '200':
2878           description: Records returned
2879           content:
2880             application/vnd.api+json:
2881               examples:
2882                 Example:
2883                   value:
2884                     data:
2885                     - id: '15'
2886                       type: digital
2887                       attributes:
2888                         url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBJQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--fd5f8cec8849d4ccb3d1b3142c05292c54a61183/thinking-cat.jpg"
2889                         content_type: image/jpeg
2890                         filename: thinking-cat.jpg
2891                         byte_size: 18090
2892                       relationships:
2893                         variant:
2894                           data:
2895                             id: '80'
2896                             type: variant
2897                     - id: '16'
2898                       type: digital
2899                       attributes:
2900                         url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBJUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--a5cdd34bda2b6ab554834bbebc5eabfe55065258/thinking-cat.jpg"
2901                         content_type: image/jpeg
2902                         filename: thinking-cat.jpg
2903                         byte_size: 18090
2904                       relationships:
2905                         variant:
2906                           data:
2907                             id: '82'
2908                             type: variant
2909                     - id: '17'
2910                       type: digital
2911                       attributes:
2912                         url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBJZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--86cfdf96a18ded007d9ec0ae05dd122cee26fef5/thinking-cat.jpg"
2913                         content_type: image/jpeg
2914                         filename: thinking-cat.jpg
2915                         byte_size: 18090
2916                       relationships:
2917                         variant:
2918                           data:
2919                             id: '84'
2920                             type: variant
2921                     meta:
2922                       count: 3
2923                       total_count: 3
2924                       total_pages: 1
2925                     links:
2926                       self: http://www.example.com/api/v2/platform/digitals?page=1&per_page=&include=
2927                       next: http://www.example.com/api/v2/platform/digitals?include=&page=1&per_page=
2928                       prev: http://www.example.com/api/v2/platform/digitals?include=&page=1&per_page=
2929                       last: http://www.example.com/api/v2/platform/digitals?include=&page=1&per_page=
2930                       first: http://www.example.com/api/v2/platform/digitals?include=&page=1&per_page=
2931               schema:
2932                 "$ref": "#/components/schemas/resources_list"
2933         '401':
2934           description: Authentication Failed
2935           content:
2936             application/vnd.api+json:
2937               examples:
2938                 Example:
2939                   value:
2940                     error: The access token is invalid
2941               schema:
2942                 "$ref": "#/components/schemas/error"
2943     post:
2944       summary: Create a Digital Asset
2945       tags:
2946       - Digital Assets
2947       security:
2948       - bearer_auth: []
2949       description: Creates a Digital Asset
2950       operationId: create-digital
2951       parameters:
2952       - name: include
2953         in: query
2954         description: 'Select which associated resources you would like to fetch, see:
2955           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
2956         example: variant
2957         schema:
2958           type: string
2959       responses:
2960         '201':
2961           description: Record created
2962           content:
2963             application/vnd.api+json:
2964               examples:
2965                 Example:
2966                   value:
2967                     data:
2968                       id: '24'
2969                       type: digital
2970                       attributes:
2971                         url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBLUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--6cac9cd14eb0139474e42d68585bead023589c85/icon_256x256.jpg"
2972                         content_type: image/png
2973                         filename: icon_256x256.jpg
2974                         byte_size: 818
2975                       relationships:
2976                         variant:
2977                           data:
2978                             id: '94'
2979                             type: variant
2980               schema:
2981                 "$ref": "#/components/schemas/resource"
2982         '422':
2983           description: Invalid request
2984           content:
2985             application/vnd.api+json:
2986               examples:
2987                 Example:
2988                   value:
2989                     error: Attachment can't be blank and Variant can't be blank
2990                     errors:
2991                       attachment:
2992                       - can't be blank
2993                       variant:
2994                       - can't be blank
2995               schema:
2996                 "$ref": "#/components/schemas/validation_errors"
2997       requestBody:
2998         content:
2999           multipart/form-data:
3000             schema:
3001               "$ref": "#/components/schemas/create_digital_params"
3002   "/api/v2/platform/digitals/{id}":
3003     get:
3004       summary: Return a Digital Asset
3005       tags:
3006       - Digital Assets
3007       security:
3008       - bearer_auth: []
3009       description: Returns a Digital Asset
3010       operationId: show-digital
3011       parameters:
3012       - name: id
3013         in: path
3014         required: true
3015         schema:
3016           type: string
3017       - name: include
3018         in: query
3019         description: 'Select which associated resources you would like to fetch, see:
3020           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
3021         example: variant
3022         schema:
3023           type: string
3024       responses:
3025         '200':
3026           description: Record found
3027           content:
3028             application/vnd.api+json:
3029               examples:
3030                 Example:
3031                   value:
3032                     data:
3033                       id: '28'
3034                       type: digital
3035                       attributes:
3036                         url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBMUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--0b80fde2e739c30ef5390b1ca35d677810a2d02c/thinking-cat.jpg"
3037                         content_type: image/jpeg
3038                         filename: thinking-cat.jpg
3039                         byte_size: 18090
3040                       relationships:
3041                         variant:
3042                           data:
3043                             id: '112'
3044                             type: variant
3045               schema:
3046                 "$ref": "#/components/schemas/resource"
3047         '404':
3048           description: Record not found
3049           content:
3050             application/vnd.api+json:
3051               examples:
3052                 Example:
3053                   value:
3054                     error: The resource you were looking for could not be found.
3055               schema:
3056                 "$ref": "#/components/schemas/error"
3057         '401':
3058           description: Authentication Failed
3059           content:
3060             application/vnd.api+json:
3061               examples:
3062                 Example:
3063                   value:
3064                     error: The access token is invalid
3065               schema:
3066                 "$ref": "#/components/schemas/error"
3067     patch:
3068       summary: Update a Digital Asset
3069       tags:
3070       - Digital Assets
3071       security:
3072       - bearer_auth: []
3073       description: Updates a Digital Asset
3074       operationId: update-digital
3075       parameters:
3076       - name: id
3077         in: path
3078         required: true
3079         schema:
3080           type: string
3081       - name: include
3082         in: query
3083         description: 'Select which associated resources you would like to fetch, see:
3084           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
3085         example: variant
3086         schema:
3087           type: string
3088       responses:
3089         '200':
3090           description: Record updated
3091           content:
3092             application/vnd.api+json:
3093               examples:
3094                 Example:
3095                   value:
3096                     data:
3097                       id: '36'
3098                       type: digital
3099                       attributes:
3100                         url: "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBPQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--f87d494de28c18444adcd95623dbd33fd728c466/icon_256x256.jpg"
3101                         content_type: image/png
3102                         filename: icon_256x256.jpg
3103                         byte_size: 818
3104                       relationships:
3105                         variant:
3106                           data:
3107                             id: '134'
3108                             type: variant
3109               schema:
3110                 "$ref": "#/components/schemas/resource"
3111         '422':
3112           description: Invalid request
3113           content:
3114             application/vnd.api+json:
3115               examples:
3116                 Example:
3117                   value:
3118                     error: Variant can't be blank
3119                     errors:
3120                       variant:
3121                       - can't be blank
3122               schema:
3123                 "$ref": "#/components/schemas/validation_errors"
3124         '404':
3125           description: Record not found
3126           content:
3127             application/vnd.api+json:
3128               examples:
3129                 Example:
3130                   value:
3131                     error: The resource you were looking for could not be found.
3132               schema:
3133                 "$ref": "#/components/schemas/error"
3134         '401':
3135           description: Authentication Failed
3136           content:
3137             application/vnd.api+json:
3138               examples:
3139                 Example:
3140                   value:
3141                     error: The access token is invalid
3142               schema:
3143                 "$ref": "#/components/schemas/error"
3144       requestBody:
3145         content:
3146           multipart/form-data:
3147             schema:
3148               "$ref": "#/components/schemas/update_digital_params"
3149     delete:
3150       summary: Delete a Digital Asset
3151       tags:
3152       - Digital Assets
3153       security:
3154       - bearer_auth: []
3155       description: Deletes a Digital Asset
3156       operationId: delete-digital
3157       parameters:
3158       - name: id
3159         in: path
3160         required: true
3161         schema:
3162           type: string
3163       responses:
3164         '204':
3165           description: Record deleted
3166         '404':
3167           description: Record not found
3168           content:
3169             application/vnd.api+json:
3170               examples:
3171                 Example:
3172                   value:
3173                     error: The resource you were looking for could not be found.
3174               schema:
3175                 "$ref": "#/components/schemas/error"
3176         '401':
3177           description: Authentication Failed
3178           content:
3179             application/vnd.api+json:
3180               examples:
3181                 Example:
3182                   value:
3183                     error: The access token is invalid
3184               schema:
3185                 "$ref": "#/components/schemas/error"
3186   "/api/v2/platform/line_items":
3187     get:
3188       summary: Return a list of Line Items
3189       tags:
3190       - Line Items
3191       security:
3192       - bearer_auth: []
3193       description: Returns a list of Line Items
3194       operationId: line-items-list
3195       parameters:
3196       - name: page
3197         in: query
3198         example: 1
3199         schema:
3200           type: integer
3201       - name: per_page
3202         in: query
3203         example: 50
3204         schema:
3205           type: integer
3206       - name: include
3207         in: query
3208         description: 'Select which associated resources you would like to fetch, see:
3209           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
3210         example: order,tax_category,variant.product,digital_links
3211         schema:
3212           type: string
3213       - name: filter[order_id_eq]
3214         in: query
3215         description: ''
3216         example: '123'
3217         schema:
3218           type: string
3219       responses:
3220         '200':
3221           description: Records returned
3222           content:
3223             application/vnd.api+json:
3224               examples:
3225                 Example:
3226                   value:
3227                     data:
3228                     - id: '23'
3229                       type: line_item
3230                       attributes:
3231                         quantity: 1
3232                         price: '10.0'
3233                         created_at: '2022-11-08T19:34:19.541Z'
3234                         updated_at: '2022-11-08T19:34:19.550Z'
3235                         currency: USD
3236                         cost_price: '17.0'
3237                         adjustment_total: '0.0'
3238                         additional_tax_total: '0.0'
3239                         promo_total: '0.0'
3240                         included_tax_total: '0.0'
3241                         pre_tax_amount: '10.0'
3242                         taxable_adjustment_total: '0.0'
3243                         non_taxable_adjustment_total: '0.0'
3244                         public_metadata: {}
3245                         private_metadata: {}
3246                         display_discounted_amount: "$10.00"
3247                         display_amount: "$10.00"
3248                         display_final_amount: "$10.00"
3249                         display_subtotal: "$10.00"
3250                         display_pre_tax_amount: "$10.00"
3251                         display_price: "$10.00"
3252                         display_adjustment_total: "$0.00"
3253                         display_additional_tax_total: "$0.00"
3254                         display_promo_total: "$0.00"
3255                         display_total: "$10.00"
3256                         display_included_tax_total: "$0.00"
3257                       relationships:
3258                         order:
3259                           data:
3260                             id: '29'
3261                             type: order
3262                         tax_category:
3263                           data:
3264                             id: '70'
3265                             type: tax_category
3266                         variant:
3267                           data:
3268                             id: '183'
3269                             type: variant
3270                         adjustments:
3271                           data: []
3272                         inventory_units:
3273                           data: []
3274                         digital_links:
3275                           data: []
3276                     - id: '24'
3277                       type: line_item
3278                       attributes:
3279                         quantity: 1
3280                         price: '10.0'
3281                         created_at: '2022-11-08T19:34:19.584Z'
3282                         updated_at: '2022-11-08T19:34:19.590Z'
3283                         currency: USD
3284                         cost_price: '17.0'
3285                         adjustment_total: '0.0'
3286                         additional_tax_total: '0.0'
3287                         promo_total: '0.0'
3288                         included_tax_total: '0.0'
3289                         pre_tax_amount: '10.0'
3290                         taxable_adjustment_total: '0.0'
3291                         non_taxable_adjustment_total: '0.0'
3292                         public_metadata: {}
3293                         private_metadata: {}
3294                         display_discounted_amount: "$10.00"
3295                         display_amount: "$10.00"
3296                         display_final_amount: "$10.00"
3297                         display_subtotal: "$10.00"
3298                         display_pre_tax_amount: "$10.00"
3299                         display_price: "$10.00"
3300                         display_adjustment_total: "$0.00"
3301                         display_additional_tax_total: "$0.00"
3302                         display_promo_total: "$0.00"
3303                         display_total: "$10.00"
3304                         display_included_tax_total: "$0.00"
3305                       relationships:
3306                         order:
3307                           data:
3308                             id: '29'
3309                             type: order
3310                         tax_category:
3311                           data:
3312                             id: '70'
3313                             type: tax_category
3314                         variant:
3315                           data:
3316                             id: '184'
3317                             type: variant
3318                         adjustments:
3319                           data: []
3320                         inventory_units:
3321                           data: []
3322                         digital_links:
3323                           data: []
3324                     meta:
3325                       count: 2
3326                       total_count: 2
3327                       total_pages: 1
3328                     links:
3329                       self: http://www.example.com/api/v2/platform/line_items?page=1&per_page=&include=&filter[order_id_eq]=
3330                       next: http://www.example.com/api/v2/platform/line_items?filter%5Border_id_eq%5D=&include=&page=1&per_page=
3331                       prev: http://www.example.com/api/v2/platform/line_items?filter%5Border_id_eq%5D=&include=&page=1&per_page=
3332                       last: http://www.example.com/api/v2/platform/line_items?filter%5Border_id_eq%5D=&include=&page=1&per_page=
3333                       first: http://www.example.com/api/v2/platform/line_items?filter%5Border_id_eq%5D=&include=&page=1&per_page=
3334               schema:
3335                 "$ref": "#/components/schemas/resources_list"
3336         '401':
3337           description: Authentication Failed
3338           content:
3339             application/vnd.api+json:
3340               examples:
3341                 Example:
3342                   value:
3343                     error: The access token is invalid
3344               schema:
3345                 "$ref": "#/components/schemas/error"
3346     post:
3347       summary: Create a Line Item
3348       tags:
3349       - Line Items
3350       security:
3351       - bearer_auth: []
3352       description: Creates a Line Item
3353       operationId: create-line-item
3354       parameters:
3355       - name: include
3356         in: query
3357         description: 'Select which associated resources you would like to fetch, see:
3358           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
3359         example: order,tax_category,variant.product,digital_links
3360         schema:
3361           type: string
3362       responses:
3363         '201':
3364           description: Record created
3365           content:
3366             application/vnd.api+json:
3367               examples:
3368                 Example:
3369                   value:
3370                     data:
3371                       id: '27'
3372                       type: line_item
3373                       attributes:
3374                         quantity: 1
3375                         price: '10.0'
3376                         created_at: '2022-11-08T19:34:20.312Z'
3377                         updated_at: '2022-11-08T19:34:20.352Z'
3378                         currency: USD
3379                         cost_price: '17.0'
3380                         adjustment_total: '0.0'
3381                         additional_tax_total: '0.0'
3382                         promo_total: '0.0'
3383                         included_tax_total: '0.0'
3384                         pre_tax_amount: '10.0'
3385                         taxable_adjustment_total: '0.0'
3386                         non_taxable_adjustment_total: '0.0'
3387                         public_metadata: {}
3388                         private_metadata: {}
3389                         display_discounted_amount: "$10.00"
3390                         display_amount: "$10.00"
3391                         display_final_amount: "$10.00"
3392                         display_subtotal: "$10.00"
3393                         display_pre_tax_amount: "$10.00"
3394                         display_price: "$10.00"
3395                         display_adjustment_total: "$0.00"
3396                         display_additional_tax_total: "$0.00"
3397                         display_promo_total: "$0.00"
3398                         display_total: "$10.00"
3399                         display_included_tax_total: "$0.00"
3400                       relationships:
3401                         order:
3402                           data:
3403                             id: '31'
3404                             type: order
3405                         tax_category:
3406                           data:
3407                             id: '72'
3408                             type: tax_category
3409                         variant:
3410                           data:
3411                             id: '187'
3412                             type: variant
3413                         adjustments:
3414                           data: []
3415                         inventory_units:
3416                           data: []
3417                         digital_links:
3418                           data: []
3419               schema:
3420                 "$ref": "#/components/schemas/resource"
3421         '422':
3422           description: Invalid request
3423           content:
3424             application/vnd.api+json:
3425               examples:
3426                 Example:
3427                   value:
3428                     error: Variant can't be blank, Price is not a number, Currency
3429                       Must match order currency
3430                     errors:
3431                       variant:
3432                       - can't be blank
3433                       price:
3434                       - is not a number
3435                       currency:
3436                       - Must match order currency
3437               schema:
3438                 "$ref": "#/components/schemas/validation_errors"
3439       requestBody:
3440         content:
3441           application/json:
3442             schema:
3443               "$ref": "#/components/schemas/create_line_item_params"
3444   "/api/v2/platform/line_items/{id}":
3445     get:
3446       summary: Return a Line Item
3447       tags:
3448       - Line Items
3449       security:
3450       - bearer_auth: []
3451       description: Returns a Line Item
3452       operationId: show-line-item
3453       parameters:
3454       - name: id
3455         in: path
3456         required: true
3457         schema:
3458           type: string
3459       - name: include
3460         in: query
3461         description: 'Select which associated resources you would like to fetch, see:
3462           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
3463         example: order,tax_category,variant.product,digital_links
3464         schema:
3465           type: string
3466       responses:
3467         '200':
3468           description: Record found
3469           content:
3470             application/vnd.api+json:
3471               examples:
3472                 Example:
3473                   value:
3474                     data:
3475                       id: '28'
3476                       type: line_item
3477                       attributes:
3478                         quantity: 1
3479                         price: '10.0'
3480                         created_at: '2022-11-08T19:34:20.761Z'
3481                         updated_at: '2022-11-08T19:34:20.769Z'
3482                         currency: USD
3483                         cost_price: '17.0'
3484                         adjustment_total: '0.0'
3485                         additional_tax_total: '0.0'
3486                         promo_total: '0.0'
3487                         included_tax_total: '0.0'
3488                         pre_tax_amount: '10.0'
3489                         taxable_adjustment_total: '0.0'
3490                         non_taxable_adjustment_total: '0.0'
3491                         public_metadata: {}
3492                         private_metadata: {}
3493                         display_discounted_amount: "$10.00"
3494                         display_amount: "$10.00"
3495                         display_final_amount: "$10.00"
3496                         display_subtotal: "$10.00"
3497                         display_pre_tax_amount: "$10.00"
3498                         display_price: "$10.00"
3499                         display_adjustment_total: "$0.00"
3500                         display_additional_tax_total: "$0.00"
3501                         display_promo_total: "$0.00"
3502                         display_total: "$10.00"
3503                         display_included_tax_total: "$0.00"
3504                       relationships:
3505                         order:
3506                           data:
3507                             id: '33'
3508                             type: order
3509                         tax_category:
3510                           data:
3511                             id: '73'
3512                             type: tax_category
3513                         variant:
3514                           data:
3515                             id: '188'
3516                             type: variant
3517                         adjustments:
3518                           data: []
3519                         inventory_units:
3520                           data: []
3521                         digital_links:
3522                           data: []
3523               schema:
3524                 "$ref": "#/components/schemas/resource"
3525         '404':
3526           description: Record not found
3527           content:
3528             application/vnd.api+json:
3529               examples:
3530                 Example:
3531                   value:
3532                     error: The resource you were looking for could not be found.
3533               schema:
3534                 "$ref": "#/components/schemas/error"
3535         '401':
3536           description: Authentication Failed
3537           content:
3538             application/vnd.api+json:
3539               examples:
3540                 Example:
3541                   value:
3542                     error: The access token is invalid
3543               schema:
3544                 "$ref": "#/components/schemas/error"
3545     patch:
3546       summary: Update a Line Item
3547       tags:
3548       - Line Items
3549       security:
3550       - bearer_auth: []
3551       description: Updates a Line Item
3552       operationId: update-line-item
3553       parameters:
3554       - name: id
3555         in: path
3556         required: true
3557         schema:
3558           type: string
3559       - name: include
3560         in: query
3561         description: 'Select which associated resources you would like to fetch, see:
3562           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
3563         example: order,tax_category,variant.product,digital_links
3564         schema:
3565           type: string
3566       responses:
3567         '200':
3568           description: Record updated
3569           content:
3570             application/vnd.api+json:
3571               examples:
3572                 Example:
3573                   value:
3574                     data:
3575                       id: '30'
3576                       type: line_item
3577                       attributes:
3578                         quantity: 4
3579                         price: '10.0'
3580                         created_at: '2022-11-08T19:34:21.508Z'
3581                         updated_at: '2022-11-08T19:34:21.772Z'
3582                         currency: USD
3583                         cost_price: '17.0'
3584                         adjustment_total: '0.0'
3585                         additional_tax_total: '0.0'
3586                         promo_total: '0.0'
3587                         included_tax_total: '0.0'
3588                         pre_tax_amount: '40.0'
3589                         taxable_adjustment_total: '0.0'
3590                         non_taxable_adjustment_total: '0.0'
3591                         public_metadata: {}
3592                         private_metadata: {}
3593                         display_discounted_amount: "$40.00"
3594                         display_amount: "$40.00"
3595                         display_final_amount: "$40.00"
3596                         display_subtotal: "$40.00"
3597                         display_pre_tax_amount: "$40.00"
3598                         display_price: "$10.00"
3599                         display_adjustment_total: "$0.00"
3600                         display_additional_tax_total: "$0.00"
3601                         display_promo_total: "$0.00"
3602                         display_total: "$40.00"
3603                         display_included_tax_total: "$0.00"
3604                       relationships:
3605                         order:
3606                           data:
3607                             id: '35'
3608                             type: order
3609                         tax_category:
3610                           data:
3611                             id: '75'
3612                             type: tax_category
3613                         variant:
3614                           data:
3615                             id: '192'
3616                             type: variant
3617                         adjustments:
3618                           data: []
3619                         inventory_units:
3620                           data: []
3621                         digital_links:
3622                           data: []
3623               schema:
3624                 "$ref": "#/components/schemas/resource"
3625         '422':
3626           description: Invalid request
3627           content:
3628             application/vnd.api+json:
3629               examples:
3630                 Example:
3631                   value:
3632                     error: Quantity selected of "Product 1275645" is not available.
3633                     errors:
3634                       quantity:
3635                       - selected of "Product 1275645" is not available.
3636               schema:
3637                 "$ref": "#/components/schemas/validation_errors"
3638         '404':
3639           description: Record not found
3640           content:
3641             application/vnd.api+json:
3642               examples:
3643                 Example:
3644                   value:
3645                     error: The resource you were looking for could not be found.
3646               schema:
3647                 "$ref": "#/components/schemas/error"
3648         '401':
3649           description: Authentication Failed
3650           content:
3651             application/vnd.api+json:
3652               examples:
3653                 Example:
3654                   value:
3655                     error: The access token is invalid
3656               schema:
3657                 "$ref": "#/components/schemas/error"
3658       requestBody:
3659         content:
3660           application/json:
3661             schema:
3662               "$ref": "#/components/schemas/update_line_item_params"
3663     delete:
3664       summary: Delete a Line Item
3665       tags:
3666       - Line Items
3667       security:
3668       - bearer_auth: []
3669       description: Deletes a Line Item
3670       operationId: delete-line-item
3671       parameters:
3672       - name: id
3673         in: path
3674         required: true
3675         schema:
3676           type: string
3677       responses:
3678         '204':
3679           description: Record deleted
3680         '404':
3681           description: Record not found
3682           content:
3683             application/vnd.api+json:
3684               examples:
3685                 Example:
3686                   value:
3687                     error: The resource you were looking for could not be found.
3688               schema:
3689                 "$ref": "#/components/schemas/error"
3690         '401':
3691           description: Authentication Failed
3692           content:
3693             application/vnd.api+json:
3694               examples:
3695                 Example:
3696                   value:
3697                     error: The access token is invalid
3698               schema:
3699                 "$ref": "#/components/schemas/error"
3700   "/api/v2/platform/menu_items":
3701     get:
3702       summary: Return a list of Menu Items
3703       tags:
3704       - Menu Items
3705       security:
3706       - bearer_auth: []
3707       description: Returns a list of Menu Items
3708       operationId: menu-items-list
3709       parameters:
3710       - name: page
3711         in: query
3712         example: 1
3713         schema:
3714           type: integer
3715       - name: per_page
3716         in: query
3717         example: 50
3718         schema:
3719           type: integer
3720       - name: include
3721         in: query
3722         description: 'Select which associated resources you would like to fetch, see:
3723           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
3724         example: menu,icon,parent,children,linked_resource
3725         schema:
3726           type: string
3727       - name: filter[name_eq]
3728         in: query
3729         description: ''
3730         example: T-Shirts
3731         schema:
3732           type: string
3733       responses:
3734         '200':
3735           description: Records returned
3736           content:
3737             application/vnd.api+json:
3738               examples:
3739                 Example:
3740                   value:
3741                     data:
3742                     - id: '2'
3743                       type: menu_item
3744                       attributes:
3745                         name: Link no. 1 To Somewhere
3746                         subtitle:
3747                         destination:
3748                         new_window: false
3749                         item_type: Link
3750                         linked_resource_type: Spree::Linkable::Uri
3751                         code:
3752                         lft: 2
3753                         rgt: 3
3754                         depth: 1
3755                         created_at: '2022-11-08T19:34:23.401Z'
3756                         updated_at: '2022-11-08T19:34:23.404Z'
3757                         link:
3758                         is_container: false
3759                         is_root: false
3760                         is_child: true
3761                         is_leaf: true
3762                       relationships:
3763                         icon:
3764                           data:
3765                             id: '13'
3766                             type: icon
3767                         menu:
3768                           data:
3769                             id: '1'
3770                             type: menu
3771                         parent:
3772                           data:
3773                             id: '1'
3774                             type: menu_item
3775                         linked_resource:
3776                           data:
3777                         children:
3778                           data: []
3779                     - id: '3'
3780                       type: menu_item
3781                       attributes:
3782                         name: Link no. 2 To Somewhere
3783                         subtitle:
3784                         destination:
3785                         new_window: false
3786                         item_type: Link
3787                         linked_resource_type: Spree::Linkable::Uri
3788                         code:
3789                         lft: 4
3790                         rgt: 5
3791                         depth: 1
3792                         created_at: '2022-11-08T19:34:23.425Z'
3793                         updated_at: '2022-11-08T19:34:23.428Z'
3794                         link:
3795                         is_container: false
3796                         is_root: false
3797                         is_child: true
3798                         is_leaf: true
3799                       relationships:
3800                         icon:
3801                           data:
3802                             id: '14'
3803                             type: icon
3804                         menu:
3805                           data:
3806                             id: '1'
3807                             type: menu
3808                         parent:
3809                           data:
3810                             id: '1'
3811                             type: menu_item
3812                         linked_resource:
3813                           data:
3814                         children:
3815                           data: []
3816                     - id: '4'
3817                       type: menu_item
3818                       attributes:
3819                         name: Link no. 3 To Somewhere
3820                         subtitle:
3821                         destination:
3822                         new_window: false
3823                         item_type: Link
3824                         linked_resource_type: Spree::Linkable::Uri
3825                         code:
3826                         lft: 6
3827                         rgt: 7
3828                         depth: 1
3829                         created_at: '2022-11-08T19:34:23.446Z'
3830                         updated_at: '2022-11-08T19:34:23.449Z'
3831                         link:
3832                         is_container: false
3833                         is_root: false
3834                         is_child: true
3835                         is_leaf: true
3836                       relationships:
3837                         icon:
3838                           data:
3839                             id: '15'
3840                             type: icon
3841                         menu:
3842                           data:
3843                             id: '1'
3844                             type: menu
3845                         parent:
3846                           data:
3847                             id: '1'
3848                             type: menu_item
3849                         linked_resource:
3850                           data:
3851                         children:
3852                           data: []
3853                     - id: '5'
3854                       type: menu_item
3855                       attributes:
3856                         name: Link no. 4 To Somewhere
3857                         subtitle:
3858                         destination:
3859                         new_window: false
3860                         item_type: Link
3861                         linked_resource_type: Spree::Linkable::Uri
3862                         code:
3863                         lft: 8
3864                         rgt: 9
3865                         depth: 1
3866                         created_at: '2022-11-08T19:34:23.468Z'
3867                         updated_at: '2022-11-08T19:34:23.471Z'
3868                         link:
3869                         is_container: false
3870                         is_root: false
3871                         is_child: true
3872                         is_leaf: true
3873                       relationships:
3874                         icon:
3875                           data:
3876                             id: '16'
3877                             type: icon
3878                         menu:
3879                           data:
3880                             id: '1'
3881                             type: menu
3882                         parent:
3883                           data:
3884                             id: '1'
3885                             type: menu_item
3886                         linked_resource:
3887                           data:
3888                         children:
3889                           data: []
3890                     - id: '6'
3891                       type: menu_item
3892                       attributes:
3893                         name: Link no. 5 To Somewhere
3894                         subtitle:
3895                         destination:
3896                         new_window: false
3897                         item_type: Link
3898                         linked_resource_type: Spree::Linkable::Uri
3899                         code:
3900                         lft: 10
3901                         rgt: 11
3902                         depth: 1
3903                         created_at: '2022-11-08T19:34:23.491Z'
3904                         updated_at: '2022-11-08T19:34:23.494Z'
3905                         link:
3906                         is_container: false
3907                         is_root: false
3908                         is_child: true
3909                         is_leaf: true
3910                       relationships:
3911                         icon:
3912                           data:
3913                             id: '17'
3914                             type: icon
3915                         menu:
3916                           data:
3917                             id: '1'
3918                             type: menu
3919                         parent:
3920                           data:
3921                             id: '1'
3922                             type: menu_item
3923                         linked_resource:
3924                           data:
3925                         children:
3926                           data: []
3927                     - id: '7'
3928                       type: menu_item
3929                       attributes:
3930                         name: Link no. 6 To Somewhere
3931                         subtitle:
3932                         destination:
3933                         new_window: false
3934                         item_type: Link
3935                         linked_resource_type: Spree::Linkable::Uri
3936                         code:
3937                         lft: 12
3938                         rgt: 13
3939                         depth: 1
3940                         created_at: '2022-11-08T19:34:23.515Z'
3941                         updated_at: '2022-11-08T19:34:23.518Z'
3942                         link:
3943                         is_container: false
3944                         is_root: false
3945                         is_child: true
3946                         is_leaf: true
3947                       relationships:
3948                         icon:
3949                           data:
3950                             id: '18'
3951                             type: icon
3952                         menu:
3953                           data:
3954                             id: '1'
3955                             type: menu
3956                         parent:
3957                           data:
3958                             id: '1'
3959                             type: menu_item
3960                         linked_resource:
3961                           data:
3962                         children:
3963                           data: []
3964                     - id: '8'
3965                       type: menu_item
3966                       attributes:
3967                         name: Link no. 7 To Somewhere
3968                         subtitle:
3969                         destination:
3970                         new_window: false
3971                         item_type: Link
3972                         linked_resource_type: Spree::Linkable::Uri
3973                         code:
3974                         lft: 14
3975                         rgt: 15
3976                         depth: 1
3977                         created_at: '2022-11-08T19:34:23.535Z'
3978                         updated_at: '2022-11-08T19:34:23.537Z'
3979                         link:
3980                         is_container: false
3981                         is_root: false
3982                         is_child: true
3983                         is_leaf: true
3984                       relationships:
3985                         icon:
3986                           data:
3987                             id: '19'
3988                             type: icon
3989                         menu:
3990                           data:
3991                             id: '1'
3992                             type: menu
3993                         parent:
3994                           data:
3995                             id: '1'
3996                             type: menu_item
3997                         linked_resource:
3998                           data:
3999                         children:
4000                           data: []
4001                     - id: '1'
4002                       type: menu_item
4003                       attributes:
4004                         name: Neque a rem deserunt beatae.
4005                         subtitle:
4006                         destination:
4007                         new_window: false
4008                         item_type: Container
4009                         linked_resource_type: Spree::Linkable::Uri
4010                         code:
4011                         lft: 1
4012                         rgt: 16
4013                         depth: 0
4014                         created_at: '2022-11-08T19:34:23.379Z'
4015                         updated_at: '2022-11-08T19:34:23.545Z'
4016                         link:
4017                         is_container: true
4018                         is_root: true
4019                         is_child: false
4020                         is_leaf: false
4021                       relationships:
4022                         icon:
4023                           data:
4024                         menu:
4025                           data:
4026                             id: '1'
4027                             type: menu
4028                         parent:
4029                           data:
4030                         linked_resource:
4031                           data:
4032                         children:
4033                           data:
4034                           - id: '2'
4035                             type: menu_item
4036                           - id: '3'
4037                             type: menu_item
4038                           - id: '4'
4039                             type: menu_item
4040                           - id: '5'
4041                             type: menu_item
4042                           - id: '6'
4043                             type: menu_item
4044                           - id: '7'
4045                             type: menu_item
4046                           - id: '8'
4047                             type: menu_item
4048                     meta:
4049                       count: 8
4050                       total_count: 8
4051                       total_pages: 1
4052                     links:
4053                       self: http://www.example.com/api/v2/platform/menu_items?page=1&per_page=&include=&filter[name_eq]=
4054                       next: http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=
4055                       prev: http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=
4056                       last: http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=
4057                       first: http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=
4058               schema:
4059                 "$ref": "#/components/schemas/resources_list"
4060         '401':
4061           description: Authentication Failed
4062           content:
4063             application/vnd.api+json:
4064               examples:
4065                 Example:
4066                   value:
4067                     error: The access token is invalid
4068               schema:
4069                 "$ref": "#/components/schemas/error"
4070     post:
4071       summary: Create a Menu Item
4072       tags:
4073       - Menu Items
4074       security:
4075       - bearer_auth: []
4076       description: Creates a Menu Item
4077       operationId: create-menu-item
4078       parameters:
4079       - name: include
4080         in: query
4081         description: 'Select which associated resources you would like to fetch, see:
4082           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
4083         example: menu,icon,parent,children,linked_resource
4084         schema:
4085           type: string
4086       responses:
4087         '201':
4088           description: Record created
4089           content:
4090             application/vnd.api+json:
4091               examples:
4092                 Example:
4093                   value:
4094                     data:
4095                       id: '21'
4096                       type: menu_item
4097                       attributes:
4098                         name: Link no. 18 To Somewhere
4099                         subtitle:
4100                         destination:
4101                         new_window: false
4102                         item_type: Link
4103                         linked_resource_type: Spree::Linkable::Uri
4104                         code:
4105                         lft: 8
4106                         rgt: 9
4107                         depth: 1
4108                         created_at: '2022-11-08T19:34:24.333Z'
4109                         updated_at: '2022-11-08T19:34:24.336Z'
4110                         link:
4111                         is_container: false
4112                         is_root: false
4113                         is_child: true
4114                         is_leaf: true
4115                       relationships:
4116                         icon:
4117                           data:
4118                         menu:
4119                           data:
4120                             id: '3'
4121                             type: menu
4122                         parent:
4123                           data:
4124                             id: '17'
4125                             type: menu_item
4126                         linked_resource:
4127                           data:
4128                         children:
4129                           data: []
4130               schema:
4131                 "$ref": "#/components/schemas/resource"
4132         '422':
4133           description: Invalid request
4134           content:
4135             application/vnd.api+json:
4136               examples:
4137                 Example:
4138                   value:
4139                     error: Name can't be blank, Menu can't be blank, and Item type
4140                       is not included in the list
4141                     errors:
4142                       name:
4143                       - can't be blank
4144                       menu:
4145                       - can't be blank
4146                       item_type:
4147                       - is not included in the list
4148               schema:
4149                 "$ref": "#/components/schemas/validation_errors"
4150       requestBody:
4151         content:
4152           application/json:
4153             schema:
4154               "$ref": "#/components/schemas/create_menu_item_params"
4155   "/api/v2/platform/menu_items/{id}":
4156     get:
4157       summary: Return a Menu Item
4158       tags:
4159       - Menu Items
4160       security:
4161       - bearer_auth: []
4162       description: Returns a Menu Item
4163       operationId: show-menu-item
4164       parameters:
4165       - name: id
4166         in: path
4167         required: true
4168         schema:
4169           type: string
4170       - name: include
4171         in: query
4172         description: 'Select which associated resources you would like to fetch, see:
4173           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
4174         example: menu,icon,parent,children,linked_resource
4175         schema:
4176           type: string
4177       responses:
4178         '200':
4179           description: Record found
4180           content:
4181             application/vnd.api+json:
4182               examples:
4183                 Example:
4184                   value:
4185                     data:
4186                       id: '30'
4187                       type: menu_item
4188                       attributes:
4189                         name: Link no. 25 To Somewhere
4190                         subtitle:
4191                         destination:
4192                         new_window: false
4193                         item_type: Link
4194                         linked_resource_type: Spree::Linkable::Uri
4195                         code:
4196                         lft: 8
4197                         rgt: 9
4198                         depth: 1
4199                         created_at: '2022-11-08T19:34:24.785Z'
4200                         updated_at: '2022-11-08T19:34:24.788Z'
4201                         link:
4202                         is_container: false
4203                         is_root: false
4204                         is_child: true
4205                         is_leaf: true
4206                       relationships:
4207                         icon:
4208                           data:
4209                             id: '36'
4210                             type: icon
4211                         menu:
4212                           data:
4213                             id: '5'
4214                             type: menu
4215                         parent:
4216                           data:
4217                             id: '26'
4218                             type: menu_item
4219                         linked_resource:
4220                           data:
4221                         children:
4222                           data: []
4223               schema:
4224                 "$ref": "#/components/schemas/resource"
4225         '404':
4226           description: Record not found
4227           content:
4228             application/vnd.api+json:
4229               examples:
4230                 Example:
4231                   value:
4232                     error: The resource you were looking for could not be found.
4233               schema:
4234                 "$ref": "#/components/schemas/error"
4235         '401':
4236           description: Authentication Failed
4237           content:
4238             application/vnd.api+json:
4239               examples:
4240                 Example:
4241                   value:
4242                     error: The access token is invalid
4243               schema:
4244                 "$ref": "#/components/schemas/error"
4245     patch:
4246       summary: Update a Menu Item
4247       tags:
4248       - Menu Items
4249       security:
4250       - bearer_auth: []
4251       description: Updates a Menu Item
4252       operationId: update-menu-item
4253       parameters:
4254       - name: id
4255         in: path
4256         required: true
4257         schema:
4258           type: string
4259       - name: include
4260         in: query
4261         description: 'Select which associated resources you would like to fetch, see:
4262           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
4263         example: menu,icon,parent,children,linked_resource
4264         schema:
4265           type: string
4266       responses:
4267         '200':
4268           description: Record updated
4269           content:
4270             application/vnd.api+json:
4271               examples:
4272                 Example:
4273                   value:
4274                     data:
4275                       id: '44'
4276                       type: menu_item
4277                       attributes:
4278                         name: Menu Item One
4279                         subtitle:
4280                         destination:
4281                         new_window: false
4282                         item_type: Link
4283                         linked_resource_type: Spree::Linkable::Uri
4284                         code:
4285                         lft: 8
4286                         rgt: 9
4287                         depth: 1
4288                         created_at: '2022-11-08T19:34:25.609Z'
4289                         updated_at: '2022-11-08T19:34:25.857Z'
4290                         link:
4291                         is_container: false
4292                         is_root: false
4293                         is_child: true
4294                         is_leaf: true
4295                       relationships:
4296                         icon:
4297                           data:
4298                             id: '47'
4299                             type: icon
4300                         menu:
4301                           data:
4302                             id: '8'
4303                             type: menu
4304                         parent:
4305                           data:
4306                             id: '40'
4307                             type: menu_item
4308                         linked_resource:
4309                           data:
4310                         children:
4311                           data: []
4312               schema:
4313                 "$ref": "#/components/schemas/resource"
4314         '422':
4315           description: Invalid request
4316           content:
4317             application/vnd.api+json:
4318               examples:
4319                 Example:
4320                   value:
4321                     error: Name can't be blank
4322                     errors:
4323                       name:
4324                       - can't be blank
4325               schema:
4326                 "$ref": "#/components/schemas/validation_errors"
4327         '404':
4328           description: Record not found
4329           content:
4330             application/vnd.api+json:
4331               examples:
4332                 Example:
4333                   value:
4334                     error: The resource you were looking for could not be found.
4335               schema:
4336                 "$ref": "#/components/schemas/error"
4337         '401':
4338           description: Authentication Failed
4339           content:
4340             application/vnd.api+json:
4341               examples:
4342                 Example:
4343                   value:
4344                     error: The access token is invalid
4345               schema:
4346                 "$ref": "#/components/schemas/error"
4347       requestBody:
4348         content:
4349           application/json:
4350             schema:
4351               "$ref": "#/components/schemas/update_menu_item_params"
4352     delete:
4353       summary: Delete a Menu Item
4354       tags:
4355       - Menu Items
4356       security:
4357       - bearer_auth: []
4358       description: Deletes a Menu Item
4359       operationId: delete-menu-item
4360       parameters:
4361       - name: id
4362         in: path
4363         required: true
4364         schema:
4365           type: string
4366       responses:
4367         '204':
4368           description: Record deleted
4369         '404':
4370           description: Record not found
4371           content:
4372             application/vnd.api+json:
4373               examples:
4374                 Example:
4375                   value:
4376                     error: The resource you were looking for could not be found.
4377               schema:
4378                 "$ref": "#/components/schemas/error"
4379         '401':
4380           description: Authentication Failed
4381           content:
4382             application/vnd.api+json:
4383               examples:
4384                 Example:
4385                   value:
4386                     error: The access token is invalid
4387               schema:
4388                 "$ref": "#/components/schemas/error"
4389   "/api/v2/platform/menu_items/{id}/reposition":
4390     patch:
4391       summary: Reposition a Menu Item
4392       tags:
4393       - Menu Items
4394       security:
4395       - bearer_auth: []
4396       operationId: reposition-menu-item
4397       description: Reposition a Menu Item
4398       parameters:
4399       - name: id
4400         in: path
4401         required: true
4402         schema:
4403           type: string
4404       responses:
4405         '200':
4406           description: Record updated
4407           content:
4408             application/vnd.api+json:
4409               examples:
4410                 Example:
4411                   value:
4412                     data:
4413                       id: '77'
4414                       type: menu_item
4415                       attributes:
4416                         name: Link no. 62 To Somewhere
4417                         subtitle:
4418                         destination:
4419                         new_window: false
4420                         item_type: Link
4421                         linked_resource_type: Spree::Linkable::Uri
4422                         code:
4423                         lft: 5
4424                         rgt: 6
4425                         depth: 2
4426                         created_at: '2022-11-08T19:34:27.610Z'
4427                         updated_at: '2022-11-08T19:34:27.858Z'
4428                         link:
4429                         is_container: false
4430                         is_root: false
4431                         is_child: true
4432                         is_leaf: true
4433                       relationships:
4434                         icon:
4435                           data:
4436                             id: '73'
4437                             type: icon
4438                         menu:
4439                           data:
4440                             id: '15'
4441                             type: menu
4442                         parent:
4443                           data:
4444                             id: '75'
4445                             type: menu_item
4446                         linked_resource:
4447                           data:
4448                         children:
4449                           data: []
4450               schema:
4451                 "$ref": "#/components/schemas/resource"
4452         '404':
4453           description: Record not found
4454           content:
4455             application/vnd.api+json:
4456               examples:
4457                 Example:
4458                   value:
4459                     error: The resource you were looking for could not be found.
4460               schema:
4461                 "$ref": "#/components/schemas/error"
4462         '401':
4463           description: Authentication Failed
4464           content:
4465             application/vnd.api+json:
4466               examples:
4467                 Example:
4468                   value:
4469                     error: The access token is invalid
4470               schema:
4471                 "$ref": "#/components/schemas/error"
4472       requestBody:
4473         content:
4474           application/json:
4475             schema:
4476               "$ref": "#/components/schemas/menu_item_reposition"
4477   "/api/v2/platform/menus":
4478     get:
4479       summary: Return a list of Menus
4480       tags:
4481       - Menus
4482       security:
4483       - bearer_auth: []
4484       description: Returns a list of Menus
4485       operationId: menus-list
4486       parameters:
4487       - name: page
4488         in: query
4489         example: 1
4490         schema:
4491           type: integer
4492       - name: per_page
4493         in: query
4494         example: 50
4495         schema:
4496           type: integer
4497       - name: include
4498         in: query
4499         description: 'Select which associated resources you would like to fetch, see:
4500           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
4501         example: menu_items
4502         schema:
4503           type: string
4504       - name: filter[name_eq]
4505         in: query
4506         description: ''
4507         example: Main Menu
4508         schema:
4509           type: string
4510       - name: filter[location_eq]
4511         in: query
4512         description: ''
4513         example: header
4514         schema:
4515           type: string
4516       responses:
4517         '200':
4518           description: Records returned
4519           content:
4520             application/vnd.api+json:
4521               examples:
4522                 Example:
4523                   value:
4524                     data:
4525                     - id: '18'
4526                       type: menu
4527                       attributes:
4528                         name: Main Menu
4529                         location: header
4530                         locale: en
4531                         created_at: '2022-11-08T19:34:28.349Z'
4532                         updated_at: '2022-11-08T19:34:28.398Z'
4533                       relationships:
4534                         menu_items:
4535                           data:
4536                           - id: '89'
4537                             type: menu_item
4538                           - id: '90'
4539                             type: menu_item
4540                           - id: '87'
4541                             type: menu_item
4542                     - id: '19'
4543                       type: menu
4544                       attributes:
4545                         name: Footer Menu
4546                         location: footer
4547                         locale: en
4548                         created_at: '2022-11-08T19:34:28.357Z'
4549                         updated_at: '2022-11-08T19:34:28.448Z'
4550                       relationships:
4551                         menu_items:
4552                           data:
4553                           - id: '91'
4554                             type: menu_item
4555                           - id: '92'
4556                             type: menu_item
4557                           - id: '88'
4558                             type: menu_item
4559                     meta:
4560                       count: 2
4561                       total_count: 2
4562                       total_pages: 1
4563                     links:
4564                       self: http://www.example.com/api/v2/platform/menus?page=1&per_page=&include=&filter[name_eq]=&filter[location_eq]=
4565                       next: http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=
4566                       prev: http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=
4567                       last: http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=
4568                       first: http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=
4569               schema:
4570                 "$ref": "#/components/schemas/resources_list"
4571         '401':
4572           description: Authentication Failed
4573           content:
4574             application/vnd.api+json:
4575               examples:
4576                 Example:
4577                   value:
4578                     error: The access token is invalid
4579               schema:
4580                 "$ref": "#/components/schemas/error"
4581     post:
4582       summary: Create a Menu
4583       tags:
4584       - Menus
4585       security:
4586       - bearer_auth: []
4587       description: Creates a Menu
4588       operationId: create-menu
4589       parameters:
4590       - name: include
4591         in: query
4592         description: 'Select which associated resources you would like to fetch, see:
4593           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
4594         example: menu_items
4595         schema:
4596           type: string
4597       responses:
4598         '201':
4599           description: Record created
4600           content:
4601             application/vnd.api+json:
4602               examples:
4603                 Example:
4604                   value:
4605                     data:
4606                       id: '22'
4607                       type: menu
4608                       attributes:
4609                         name: Main Menu
4610                         location: header
4611                         locale: en
4612                         created_at: '2022-11-08T19:34:29.089Z'
4613                         updated_at: '2022-11-08T19:34:29.097Z'
4614                       relationships:
4615                         menu_items:
4616                           data:
4617                           - id: '99'
4618                             type: menu_item
4619               schema:
4620                 "$ref": "#/components/schemas/resource"
4621         '422':
4622           description: Invalid request
4623           content:
4624             application/vnd.api+json:
4625               examples:
4626                 Example:
4627                   value:
4628                     error: Name can't be blank, Locale can't be blank, and Location
4629                       is not included in the list
4630                     errors:
4631                       name:
4632                       - can't be blank
4633                       locale:
4634                       - can't be blank
4635                       location:
4636                       - is not included in the list
4637               schema:
4638                 "$ref": "#/components/schemas/validation_errors"
4639       requestBody:
4640         content:
4641           application/json:
4642             schema:
4643               "$ref": "#/components/schemas/create_menu_params"
4644   "/api/v2/platform/menus/{id}":
4645     get:
4646       summary: Return a Menu
4647       tags:
4648       - Menus
4649       security:
4650       - bearer_auth: []
4651       description: Returns a Menu
4652       operationId: show-menu
4653       parameters:
4654       - name: id
4655         in: path
4656         required: true
4657         schema:
4658           type: string
4659       - name: include
4660         in: query
4661         description: 'Select which associated resources you would like to fetch, see:
4662           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
4663         example: menu_items
4664         schema:
4665           type: string
4666       responses:
4667         '200':
4668           description: Record found
4669           content:
4670             application/vnd.api+json:
4671               examples:
4672                 Example:
4673                   value:
4674                     data:
4675                       id: '23'
4676                       type: menu
4677                       attributes:
4678                         name: Main Menu
4679                         location: header
4680                         locale: en
4681                         created_at: '2022-11-08T19:34:29.371Z'
4682                         updated_at: '2022-11-08T19:34:29.376Z'
4683                       relationships:
4684                         menu_items:
4685                           data:
4686                           - id: '100'
4687                             type: menu_item
4688               schema:
4689                 "$ref": "#/components/schemas/resource"
4690         '404':
4691           description: Record not found
4692           content:
4693             application/vnd.api+json:
4694               examples:
4695                 Example:
4696                   value:
4697                     error: The resource you were looking for could not be found.
4698               schema:
4699                 "$ref": "#/components/schemas/error"
4700         '401':
4701           description: Authentication Failed
4702           content:
4703             application/vnd.api+json:
4704               examples:
4705                 Example:
4706                   value:
4707                     error: The access token is invalid
4708               schema:
4709                 "$ref": "#/components/schemas/error"
4710     patch:
4711       summary: Update a Menu
4712       tags:
4713       - Menus
4714       security:
4715       - bearer_auth: []
4716       description: Updates a Menu
4717       operationId: update-menu
4718       parameters:
4719       - name: id
4720         in: path
4721         required: true
4722         schema:
4723           type: string
4724       - name: include
4725         in: query
4726         description: 'Select which associated resources you would like to fetch, see:
4727           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
4728         example: menu_items
4729         schema:
4730           type: string
4731       responses:
4732         '200':
4733           description: Record updated
4734           content:
4735             application/vnd.api+json:
4736               examples:
4737                 Example:
4738                   value:
4739                     data:
4740                       id: '25'
4741                       type: menu
4742                       attributes:
4743                         name: Main Menu
4744                         location: header
4745                         locale: en
4746                         created_at: '2022-11-08T19:34:29.913Z'
4747                         updated_at: '2022-11-08T19:34:29.919Z'
4748                       relationships:
4749                         menu_items:
4750                           data:
4751                           - id: '102'
4752                             type: menu_item
4753               schema:
4754                 "$ref": "#/components/schemas/resource"
4755         '422':
4756           description: Invalid request
4757           content:
4758             application/vnd.api+json:
4759               examples:
4760                 Example:
4761                   value:
4762                     error: Name can't be blank, Locale can't be blank, and Location
4763                       is not included in the list
4764                     errors:
4765                       name:
4766                       - can't be blank
4767                       locale:
4768                       - can't be blank
4769                       location:
4770                       - is not included in the list
4771               schema:
4772                 "$ref": "#/components/schemas/validation_errors"
4773         '404':
4774           description: Record not found
4775           content:
4776             application/vnd.api+json:
4777               examples:
4778                 Example:
4779                   value:
4780                     error: The resource you were looking for could not be found.
4781               schema:
4782                 "$ref": "#/components/schemas/error"
4783         '401':
4784           description: Authentication Failed
4785           content:
4786             application/vnd.api+json:
4787               examples:
4788                 Example:
4789                   value:
4790                     error: The access token is invalid
4791               schema:
4792                 "$ref": "#/components/schemas/error"
4793       requestBody:
4794         content:
4795           application/json:
4796             schema:
4797               "$ref": "#/components/schemas/update_menu_params"
4798     delete:
4799       summary: Delete a Menu
4800       tags:
4801       - Menus
4802       security:
4803       - bearer_auth: []
4804       description: Deletes a Menu
4805       operationId: delete-menu
4806       parameters:
4807       - name: id
4808         in: path
4809         required: true
4810         schema:
4811           type: string
4812       responses:
4813         '204':
4814           description: Record deleted
4815         '404':
4816           description: Record not found
4817           content:
4818             application/vnd.api+json:
4819               examples:
4820                 Example:
4821                   value:
4822                     error: The resource you were looking for could not be found.
4823               schema:
4824                 "$ref": "#/components/schemas/error"
4825         '401':
4826           description: Authentication Failed
4827           content:
4828             application/vnd.api+json:
4829               examples:
4830                 Example:
4831                   value:
4832                     error: The access token is invalid
4833               schema:
4834                 "$ref": "#/components/schemas/error"
4835   "/api/v2/platform/option_types":
4836     get:
4837       summary: Return a list of Option Types
4838       tags:
4839       - Option Types
4840       security:
4841       - bearer_auth: []
4842       description: Returns a list of Option Types
4843       operationId: option-types-list
4844       parameters:
4845       - name: page
4846         in: query
4847         example: 1
4848         schema:
4849           type: integer
4850       - name: per_page
4851         in: query
4852         example: 50
4853         schema:
4854           type: integer
4855       - name: filter[option_type_id_eq]
4856         in: query
4857         description: ''
4858         example: '1'
4859         schema:
4860           type: string
4861       - name: filter[name_cont]
4862         in: query
4863         description: ''
4864         example: Size
4865         schema:
4866           type: string
4867       responses:
4868         '200':
4869           description: Records returned
4870           content:
4871             application/vnd.api+json:
4872               examples:
4873                 Example:
4874                   value:
4875                     data:
4876                     - id: '68'
4877                       type: option_type
4878                       attributes:
4879                         name: foo-size-68
4880                         presentation: Size
4881                         position: 1
4882                         created_at: '2022-11-08T19:34:31.242Z'
4883                         updated_at: '2022-11-08T19:34:31.242Z'
4884                         filterable: true
4885                         public_metadata: {}
4886                         private_metadata: {}
4887                       relationships:
4888                         option_values:
4889                           data: []
4890                     - id: '69'
4891                       type: option_type
4892                       attributes:
4893                         name: foo-size-69
4894                         presentation: Size
4895                         position: 2
4896                         created_at: '2022-11-08T19:34:31.244Z'
4897                         updated_at: '2022-11-08T19:34:31.244Z'
4898                         filterable: true
4899                         public_metadata: {}
4900                         private_metadata: {}
4901                       relationships:
4902                         option_values:
4903                           data: []
4904                     meta:
4905                       count: 2
4906                       total_count: 2
4907                       total_pages: 1
4908                     links:
4909                       self: http://www.example.com/api/v2/platform/option_types?page=1&per_page=&filter[option_type_id_eq]=&filter[name_cont]=
4910                       next: http://www.example.com/api/v2/platform/option_types?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&page=1&per_page=
4911                       prev: http://www.example.com/api/v2/platform/option_types?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&page=1&per_page=
4912                       last: http://www.example.com/api/v2/platform/option_types?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&page=1&per_page=
4913                       first: http://www.example.com/api/v2/platform/option_types?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&page=1&per_page=
4914               schema:
4915                 "$ref": "#/components/schemas/resources_list"
4916         '401':
4917           description: Authentication Failed
4918           content:
4919             application/vnd.api+json:
4920               examples:
4921                 Example:
4922                   value:
4923                     error: The access token is invalid
4924               schema:
4925                 "$ref": "#/components/schemas/error"
4926     post:
4927       summary: Create an Option Type
4928       tags:
4929       - Option Types
4930       security:
4931       - bearer_auth: []
4932       description: Creates an Option Type
4933       operationId: create-option-type
4934       parameters: []
4935       responses:
4936         '201':
4937           description: Record created
4938           content:
4939             application/vnd.api+json:
4940               examples:
4941                 Example:
4942                   value:
4943                     data:
4944                       id: '72'
4945                       type: option_type
4946                       attributes:
4947                         name: foo-size-72
4948                         presentation: Size
4949                         position: 1
4950                         created_at: '2022-11-08T19:34:31.761Z'
4951                         updated_at: '2022-11-08T19:34:31.761Z'
4952                         filterable: true
4953                         public_metadata: {}
4954                         private_metadata: {}
4955                       relationships:
4956                         option_values:
4957                           data: []
4958               schema:
4959                 "$ref": "#/components/schemas/resource"
4960         '422':
4961           description: Invalid request
4962           content:
4963             application/vnd.api+json:
4964               examples:
4965                 Example:
4966                   value:
4967                     error: Name can't be blank and Presentation can't be blank
4968                     errors:
4969                       name:
4970                       - can't be blank
4971                       presentation:
4972                       - can't be blank
4973               schema:
4974                 "$ref": "#/components/schemas/validation_errors"
4975       requestBody:
4976         content:
4977           application/json:
4978             schema:
4979               "$ref": "#/components/schemas/create_option_type_params"
4980   "/api/v2/platform/option_types/{id}":
4981     get:
4982       summary: Return an Option Type
4983       tags:
4984       - Option Types
4985       security:
4986       - bearer_auth: []
4987       description: Returns an Option Type
4988       operationId: show-option-type
4989       parameters:
4990       - name: id
4991         in: path
4992         required: true
4993         schema:
4994           type: string
4995       responses:
4996         '200':
4997           description: Record found
4998           content:
4999             application/vnd.api+json:
5000               examples:
5001                 Example:
5002                   value:
5003                     data:
5004                       id: '73'
5005                       type: option_type
5006                       attributes:
5007                         name: foo-size-73
5008                         presentation: Size
5009                         position: 1
5010                         created_at: '2022-11-08T19:34:32.026Z'
5011                         updated_at: '2022-11-08T19:34:32.026Z'
5012                         filterable: true
5013                         public_metadata: {}
5014                         private_metadata: {}
5015                       relationships:
5016                         option_values:
5017                           data: []
5018               schema:
5019                 "$ref": "#/components/schemas/resource"
5020         '404':
5021           description: Record not found
5022           content:
5023             application/vnd.api+json:
5024               examples:
5025                 Example:
5026                   value:
5027                     error: The resource you were looking for could not be found.
5028               schema:
5029                 "$ref": "#/components/schemas/error"
5030         '401':
5031           description: Authentication Failed
5032           content:
5033             application/vnd.api+json:
5034               examples:
5035                 Example:
5036                   value:
5037                     error: The access token is invalid
5038               schema:
5039                 "$ref": "#/components/schemas/error"
5040     patch:
5041       summary: Update an Option Type
5042       tags:
5043       - Option Types
5044       security:
5045       - bearer_auth: []
5046       description: Updates an Option Type
5047       operationId: update-option-type
5048       parameters:
5049       - name: id
5050         in: path
5051         required: true
5052         schema:
5053           type: string
5054       responses:
5055         '200':
5056           description: Record updated
5057           content:
5058             application/vnd.api+json:
5059               examples:
5060                 Example:
5061                   value:
5062                     data:
5063                       id: '75'
5064                       type: option_type
5065                       attributes:
5066                         name: Size-X
5067                         presentation: Size
5068                         position: 1
5069                         created_at: '2022-11-08T19:34:32.542Z'
5070                         updated_at: '2022-11-08T19:34:32.772Z'
5071                         filterable: true
5072                         public_metadata: {}
5073                         private_metadata: {}
5074                       relationships:
5075                         option_values:
5076                           data: []
5077               schema:
5078                 "$ref": "#/components/schemas/resource"
5079         '422':
5080           description: Invalid request
5081           content:
5082             application/vnd.api+json:
5083               examples:
5084                 Example:
5085                   value:
5086                     error: Name can't be blank
5087                     errors:
5088                       name:
5089                       - can't be blank
5090               schema:
5091                 "$ref": "#/components/schemas/validation_errors"
5092         '404':
5093           description: Record not found
5094           content:
5095             application/vnd.api+json:
5096               examples:
5097                 Example:
5098                   value:
5099                     error: The resource you were looking for could not be found.
5100               schema:
5101                 "$ref": "#/components/schemas/error"
5102         '401':
5103           description: Authentication Failed
5104           content:
5105             application/vnd.api+json:
5106               examples:
5107                 Example:
5108                   value:
5109                     error: The access token is invalid
5110               schema:
5111                 "$ref": "#/components/schemas/error"
5112       requestBody:
5113         content:
5114           application/json:
5115             schema:
5116               "$ref": "#/components/schemas/update_option_type_params"
5117     delete:
5118       summary: Delete an Option Type
5119       tags:
5120       - Option Types
5121       security:
5122       - bearer_auth: []
5123       description: Deletes an Option Type
5124       operationId: delete-option-type
5125       parameters:
5126       - name: id
5127         in: path
5128         required: true
5129         schema:
5130           type: string
5131       responses:
5132         '204':
5133           description: Record deleted
5134         '404':
5135           description: Record not found
5136           content:
5137             application/vnd.api+json:
5138               examples:
5139                 Example:
5140                   value:
5141                     error: The resource you were looking for could not be found.
5142               schema:
5143                 "$ref": "#/components/schemas/error"
5144         '401':
5145           description: Authentication Failed
5146           content:
5147             application/vnd.api+json:
5148               examples:
5149                 Example:
5150                   value:
5151                     error: The access token is invalid
5152               schema:
5153                 "$ref": "#/components/schemas/error"
5154   "/api/v2/platform/option_values":
5155     get:
5156       summary: Return a list of Option Values
5157       tags:
5158       - Option Values
5159       security:
5160       - bearer_auth: []
5161       description: Returns a list of Option Values
5162       operationId: option-values-list
5163       parameters:
5164       - name: page
5165         in: query
5166         example: 1
5167         schema:
5168           type: integer
5169       - name: per_page
5170         in: query
5171         example: 50
5172         schema:
5173           type: integer
5174       - name: include
5175         in: query
5176         description: 'Select which associated resources you would like to fetch, see:
5177           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
5178         example: option_type
5179         schema:
5180           type: string
5181       - name: filter[option_type_id_eq]
5182         in: query
5183         description: ''
5184         example: '1'
5185         schema:
5186           type: string
5187       - name: filter[name_cont]
5188         in: query
5189         description: ''
5190         example: Red
5191         schema:
5192           type: string
5193       responses:
5194         '200':
5195           description: Records returned
5196           content:
5197             application/vnd.api+json:
5198               examples:
5199                 Example:
5200                   value:
5201                     data:
5202                     - id: '68'
5203                       type: option_value
5204                       attributes:
5205                         position: 1
5206                         name: Size-68
5207                         presentation: S
5208                         created_at: '2022-11-08T19:34:33.815Z'
5209                         updated_at: '2022-11-08T19:34:33.815Z'
5210                         public_metadata: {}
5211                         private_metadata: {}
5212                       relationships:
5213                         option_type:
5214                           data:
5215                             id: '80'
5216                             type: option_type
5217                     - id: '69'
5218                       type: option_value
5219                       attributes:
5220                         position: 1
5221                         name: Size-69
5222                         presentation: S
5223                         created_at: '2022-11-08T19:34:33.820Z'
5224                         updated_at: '2022-11-08T19:34:33.820Z'
5225                         public_metadata: {}
5226                         private_metadata: {}
5227                       relationships:
5228                         option_type:
5229                           data:
5230                             id: '81'
5231                             type: option_type
5232                     meta:
5233                       count: 2
5234                       total_count: 2
5235                       total_pages: 1
5236                     links:
5237                       self: http://www.example.com/api/v2/platform/option_values?page=1&per_page=&include=&filter[option_type_id_eq]=&filter[name_cont]=
5238                       next: http://www.example.com/api/v2/platform/option_values?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&include=&page=1&per_page=
5239                       prev: http://www.example.com/api/v2/platform/option_values?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&include=&page=1&per_page=
5240                       last: http://www.example.com/api/v2/platform/option_values?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&include=&page=1&per_page=
5241                       first: http://www.example.com/api/v2/platform/option_values?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&include=&page=1&per_page=
5242               schema:
5243                 "$ref": "#/components/schemas/resources_list"
5244         '401':
5245           description: Authentication Failed
5246           content:
5247             application/vnd.api+json:
5248               examples:
5249                 Example:
5250                   value:
5251                     error: The access token is invalid
5252               schema:
5253                 "$ref": "#/components/schemas/error"
5254     post:
5255       summary: Create an Option Value
5256       tags:
5257       - Option Values
5258       security:
5259       - bearer_auth: []
5260       description: Creates an Option Value
5261       operationId: create-option-value
5262       parameters:
5263       - name: include
5264         in: query
5265         description: 'Select which associated resources you would like to fetch, see:
5266           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
5267         example: option_type
5268         schema:
5269           type: string
5270       responses:
5271         '201':
5272           description: Record created
5273           content:
5274             application/vnd.api+json:
5275               examples:
5276                 Example:
5277                   value:
5278                     data:
5279                       id: '72'
5280                       type: option_value
5281                       attributes:
5282                         position: 1
5283                         name: Size-72
5284                         presentation: S
5285                         created_at: '2022-11-08T19:34:34.345Z'
5286                         updated_at: '2022-11-08T19:34:34.345Z'
5287                         public_metadata: {}
5288                         private_metadata: {}
5289                       relationships:
5290                         option_type:
5291                           data:
5292               schema:
5293                 "$ref": "#/components/schemas/resource"
5294         '422':
5295           description: Invalid request
5296           content:
5297             application/vnd.api+json:
5298               examples:
5299                 Example:
5300                   value:
5301                     error: Name can't be blank and Presentation can't be blank
5302                     errors:
5303                       name:
5304                       - can't be blank
5305                       presentation:
5306                       - can't be blank
5307               schema:
5308                 "$ref": "#/components/schemas/validation_errors"
5309       requestBody:
5310         content:
5311           application/json:
5312             schema:
5313               "$ref": "#/components/schemas/create_option_value_params"
5314   "/api/v2/platform/option_values/{id}":
5315     get:
5316       summary: Return an Option Value
5317       tags:
5318       - Option Values
5319       security:
5320       - bearer_auth: []
5321       description: Returns an Option Value
5322       operationId: show-option-value
5323       parameters:
5324       - name: id
5325         in: path
5326         required: true
5327         schema:
5328           type: string
5329       - name: include
5330         in: query
5331         description: 'Select which associated resources you would like to fetch, see:
5332           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
5333         example: option_type
5334         schema:
5335           type: string
5336       responses:
5337         '200':
5338           description: Record found
5339           content:
5340             application/vnd.api+json:
5341               examples:
5342                 Example:
5343                   value:
5344                     data:
5345                       id: '73'
5346                       type: option_value
5347                       attributes:
5348                         position: 1
5349                         name: Size-73
5350                         presentation: S
5351                         created_at: '2022-11-08T19:34:34.613Z'
5352                         updated_at: '2022-11-08T19:34:34.613Z'
5353                         public_metadata: {}
5354                         private_metadata: {}
5355                       relationships:
5356                         option_type:
5357                           data:
5358                             id: '84'
5359                             type: option_type
5360               schema:
5361                 "$ref": "#/components/schemas/resource"
5362         '404':
5363           description: Record not found
5364           content:
5365             application/vnd.api+json:
5366               examples:
5367                 Example:
5368                   value:
5369                     error: The resource you were looking for could not be found.
5370               schema:
5371                 "$ref": "#/components/schemas/error"
5372         '401':
5373           description: Authentication Failed
5374           content:
5375             application/vnd.api+json:
5376               examples:
5377                 Example:
5378                   value:
5379                     error: The access token is invalid
5380               schema:
5381                 "$ref": "#/components/schemas/error"
5382     patch:
5383       summary: Update an Option Value
5384       tags:
5385       - Option Values
5386       security:
5387       - bearer_auth: []
5388       description: Updates an Option Value
5389       operationId: update-option-value
5390       parameters:
5391       - name: id
5392         in: path
5393         required: true
5394         schema:
5395           type: string
5396       - name: include
5397         in: query
5398         description: 'Select which associated resources you would like to fetch, see:
5399           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
5400         example: option_type
5401         schema:
5402           type: string
5403       responses:
5404         '200':
5405           description: Record updated
5406           content:
5407             application/vnd.api+json:
5408               examples:
5409                 Example:
5410                   value:
5411                     data:
5412                       id: '75'
5413                       type: option_value
5414                       attributes:
5415                         position: 1
5416                         name: M
5417                         presentation: S
5418                         created_at: '2022-11-08T19:34:35.140Z'
5419                         updated_at: '2022-11-08T19:34:35.372Z'
5420                         public_metadata: {}
5421                         private_metadata: {}
5422                       relationships:
5423                         option_type:
5424                           data:
5425                             id: '86'
5426                             type: option_type
5427               schema:
5428                 "$ref": "#/components/schemas/resource"
5429         '422':
5430           description: Invalid request
5431           content:
5432             application/vnd.api+json:
5433               examples:
5434                 Example:
5435                   value:
5436                     error: Name can't be blank
5437                     errors:
5438                       name:
5439                       - can't be blank
5440               schema:
5441                 "$ref": "#/components/schemas/validation_errors"
5442         '404':
5443           description: Record not found
5444           content:
5445             application/vnd.api+json:
5446               examples:
5447                 Example:
5448                   value:
5449                     error: The resource you were looking for could not be found.
5450               schema:
5451                 "$ref": "#/components/schemas/error"
5452         '401':
5453           description: Authentication Failed
5454           content:
5455             application/vnd.api+json:
5456               examples:
5457                 Example:
5458                   value:
5459                     error: The access token is invalid
5460               schema:
5461                 "$ref": "#/components/schemas/error"
5462       requestBody:
5463         content:
5464           application/json:
5465             schema:
5466               "$ref": "#/components/schemas/update_option_value_params"
5467     delete:
5468       summary: Delete an Option Value
5469       tags:
5470       - Option Values
5471       security:
5472       - bearer_auth: []
5473       description: Deletes an Option Value
5474       operationId: delete-option-value
5475       parameters:
5476       - name: id
5477         in: path
5478         required: true
5479         schema:
5480           type: string
5481       responses:
5482         '204':
5483           description: Record deleted
5484         '404':
5485           description: Record not found
5486           content:
5487             application/vnd.api+json:
5488               examples:
5489                 Example:
5490                   value:
5491                     error: The resource you were looking for could not be found.
5492               schema:
5493                 "$ref": "#/components/schemas/error"
5494         '401':
5495           description: Authentication Failed
5496           content:
5497             application/vnd.api+json:
5498               examples:
5499                 Example:
5500                   value:
5501                     error: The access token is invalid
5502               schema:
5503                 "$ref": "#/components/schemas/error"
5504   "/api/v2/platform/orders":
5505     get:
5506       summary: Return a list of Orders
5507       tags:
5508       - Orders
5509       security:
5510       - bearer_auth: []
5511       description: Returns a list of Orders
5512       operationId: orders-list
5513       parameters:
5514       - name: page
5515         in: query
5516         example: 1
5517         schema:
5518           type: integer
5519       - name: per_page
5520         in: query
5521         example: 50
5522         schema:
5523           type: integer
5524       - name: include
5525         in: query
5526         description: 'Select which associated resources you would like to fetch, see:
5527           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
5528         example: line_items,variants,product
5529         schema:
5530           type: string
5531       - name: filter[state_eq]
5532         in: query
5533         description: ''
5534         example: complete
5535         schema:
5536           type: string
5537       responses:
5538         '200':
5539           description: Records returned
5540           content:
5541             application/vnd.api+json:
5542               examples:
5543                 Example:
5544                   value:
5545                     data:
5546                     - id: '40'
5547                       type: order
5548                       attributes:
5549                         number: R936148131
5550                         item_total: '0.0'
5551                         total: '0.0'
5552                         state: cart
5553                         adjustment_total: '0.0'
5554                         completed_at:
5555                         payment_total: '0.0'
5556                         shipment_state:
5557                         payment_state:
5558                         email: murray_harber@strosin.ca
5559                         special_instructions:
5560                         created_at: '2022-11-08T19:34:36.444Z'
5561                         updated_at: '2022-11-08T19:34:36.444Z'
5562                         currency: USD
5563                         last_ip_address:
5564                         shipment_total: '0.0'
5565                         additional_tax_total: '0.0'
5566                         promo_total: '0.0'
5567                         channel: spree
5568                         included_tax_total: '0.0'
5569                         item_count: 0
5570                         approved_at:
5571                         confirmation_delivered: false
5572                         canceled_at:
5573                         state_lock_version: 0
5574                         taxable_adjustment_total: '0.0'
5575                         non_taxable_adjustment_total: '0.0'
5576                         store_owner_notification_delivered:
5577                         public_metadata: {}
5578                         private_metadata: {}
5579                         internal_note:
5580                         display_ship_total: "$0.00"
5581                         display_shipment_total: "$0.00"
5582                         display_outstanding_balance: "$0.00"
5583                         display_item_total: "$0.00"
5584                         display_adjustment_total: "$0.00"
5585                         display_included_tax_total: "$0.00"
5586                         display_additional_tax_total: "$0.00"
5587                         display_tax_total: "$0.00"
5588                         display_promo_total: "$0.00"
5589                         display_total: "$0.00"
5590                         display_cart_promo_total: "$0.00"
5591                         display_pre_tax_item_amount: "$0.00"
5592                         display_pre_tax_total: "$0.00"
5593                         display_total_applicable_store_credit: "$0.00"
5594                         display_total_applied_store_credit: "$0.00"
5595                         display_order_total_after_store_credit: "$0.00"
5596                         display_total_available_store_credit: "$0.00"
5597                         display_store_credit_remaining_after_capture: "$0.00"
5598                       relationships:
5599                         user:
5600                           data:
5601                             id: '41'
5602                             type: user
5603                         created_by:
5604                           data:
5605                         approver:
5606                           data:
5607                         canceler:
5608                           data:
5609                         bill_address:
5610                           data:
5611                             id: '52'
5612                             type: address
5613                         ship_address:
5614                           data:
5615                         line_items:
5616                           data: []
5617                         payments:
5618                           data: []
5619                         shipments:
5620                           data: []
5621                         state_changes:
5622                           data: []
5623                         return_authorizations:
5624                           data: []
5625                         reimbursements:
5626                           data: []
5627                         adjustments:
5628                           data: []
5629                         all_adjustments:
5630                           data: []
5631                         order_promotions:
5632                           data: []
5633                     - id: '41'
5634                       type: order
5635                       attributes:
5636                         number: R877925031
5637                         item_total: '0.0'
5638                         total: '0.0'
5639                         state: cart
5640                         adjustment_total: '0.0'
5641                         completed_at:
5642                         payment_total: '0.0'
5643                         shipment_state:
5644                         payment_state:
5645                         email: bronwyn@legroscorkery.ca
5646                         special_instructions:
5647                         created_at: '2022-11-08T19:34:36.455Z'
5648                         updated_at: '2022-11-08T19:34:36.455Z'
5649                         currency: USD
5650                         last_ip_address:
5651                         shipment_total: '0.0'
5652                         additional_tax_total: '0.0'
5653                         promo_total: '0.0'
5654                         channel: spree
5655                         included_tax_total: '0.0'
5656                         item_count: 0
5657                         approved_at:
5658                         confirmation_delivered: false
5659                         canceled_at:
5660                         state_lock_version: 0
5661                         taxable_adjustment_total: '0.0'
5662                         non_taxable_adjustment_total: '0.0'
5663                         store_owner_notification_delivered:
5664                         public_metadata: {}
5665                         private_metadata: {}
5666                         internal_note:
5667                         display_ship_total: "$0.00"
5668                         display_shipment_total: "$0.00"
5669                         display_outstanding_balance: "$0.00"
5670                         display_item_total: "$0.00"
5671                         display_adjustment_total: "$0.00"
5672                         display_included_tax_total: "$0.00"
5673                         display_additional_tax_total: "$0.00"
5674                         display_tax_total: "$0.00"
5675                         display_promo_total: "$0.00"
5676                         display_total: "$0.00"
5677                         display_cart_promo_total: "$0.00"
5678                         display_pre_tax_item_amount: "$0.00"
5679                         display_pre_tax_total: "$0.00"
5680                         display_total_applicable_store_credit: "$0.00"
5681                         display_total_applied_store_credit: "$0.00"
5682                         display_order_total_after_store_credit: "$0.00"
5683                         display_total_available_store_credit: "$0.00"
5684                         display_store_credit_remaining_after_capture: "$0.00"
5685                       relationships:
5686                         user:
5687                           data:
5688                             id: '42'
5689                             type: user
5690                         created_by:
5691                           data:
5692                         approver:
5693                           data:
5694                         canceler:
5695                           data:
5696                         bill_address:
5697                           data:
5698                             id: '53'
5699                             type: address
5700                         ship_address:
5701                           data:
5702                         line_items:
5703                           data: []
5704                         payments:
5705                           data: []
5706                         shipments:
5707                           data: []
5708                         state_changes:
5709                           data: []
5710                         return_authorizations:
5711                           data: []
5712                         reimbursements:
5713                           data: []
5714                         adjustments:
5715                           data: []
5716                         all_adjustments:
5717                           data: []
5718                         order_promotions:
5719                           data: []
5720                     meta:
5721                       count: 2
5722                       total_count: 2
5723                       total_pages: 1
5724                     links:
5725                       self: http://www.example.com/api/v2/platform/orders?page=1&per_page=&include=&filter[state_eq]=
5726                       next: http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=
5727                       prev: http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=
5728                       last: http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=
5729                       first: http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=
5730               schema:
5731                 "$ref": "#/components/schemas/resources_list"
5732         '401':
5733           description: Authentication Failed
5734           content:
5735             application/vnd.api+json:
5736               examples:
5737                 Example:
5738                   value:
5739                     error: The access token is invalid
5740               schema:
5741                 "$ref": "#/components/schemas/error"
5742     post:
5743       summary: Creates an Order
5744       tags:
5745       - Orders
5746       security:
5747       - bearer_auth: []
5748       description: Creates an Order
5749       operationId: create-order
5750       parameters:
5751       - name: include
5752         in: query
5753         description: 'Select which associated resources you would like to fetch, see:
5754           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
5755         example: line_items,variants,product
5756         schema:
5757           type: string
5758       responses:
5759         '201':
5760           description: Record created
5761           content:
5762             application/vnd.api+json:
5763               examples:
5764                 Example:
5765                   value:
5766                     data:
5767                       id: '44'
5768                       type: order
5769                       attributes:
5770                         number: R304058941
5771                         item_total: '0.0'
5772                         total: '0.0'
5773                         state: cart
5774                         adjustment_total: '0.0'
5775                         completed_at:
5776                         payment_total: '0.0'
5777                         shipment_state:
5778                         payment_state:
5779                         email:
5780                         special_instructions:
5781                         created_at: '2022-11-08T19:34:37.269Z'
5782                         updated_at: '2022-11-08T19:34:37.289Z'
5783                         currency: USD
5784                         last_ip_address:
5785                         shipment_total: '0.0'
5786                         additional_tax_total: '0.0'
5787                         promo_total: '0.0'
5788                         channel: spree
5789                         included_tax_total: '0.0'
5790                         item_count: 0
5791                         approved_at:
5792                         confirmation_delivered: false
5793                         canceled_at:
5794                         state_lock_version: 0
5795                         taxable_adjustment_total: '0.0'
5796                         non_taxable_adjustment_total: '0.0'
5797                         store_owner_notification_delivered:
5798                         public_metadata: {}
5799                         private_metadata: {}
5800                         internal_note:
5801                         display_ship_total: "$0.00"
5802                         display_shipment_total: "$0.00"
5803                         display_outstanding_balance: "$0.00"
5804                         display_item_total: "$0.00"
5805                         display_adjustment_total: "$0.00"
5806                         display_included_tax_total: "$0.00"
5807                         display_additional_tax_total: "$0.00"
5808                         display_tax_total: "$0.00"
5809                         display_promo_total: "$0.00"
5810                         display_total: "$0.00"
5811                         display_cart_promo_total: "$0.00"
5812                         display_pre_tax_item_amount: "$20.00"
5813                         display_pre_tax_total: "$20.00"
5814                         display_total_applicable_store_credit: "$0.00"
5815                         display_total_applied_store_credit: "$0.00"
5816                         display_order_total_after_store_credit: "$0.00"
5817                         display_total_available_store_credit: "$0.00"
5818                         display_store_credit_remaining_after_capture: "$0.00"
5819                       relationships:
5820                         user:
5821                           data:
5822                         created_by:
5823                           data:
5824                         approver:
5825                           data:
5826                         canceler:
5827                           data:
5828                         bill_address:
5829                           data:
5830                             id: '56'
5831                             type: address
5832                         ship_address:
5833                           data:
5834                             id: '56'
5835                             type: address
5836                         line_items:
5837                           data:
5838                           - id: '35'
5839                             type: line_item
5840                         payments:
5841                           data:
5842                           - id: '1'
5843                             type: payment
5844                         shipments:
5845                           data: []
5846                         state_changes:
5847                           data: []
5848                         return_authorizations:
5849                           data: []
5850                         reimbursements:
5851                           data: []
5852                         adjustments:
5853                           data: []
5854                         all_adjustments:
5855                           data: []
5856                         order_promotions:
5857                           data: []
5858               schema:
5859                 "$ref": "#/components/schemas/resource"
5860       requestBody:
5861         content:
5862           application/json:
5863             schema:
5864               "$ref": "#/components/schemas/create_order_params"
5865   "/api/v2/platform/orders/{id}":
5866     get:
5867       summary: Return an Order
5868       tags:
5869       - Orders
5870       security:
5871       - bearer_auth: []
5872       description: Returns an Order
5873       operationId: show-order
5874       parameters:
5875       - name: id
5876         in: path
5877         required: true
5878         schema:
5879           type: string
5880       - name: include
5881         in: query
5882         description: 'Select which associated resources you would like to fetch, see:
5883           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
5884         example: line_items,variants,product
5885         schema:
5886           type: string
5887       responses:
5888         '200':
5889           description: Record found
5890           content:
5891             application/vnd.api+json:
5892               examples:
5893                 Example:
5894                   value:
5895                     data:
5896                       id: '45'
5897                       type: order
5898                       attributes:
5899                         number: R612921489
5900                         item_total: '10.0'
5901                         total: '110.0'
5902                         state: delivery
5903                         adjustment_total: '0.0'
5904                         completed_at:
5905                         payment_total: '0.0'
5906                         shipment_state:
5907                         payment_state:
5908                         email: salome_rowe@lehner.com
5909                         special_instructions:
5910                         created_at: '2022-11-08T19:34:37.360Z'
5911                         updated_at: '2022-11-08T19:34:37.513Z'
5912                         currency: USD
5913                         last_ip_address:
5914                         shipment_total: '100.0'
5915                         additional_tax_total: '0.0'
5916                         promo_total: '0.0'
5917                         channel: spree
5918                         included_tax_total: '0.0'
5919                         item_count: 1
5920                         approved_at:
5921                         confirmation_delivered: false
5922                         canceled_at:
5923                         state_lock_version: 0
5924                         taxable_adjustment_total: '0.0'
5925                         non_taxable_adjustment_total: '0.0'
5926                         store_owner_notification_delivered:
5927                         public_metadata: {}
5928                         private_metadata: {}
5929                         internal_note:
5930                         display_ship_total: "$100.00"
5931                         display_shipment_total: "$100.00"
5932                         display_outstanding_balance: "$110.00"
5933                         display_item_total: "$10.00"
5934                         display_adjustment_total: "$0.00"
5935                         display_included_tax_total: "$0.00"
5936                         display_additional_tax_total: "$0.00"
5937                         display_tax_total: "$0.00"
5938                         display_promo_total: "$0.00"
5939                         display_total: "$110.00"
5940                         display_cart_promo_total: "$0.00"
5941                         display_pre_tax_item_amount: "$10.00"
5942                         display_pre_tax_total: "$10.00"
5943                         display_total_applicable_store_credit: "$0.00"
5944                         display_total_applied_store_credit: "$0.00"
5945                         display_order_total_after_store_credit: "$110.00"
5946                         display_total_available_store_credit: "$0.00"
5947                         display_store_credit_remaining_after_capture: "$0.00"
5948                       relationships:
5949                         user:
5950                           data:
5951                             id: '45'
5952                             type: user
5953                         created_by:
5954                           data:
5955                         approver:
5956                           data:
5957                         canceler:
5958                           data:
5959                         bill_address:
5960                           data:
5961                             id: '57'
5962                             type: address
5963                         ship_address:
5964                           data:
5965                             id: '58'
5966                             type: address
5967                         line_items:
5968                           data:
5969                           - id: '36'
5970                             type: line_item
5971                         payments:
5972                           data: []
5973                         shipments:
5974                           data:
5975                           - id: '1'
5976                             type: shipment
5977                         state_changes:
5978                           data: []
5979                         return_authorizations:
5980                           data: []
5981                         reimbursements:
5982                           data: []
5983                         adjustments:
5984                           data: []
5985                         all_adjustments:
5986                           data: []
5987                         order_promotions:
5988                           data: []
5989               schema:
5990                 "$ref": "#/components/schemas/resource"
5991         '404':
5992           description: Record not found
5993           content:
5994             application/vnd.api+json:
5995               examples:
5996                 Example:
5997                   value:
5998                     error: The resource you were looking for could not be found.
5999               schema:
6000                 "$ref": "#/components/schemas/error"
6001         '401':
6002           description: Authentication Failed
6003           content:
6004             application/vnd.api+json:
6005               examples:
6006                 Example:
6007                   value:
6008                     error: The access token is invalid
6009               schema:
6010                 "$ref": "#/components/schemas/error"
6011     patch:
6012       summary: Update an Order
6013       tags:
6014       - Orders
6015       security:
6016       - bearer_auth: []
6017       description: Updates an Order
6018       operationId: update-order
6019       parameters:
6020       - name: id
6021         in: path
6022         required: true
6023         schema:
6024           type: string
6025       - name: include
6026         in: query
6027         description: 'Select which associated resources you would like to fetch, see:
6028           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
6029         example: line_items,variants,product
6030         schema:
6031           type: string
6032       responses:
6033         '200':
6034           description: Record updated
6035           content:
6036             application/vnd.api+json:
6037               examples:
6038                 Example:
6039                   value:
6040                     data:
6041                       id: '47'
6042                       type: order
6043                       attributes:
6044                         number: R484277352
6045                         item_total: '10.0'
6046                         total: '110.0'
6047                         state: delivery
6048                         adjustment_total: '0.0'
6049                         completed_at:
6050                         payment_total: '0.0'
6051                         shipment_state:
6052                         payment_state:
6053                         email: new@example.com
6054                         special_instructions:
6055                         created_at: '2022-11-08T19:34:38.200Z'
6056                         updated_at: '2022-11-08T19:34:38.599Z'
6057                         currency: USD
6058                         last_ip_address:
6059                         shipment_total: '100.0'
6060                         additional_tax_total: '0.0'
6061                         promo_total: '0.0'
6062                         channel: spree
6063                         included_tax_total: '0.0'
6064                         item_count: 1
6065                         approved_at:
6066                         confirmation_delivered: false
6067                         canceled_at:
6068                         state_lock_version: 0
6069                         taxable_adjustment_total: '0.0'
6070                         non_taxable_adjustment_total: '0.0'
6071                         store_owner_notification_delivered:
6072                         public_metadata: {}
6073                         private_metadata: {}
6074                         internal_note:
6075                         display_ship_total: "$100.00"
6076                         display_shipment_total: "$100.00"
6077                         display_outstanding_balance: "$110.00"
6078                         display_item_total: "$10.00"
6079                         display_adjustment_total: "$0.00"
6080                         display_included_tax_total: "$0.00"
6081                         display_additional_tax_total: "$0.00"
6082                         display_tax_total: "$0.00"
6083                         display_promo_total: "$0.00"
6084                         display_total: "$110.00"
6085                         display_cart_promo_total: "$0.00"
6086                         display_pre_tax_item_amount: "$10.00"
6087                         display_pre_tax_total: "$10.00"
6088                         display_total_applicable_store_credit: "$0.00"
6089                         display_total_applied_store_credit: "$0.00"
6090                         display_order_total_after_store_credit: "$110.00"
6091                         display_total_available_store_credit: "$0.00"
6092                         display_store_credit_remaining_after_capture: "$0.00"
6093                       relationships:
6094                         user:
6095                           data:
6096                             id: '47'
6097                             type: user
6098                         created_by:
6099                           data:
6100                         approver:
6101                           data:
6102                         canceler:
6103                           data:
6104                         bill_address:
6105                           data:
6106                             id: '61'
6107                             type: address
6108                         ship_address:
6109                           data:
6110                             id: '62'
6111                             type: address
6112                         line_items:
6113                           data:
6114                           - id: '38'
6115                             type: line_item
6116                         payments:
6117                           data: []
6118                         shipments:
6119                           data:
6120                           - id: '3'
6121                             type: shipment
6122                         state_changes:
6123                           data: []
6124                         return_authorizations:
6125                           data: []
6126                         reimbursements:
6127                           data: []
6128                         adjustments:
6129                           data: []
6130                         all_adjustments:
6131                           data: []
6132                         order_promotions:
6133                           data: []
6134               schema:
6135                 "$ref": "#/components/schemas/resource"
6136         '422':
6137           description: Invalid request
6138           content:
6139             application/vnd.api+json:
6140               examples:
6141                 Example:
6142                   value:
6143                     error: Email is invalid
6144                     errors:
6145                       email:
6146                       - is invalid
6147               schema:
6148                 "$ref": "#/components/schemas/validation_errors"
6149         '404':
6150           description: Record not found
6151           content:
6152             application/vnd.api+json:
6153               examples:
6154                 Example:
6155                   value:
6156                     error: The resource you were looking for could not be found.
6157               schema:
6158                 "$ref": "#/components/schemas/error"
6159         '401':
6160           description: Authentication Failed
6161           content:
6162             application/vnd.api+json:
6163               examples:
6164                 Example:
6165                   value:
6166                     error: The access token is invalid
6167               schema:
6168                 "$ref": "#/components/schemas/error"
6169       requestBody:
6170         content:
6171           application/json:
6172             schema:
6173               "$ref": "#/components/schemas/update_order_params"
6174     delete:
6175       summary: Delete an Order
6176       tags:
6177       - Orders
6178       security:
6179       - bearer_auth: []
6180       description: Deletes an Order
6181       operationId: delete-order
6182       parameters:
6183       - name: id
6184         in: path
6185         required: true
6186         schema:
6187           type: string
6188       responses:
6189         '204':
6190           description: Record deleted
6191         '404':
6192           description: Record not found
6193           content:
6194             application/vnd.api+json:
6195               examples:
6196                 Example:
6197                   value:
6198                     error: The resource you were looking for could not be found.
6199               schema:
6200                 "$ref": "#/components/schemas/error"
6201         '401':
6202           description: Authentication Failed
6203           content:
6204             application/vnd.api+json:
6205               examples:
6206                 Example:
6207                   value:
6208                     error: The access token is invalid
6209               schema:
6210                 "$ref": "#/components/schemas/error"
6211   "/api/v2/platform/orders/{id}/advance":
6212     patch:
6213       summary: Advances an Order
6214       tags:
6215       - Orders
6216       security:
6217       - bearer_auth: []
6218       description: Advances an Order
6219       operationId: advance-order
6220       parameters:
6221       - name: id
6222         in: path
6223         required: true
6224         schema:
6225           type: string
6226       - name: include
6227         in: query
6228         description: 'Select which associated resources you would like to fetch, see:
6229           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
6230         example: line_items,variants,product
6231         schema:
6232           type: string
6233       responses:
6234         '200':
6235           description: Record updated
6236           content:
6237             application/vnd.api+json:
6238               examples:
6239                 Example:
6240                   value:
6241                     data:
6242                       id: '52'
6243                       type: order
6244                       attributes:
6245                         number: R366890627
6246                         item_total: '10.0'
6247                         total: '110.0'
6248                         state: payment
6249                         adjustment_total: '0.0'
6250                         completed_at:
6251                         payment_total: '0.0'
6252                         shipment_state:
6253                         payment_state:
6254                         email: sixta.larkin@bradtke.co.uk
6255                         special_instructions:
6256                         created_at: '2022-11-08T19:34:40.155Z'
6257                         updated_at: '2022-11-08T19:34:40.513Z'
6258                         currency: USD
6259                         last_ip_address:
6260                         shipment_total: '100.0'
6261                         additional_tax_total: '0.0'
6262                         promo_total: '0.0'
6263                         channel: spree
6264                         included_tax_total: '0.0'
6265                         item_count: 1
6266                         approved_at:
6267                         confirmation_delivered: false
6268                         canceled_at:
6269                         state_lock_version: 0
6270                         taxable_adjustment_total: '0.0'
6271                         non_taxable_adjustment_total: '0.0'
6272                         store_owner_notification_delivered:
6273                         public_metadata: {}
6274                         private_metadata: {}
6275                         internal_note:
6276                         display_ship_total: "$100.00"
6277                         display_shipment_total: "$100.00"
6278                         display_outstanding_balance: "$110.00"
6279                         display_item_total: "$10.00"
6280                         display_adjustment_total: "$0.00"
6281                         display_included_tax_total: "$0.00"
6282                         display_additional_tax_total: "$0.00"
6283                         display_tax_total: "$0.00"
6284                         display_promo_total: "$0.00"
6285                         display_total: "$110.00"
6286                         display_cart_promo_total: "$0.00"
6287                         display_pre_tax_item_amount: "$10.00"
6288                         display_pre_tax_total: "$110.00"
6289                         display_total_applicable_store_credit: "$0.00"
6290                         display_total_applied_store_credit: "$0.00"
6291                         display_order_total_after_store_credit: "$110.00"
6292                         display_total_available_store_credit: "$0.00"
6293                         display_store_credit_remaining_after_capture: "$0.00"
6294                       relationships:
6295                         user:
6296                           data:
6297                             id: '52'
6298                             type: user
6299                         created_by:
6300                           data:
6301                         approver:
6302                           data:
6303                         canceler:
6304                           data:
6305                         bill_address:
6306                           data:
6307                             id: '71'
6308                             type: address
6309                         ship_address:
6310                           data:
6311                             id: '72'
6312                             type: address
6313                         line_items:
6314                           data:
6315                           - id: '43'
6316                             type: line_item
6317                         payments:
6318                           data: []
6319                         shipments:
6320                           data:
6321                           - id: '8'
6322                             type: shipment
6323                         state_changes:
6324                           data:
6325                           - id: '2'
6326                             type: state_change
6327                         return_authorizations:
6328                           data: []
6329                         reimbursements:
6330                           data: []
6331                         adjustments:
6332                           data: []
6333                         all_adjustments:
6334                           data: []
6335                         order_promotions:
6336                           data: []
6337               schema:
6338                 "$ref": "#/components/schemas/resource"
6339         '404':
6340           description: Record not found
6341           content:
6342             application/vnd.api+json:
6343               examples:
6344                 Example:
6345                   value:
6346                     error: The resource you were looking for could not be found.
6347               schema:
6348                 "$ref": "#/components/schemas/error"
6349         '401':
6350           description: Authentication Failed
6351           content:
6352             application/vnd.api+json:
6353               examples:
6354                 Example:
6355                   value:
6356                     error: The access token is invalid
6357               schema:
6358                 "$ref": "#/components/schemas/error"
6359   "/api/v2/platform/orders/{id}/next":
6360     patch:
6361       summary: Next an Order
6362       tags:
6363       - Orders
6364       security:
6365       - bearer_auth: []
6366       description: Moves an Order to the next state
6367       operationId: next-order
6368       parameters:
6369       - name: id
6370         in: path
6371         required: true
6372         schema:
6373           type: string
6374       - name: include
6375         in: query
6376         description: 'Select which associated resources you would like to fetch, see:
6377           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
6378         example: line_items,variants,product
6379         schema:
6380           type: string
6381       responses:
6382         '200':
6383           description: Record updated
6384           content:
6385             application/vnd.api+json:
6386               examples:
6387                 Example:
6388                   value:
6389                     data:
6390                       id: '54'
6391                       type: order
6392                       attributes:
6393                         number: R268996702
6394                         item_total: '10.0'
6395                         total: '110.0'
6396                         state: payment
6397                         adjustment_total: '0.0'
6398                         completed_at:
6399                         payment_total: '0.0'
6400                         shipment_state:
6401                         payment_state:
6402                         email: deon.sporer@haagortiz.com
6403                         special_instructions:
6404                         created_at: '2022-11-08T19:34:40.971Z'
6405                         updated_at: '2022-11-08T19:34:41.324Z'
6406                         currency: USD
6407                         last_ip_address:
6408                         shipment_total: '100.0'
6409                         additional_tax_total: '0.0'
6410                         promo_total: '0.0'
6411                         channel: spree
6412                         included_tax_total: '0.0'
6413                         item_count: 1
6414                         approved_at:
6415                         confirmation_delivered: false
6416                         canceled_at:
6417                         state_lock_version: 0
6418                         taxable_adjustment_total: '0.0'
6419                         non_taxable_adjustment_total: '0.0'
6420                         store_owner_notification_delivered:
6421                         public_metadata: {}
6422                         private_metadata: {}
6423                         internal_note:
6424                         display_ship_total: "$100.00"
6425                         display_shipment_total: "$100.00"
6426                         display_outstanding_balance: "$110.00"
6427                         display_item_total: "$10.00"
6428                         display_adjustment_total: "$0.00"
6429                         display_included_tax_total: "$0.00"
6430                         display_additional_tax_total: "$0.00"
6431                         display_tax_total: "$0.00"
6432                         display_promo_total: "$0.00"
6433                         display_total: "$110.00"
6434                         display_cart_promo_total: "$0.00"
6435                         display_pre_tax_item_amount: "$10.00"
6436                         display_pre_tax_total: "$110.00"
6437                         display_total_applicable_store_credit: "$0.00"
6438                         display_total_applied_store_credit: "$0.00"
6439                         display_order_total_after_store_credit: "$110.00"
6440                         display_total_available_store_credit: "$0.00"
6441                         display_store_credit_remaining_after_capture: "$0.00"
6442                       relationships:
6443                         user:
6444                           data:
6445                             id: '54'
6446                             type: user
6447                         created_by:
6448                           data:
6449                         approver:
6450                           data:
6451                         canceler:
6452                           data:
6453                         bill_address:
6454                           data:
6455                             id: '75'
6456                             type: address
6457                         ship_address:
6458                           data:
6459                             id: '76'
6460                             type: address
6461                         line_items:
6462                           data:
6463                           - id: '45'
6464                             type: line_item
6465                         payments:
6466                           data: []
6467                         shipments:
6468                           data:
6469                           - id: '10'
6470                             type: shipment
6471                         state_changes:
6472                           data:
6473                           - id: '3'
6474                             type: state_change
6475                         return_authorizations:
6476                           data: []
6477                         reimbursements:
6478                           data: []
6479                         adjustments:
6480                           data: []
6481                         all_adjustments:
6482                           data: []
6483                         order_promotions:
6484                           data: []
6485               schema:
6486                 "$ref": "#/components/schemas/resource"
6487         '404':
6488           description: Record not found
6489           content:
6490             application/vnd.api+json:
6491               examples:
6492                 Example:
6493                   value:
6494                     error: The resource you were looking for could not be found.
6495               schema:
6496                 "$ref": "#/components/schemas/error"
6497         '401':
6498           description: Authentication Failed
6499           content:
6500             application/vnd.api+json:
6501               examples:
6502                 Example:
6503                   value:
6504                     error: The access token is invalid
6505               schema:
6506                 "$ref": "#/components/schemas/error"
6507   "/api/v2/platform/orders/{id}/complete":
6508     patch:
6509       summary: Completes an Order
6510       tags:
6511       - Orders
6512       security:
6513       - bearer_auth: []
6514       description: Marks an Order as completed
6515       operationId: complete-order
6516       parameters:
6517       - name: id
6518         in: path
6519         required: true
6520         schema:
6521           type: string
6522       - name: include
6523         in: query
6524         description: 'Select which associated resources you would like to fetch, see:
6525           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
6526         example: line_items,variants,product
6527         schema:
6528           type: string
6529       responses:
6530         '200':
6531           description: Record updated
6532           content:
6533             application/vnd.api+json:
6534               examples:
6535                 Example:
6536                   value:
6537                     data:
6538                       id: '56'
6539                       type: order
6540                       attributes:
6541                         number: R923002122
6542                         item_total: '10.0'
6543                         total: '110.0'
6544                         state: complete
6545                         adjustment_total: '0.0'
6546                         completed_at: '2022-11-08T19:34:42.207Z'
6547                         payment_total: '0.0'
6548                         shipment_state: pending
6549                         payment_state: balance_due
6550                         email: adeline@hodkiewicz.co.uk
6551                         special_instructions:
6552                         created_at: '2022-11-08T19:34:41.758Z'
6553                         updated_at: '2022-11-08T19:34:42.207Z'
6554                         currency: USD
6555                         last_ip_address:
6556                         shipment_total: '100.0'
6557                         additional_tax_total: '0.0'
6558                         promo_total: '0.0'
6559                         channel: spree
6560                         included_tax_total: '0.0'
6561                         item_count: 1
6562                         approved_at:
6563                         confirmation_delivered: false
6564                         canceled_at:
6565                         state_lock_version: 0
6566                         taxable_adjustment_total: '0.0'
6567                         non_taxable_adjustment_total: '0.0'
6568                         store_owner_notification_delivered:
6569                         public_metadata: {}
6570                         private_metadata: {}
6571                         internal_note:
6572                         display_ship_total: "$100.00"
6573                         display_shipment_total: "$100.00"
6574                         display_outstanding_balance: "$110.00"
6575                         display_item_total: "$10.00"
6576                         display_adjustment_total: "$0.00"
6577                         display_included_tax_total: "$0.00"
6578                         display_additional_tax_total: "$0.00"
6579                         display_tax_total: "$0.00"
6580                         display_promo_total: "$0.00"
6581                         display_total: "$110.00"
6582                         display_cart_promo_total: "$0.00"
6583                         display_pre_tax_item_amount: "$10.00"
6584                         display_pre_tax_total: "$110.00"
6585                         display_total_applicable_store_credit: "$0.00"
6586                         display_total_applied_store_credit: "$0.00"
6587                         display_order_total_after_store_credit: "$110.00"
6588                         display_total_available_store_credit: "$0.00"
6589                         display_store_credit_remaining_after_capture: "$0.00"
6590                       relationships:
6591                         user:
6592                           data:
6593                             id: '56'
6594                             type: user
6595                         created_by:
6596                           data:
6597                         approver:
6598                           data:
6599                         canceler:
6600                           data:
6601                         bill_address:
6602                           data:
6603                             id: '79'
6604                             type: address
6605                         ship_address:
6606                           data:
6607                             id: '80'
6608                             type: address
6609                         line_items:
6610                           data:
6611                           - id: '47'
6612                             type: line_item
6613                         payments:
6614                           data:
6615                           - id: '2'
6616                             type: payment
6617                         shipments:
6618                           data:
6619                           - id: '12'
6620                             type: shipment
6621                         state_changes:
6622                           data:
6623                           - id: '4'
6624                             type: state_change
6625                           - id: '5'
6626                             type: state_change
6627                           - id: '8'
6628                             type: state_change
6629                           - id: '9'
6630                             type: state_change
6631                           - id: '10'
6632                             type: state_change
6633                         return_authorizations:
6634                           data: []
6635                         reimbursements:
6636                           data: []
6637                         adjustments:
6638                           data: []
6639                         all_adjustments:
6640                           data: []
6641                         order_promotions:
6642                           data: []
6643               schema:
6644                 "$ref": "#/components/schemas/resource"
6645         '404':
6646           description: Record not found
6647           content:
6648             application/vnd.api+json:
6649               examples:
6650                 Example:
6651                   value:
6652                     error: The resource you were looking for could not be found.
6653               schema:
6654                 "$ref": "#/components/schemas/error"
6655         '401':
6656           description: Authentication Failed
6657           content:
6658             application/vnd.api+json:
6659               examples:
6660                 Example:
6661                   value:
6662                     error: The access token is invalid
6663               schema:
6664                 "$ref": "#/components/schemas/error"
6665   "/api/v2/platform/orders/{id}/empty":
6666     patch:
6667       summary: Empties an Order
6668       tags:
6669       - Orders
6670       security:
6671       - bearer_auth: []
6672       description: Removes all line items, promotions, shipment and payments from
6673         an Order
6674       operationId: empty-order
6675       parameters:
6676       - name: id
6677         in: path
6678         required: true
6679         schema:
6680           type: string
6681       - name: include
6682         in: query
6683         description: 'Select which associated resources you would like to fetch, see:
6684           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
6685         example: line_items,variants,product
6686         schema:
6687           type: string
6688       responses:
6689         '200':
6690           description: Record updated
6691           content:
6692             application/vnd.api+json:
6693               examples:
6694                 Example:
6695                   value:
6696                     data:
6697                       id: '59'
6698                       type: order
6699                       attributes:
6700                         number: R688998321
6701                         item_total: '0.0'
6702                         total: '0.0'
6703                         state: cart
6704                         adjustment_total: '0.0'
6705                         completed_at:
6706                         payment_total: '0.0'
6707                         shipment_state:
6708                         payment_state:
6709                         email: porsha.shanahan@nicolaszboncak.us
6710                         special_instructions:
6711                         created_at: '2022-11-08T19:34:42.795Z'
6712                         updated_at: '2022-11-08T19:34:43.122Z'
6713                         currency: USD
6714                         last_ip_address:
6715                         shipment_total: '0.0'
6716                         additional_tax_total: '0.0'
6717                         promo_total: '0.0'
6718                         channel: spree
6719                         included_tax_total: '0.0'
6720                         item_count: 0
6721                         approved_at:
6722                         confirmation_delivered: false
6723                         canceled_at:
6724                         state_lock_version: 0
6725                         taxable_adjustment_total: '0.0'
6726                         non_taxable_adjustment_total: '0.0'
6727                         store_owner_notification_delivered:
6728                         public_metadata: {}
6729                         private_metadata: {}
6730                         internal_note:
6731                         display_ship_total: "$0.00"
6732                         display_shipment_total: "$0.00"
6733                         display_outstanding_balance: "$0.00"
6734                         display_item_total: "$0.00"
6735                         display_adjustment_total: "$0.00"
6736                         display_included_tax_total: "$0.00"
6737                         display_additional_tax_total: "$0.00"
6738                         display_tax_total: "$0.00"
6739                         display_promo_total: "$0.00"
6740                         display_total: "$0.00"
6741                         display_cart_promo_total: "$0.00"
6742                         display_pre_tax_item_amount: "$0.00"
6743                         display_pre_tax_total: "$0.00"
6744                         display_total_applicable_store_credit: "$0.00"
6745                         display_total_applied_store_credit: "$0.00"
6746                         display_order_total_after_store_credit: "$0.00"
6747                         display_total_available_store_credit: "$0.00"
6748                         display_store_credit_remaining_after_capture: "$0.00"
6749                       relationships:
6750                         user:
6751                           data:
6752                             id: '59'
6753                             type: user
6754                         created_by:
6755                           data:
6756                         approver:
6757                           data:
6758                         canceler:
6759                           data:
6760                         bill_address:
6761                           data:
6762                             id: '85'
6763                             type: address
6764                         ship_address:
6765                           data:
6766                             id: '86'
6767                             type: address
6768                         line_items:
6769                           data: []
6770                         payments:
6771                           data: []
6772                         shipments:
6773                           data: []
6774                         state_changes:
6775                           data: []
6776                         return_authorizations:
6777                           data: []
6778                         reimbursements:
6779                           data: []
6780                         adjustments:
6781                           data: []
6782                         all_adjustments:
6783                           data: []
6784                         order_promotions:
6785                           data: []
6786               schema:
6787                 "$ref": "#/components/schemas/resource"
6788         '404':
6789           description: Record not found
6790           content:
6791             application/vnd.api+json:
6792               examples:
6793                 Example:
6794                   value:
6795                     error: The resource you were looking for could not be found.
6796               schema:
6797                 "$ref": "#/components/schemas/error"
6798         '401':
6799           description: Authentication Failed
6800           content:
6801             application/vnd.api+json:
6802               examples:
6803                 Example:
6804                   value:
6805                     error: The access token is invalid
6806               schema:
6807                 "$ref": "#/components/schemas/error"
6808   "/api/v2/platform/orders/{id}/approve":
6809     patch:
6810       summary: Approves an Order
6811       tags:
6812       - Orders
6813       security:
6814       - bearer_auth: []
6815       description: Approves an Order, when using a token created for a user, it will
6816         save this user as the approver
6817       operationId: approve-order
6818       parameters:
6819       - name: id
6820         in: path
6821         required: true
6822         schema:
6823           type: string
6824       - name: include
6825         in: query
6826         description: 'Select which associated resources you would like to fetch, see:
6827           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
6828         example: line_items,variants,product
6829         schema:
6830           type: string
6831       responses:
6832         '200':
6833           description: Record approved
6834           content:
6835             application/vnd.api+json:
6836               examples:
6837                 Example:
6838                   value:
6839                     data:
6840                       id: '61'
6841                       type: order
6842                       attributes:
6843                         number: R057732263
6844                         item_total: '10.0'
6845                         total: '110.0'
6846                         state: delivery
6847                         adjustment_total: '0.0'
6848                         completed_at:
6849                         payment_total: '0.0'
6850                         shipment_state:
6851                         payment_state:
6852                         email: horacio_purdy@schroederweimann.com
6853                         special_instructions:
6854                         created_at: '2022-11-08T19:34:43.561Z'
6855                         updated_at: '2022-11-08T19:34:43.641Z'
6856                         currency: USD
6857                         last_ip_address:
6858                         shipment_total: '100.0'
6859                         additional_tax_total: '0.0'
6860                         promo_total: '0.0'
6861                         channel: spree
6862                         included_tax_total: '0.0'
6863                         item_count: 1
6864                         approved_at:
6865                         confirmation_delivered: false
6866                         canceled_at:
6867                         state_lock_version: 0
6868                         taxable_adjustment_total: '0.0'
6869                         non_taxable_adjustment_total: '0.0'
6870                         store_owner_notification_delivered:
6871                         public_metadata: {}
6872                         private_metadata: {}
6873                         internal_note:
6874                         display_ship_total: "$100.00"
6875                         display_shipment_total: "$100.00"
6876                         display_outstanding_balance: "$110.00"
6877                         display_item_total: "$10.00"
6878                         display_adjustment_total: "$0.00"
6879                         display_included_tax_total: "$0.00"
6880                         display_additional_tax_total: "$0.00"
6881                         display_tax_total: "$0.00"
6882                         display_promo_total: "$0.00"
6883                         display_total: "$110.00"
6884                         display_cart_promo_total: "$0.00"
6885                         display_pre_tax_item_amount: "$10.00"
6886                         display_pre_tax_total: "$10.00"
6887                         display_total_applicable_store_credit: "$0.00"
6888                         display_total_applied_store_credit: "$0.00"
6889                         display_order_total_after_store_credit: "$110.00"
6890                         display_total_available_store_credit: "$0.00"
6891                         display_store_credit_remaining_after_capture: "$0.00"
6892                       relationships:
6893                         user:
6894                           data:
6895                             id: '61'
6896                             type: user
6897                         created_by:
6898                           data:
6899                         approver:
6900                           data:
6901                         canceler:
6902                           data:
6903                         bill_address:
6904                           data:
6905                             id: '89'
6906                             type: address
6907                         ship_address:
6908                           data:
6909                             id: '90'
6910                             type: address
6911                         line_items:
6912                           data:
6913                           - id: '52'
6914                             type: line_item
6915                         payments:
6916                           data: []
6917                         shipments:
6918                           data:
6919                           - id: '17'
6920                             type: shipment
6921                         state_changes:
6922                           data: []
6923                         return_authorizations:
6924                           data: []
6925                         reimbursements:
6926                           data: []
6927                         adjustments:
6928                           data: []
6929                         all_adjustments:
6930                           data: []
6931                         order_promotions:
6932                           data: []
6933               schema:
6934                 "$ref": "#/components/schemas/resource"
6935         '404':
6936           description: Record not found
6937           content:
6938             application/vnd.api+json:
6939               examples:
6940                 Example:
6941                   value:
6942                     error: The resource you were looking for could not be found.
6943               schema:
6944                 "$ref": "#/components/schemas/error"
6945         '401':
6946           description: Authentication Failed
6947           content:
6948             application/vnd.api+json:
6949               examples:
6950                 Example:
6951                   value:
6952                     error: The access token is invalid
6953               schema:
6954                 "$ref": "#/components/schemas/error"
6955   "/api/v2/platform/orders/{id}/cancel":
6956     patch:
6957       summary: Cancels an Order
6958       tags:
6959       - Orders
6960       security:
6961       - bearer_auth: []
6962       description: Cancels an Order, when using a token created for a user, it will
6963         save this user as the canceler
6964       operationId: cancel-order
6965       parameters:
6966       - name: id
6967         in: path
6968         required: true
6969         schema:
6970           type: string
6971       - name: include
6972         in: query
6973         description: 'Select which associated resources you would like to fetch, see:
6974           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
6975         example: line_items,variants,product
6976         schema:
6977           type: string
6978       responses:
6979         '200':
6980           description: record canceled
6981         '422':
6982           description: cannot be canceled
6983         '404':
6984           description: Record not found
6985           content:
6986             application/vnd.api+json:
6987               examples:
6988                 Example:
6989                   value:
6990                     error: The resource you were looking for could not be found.
6991               schema:
6992                 "$ref": "#/components/schemas/error"
6993         '401':
6994           description: Authentication Failed
6995           content:
6996             application/vnd.api+json:
6997               examples:
6998                 Example:
6999                   value:
7000                     error: The access token is invalid
7001               schema:
7002                 "$ref": "#/components/schemas/error"
7003   "/api/v2/platform/orders/{id}/use_store_credit":
7004     patch:
7005       summary: Use Store Credit for an Order
7006       tags:
7007       - Orders
7008       security:
7009       - bearer_auth: []
7010       description: Creates Store Credit payment for an Order
7011       operationId: use-store-credit-order
7012       parameters:
7013       - name: id
7014         in: path
7015         required: true
7016         schema:
7017           type: string
7018       - name: include
7019         in: query
7020         description: 'Select which associated resources you would like to fetch, see:
7021           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
7022         example: line_items,variants,product
7023         schema:
7024           type: string
7025       responses:
7026         '200':
7027           description: store credit payment created
7028         '422':
7029           description: user does not have store credit available
7030         '404':
7031           description: Record not found
7032           content:
7033             application/vnd.api+json:
7034               examples:
7035                 Example:
7036                   value:
7037                     error: The resource you were looking for could not be found.
7038               schema:
7039                 "$ref": "#/components/schemas/error"
7040         '401':
7041           description: Authentication Failed
7042           content:
7043             application/vnd.api+json:
7044               examples:
7045                 Example:
7046                   value:
7047                     error: The access token is invalid
7048               schema:
7049                 "$ref": "#/components/schemas/error"
7050       requestBody:
7051         content:
7052           application/json:
7053             schema:
7054               "$ref": "#/components/schemas/amount_param"
7055   "/api/v2/platform/orders/{id}/apply_coupon_code":
7056     patch:
7057       summary: Apply Coupon Code for an Order
7058       tags:
7059       - Orders
7060       security:
7061       - bearer_auth: []
7062       description: Creates Store Credit payment for an Order
7063       operationId: apply-coupon-code-order
7064       parameters:
7065       - name: id
7066         in: path
7067         required: true
7068         schema:
7069           type: string
7070       - name: include
7071         in: query
7072         description: 'Select which associated resources you would like to fetch, see:
7073           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
7074         example: line_items,variants,product
7075         schema:
7076           type: string
7077       responses:
7078         '200':
7079           description: coupon code applied
7080         '422':
7081           description: coupon code couldn't be applied
7082         '404':
7083           description: Record not found
7084           content:
7085             application/vnd.api+json:
7086               examples:
7087                 Example:
7088                   value:
7089                     error: The resource you were looking for could not be found.
7090               schema:
7091                 "$ref": "#/components/schemas/error"
7092         '401':
7093           description: Authentication Failed
7094           content:
7095             application/vnd.api+json:
7096               examples:
7097                 Example:
7098                   value:
7099                     error: The access token is invalid
7100               schema:
7101                 "$ref": "#/components/schemas/error"
7102       requestBody:
7103         content:
7104           application/json:
7105             schema:
7106               "$ref": "#/components/schemas/coupon_code_param"
7107   "/api/v2/platform/payment_methods":
7108     get:
7109       summary: Return a list of Payment Methods
7110       tags:
7111       - Payment Methods
7112       security:
7113       - bearer_auth: []
7114       description: Returns a list of Payment Methods
7115       operationId: payment-methods-list
7116       parameters:
7117       - name: page
7118         in: query
7119         example: 1
7120         schema:
7121           type: integer
7122       - name: per_page
7123         in: query
7124         example: 50
7125         schema:
7126           type: integer
7127       - name: include
7128         in: query
7129         description: 'Select which associated resources you would like to fetch, see:
7130           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
7131         example: stores
7132         schema:
7133           type: string
7134       - name: filter[name]
7135         in: query
7136         description: ''
7137         example: Stripe
7138         schema:
7139           type: string
7140       responses:
7141         '200':
7142           description: Records returned
7143           content:
7144             application/vnd.api+json:
7145               examples:
7146                 Example:
7147                   value:
7148                     data:
7149                     - id: '12'
7150                       type: payment_method
7151                       attributes:
7152                         name: Test
7153                         type: Spree::PaymentMethod
7154                         description:
7155                         active: true
7156                         display_on: both
7157                         auto_capture:
7158                         position: 1
7159                         created_at: '2022-11-08T19:34:47.914Z'
7160                         updated_at: '2022-11-08T19:34:47.916Z'
7161                         deleted_at:
7162                         public_metadata: {}
7163                         private_metadata: {}
7164                         preferences: {}
7165                       relationships:
7166                         stores:
7167                           data:
7168                           - id: '287'
7169                             type: store
7170                     - id: '13'
7171                       type: payment_method
7172                       attributes:
7173                         name: Test
7174                         type: Spree::PaymentMethod
7175                         description:
7176                         active: true
7177                         display_on: both
7178                         auto_capture:
7179                         position: 2
7180                         created_at: '2022-11-08T19:34:47.923Z'
7181                         updated_at: '2022-11-08T19:34:47.924Z'
7182                         deleted_at:
7183                         public_metadata: {}
7184                         private_metadata: {}
7185                         preferences: {}
7186                       relationships:
7187                         stores:
7188                           data:
7189                           - id: '287'
7190                             type: store
7191                     - id: '14'
7192                       type: payment_method
7193                       attributes:
7194                         name: Test
7195                         type: Spree::PaymentMethod
7196                         description:
7197                         active: true
7198                         display_on: both
7199                         auto_capture:
7200                         position: 3
7201                         created_at: '2022-11-08T19:34:47.929Z'
7202                         updated_at: '2022-11-08T19:34:47.930Z'
7203                         deleted_at:
7204                         public_metadata: {}
7205                         private_metadata: {}
7206                         preferences: {}
7207                       relationships:
7208                         stores:
7209                           data:
7210                           - id: '287'
7211                             type: store
7212                     - id: '15'
7213                       type: payment_method
7214                       attributes:
7215                         name: Credit Card
7216                         type: Spree::Gateway::Bogus
7217                         description:
7218                         active: true
7219                         display_on: both
7220                         auto_capture:
7221                         position: 4
7222                         created_at: '2022-11-08T19:34:47.935Z'
7223                         updated_at: '2022-11-08T19:34:47.937Z'
7224                         deleted_at:
7225                         public_metadata: {}
7226                         private_metadata: {}
7227                         preferences:
7228                           dummy_key: PUBLICKEY123
7229                           test_mode: true
7230                           server: test
7231                       relationships:
7232                         stores:
7233                           data:
7234                           - id: '287'
7235                             type: store
7236                     - id: '16'
7237                       type: payment_method
7238                       attributes:
7239                         name: Credit Card
7240                         type: Spree::Gateway::Bogus
7241                         description:
7242                         active: true
7243                         display_on: both
7244                         auto_capture:
7245                         position: 5
7246                         created_at: '2022-11-08T19:34:47.941Z'
7247                         updated_at: '2022-11-08T19:34:47.943Z'
7248                         deleted_at:
7249                         public_metadata: {}
7250                         private_metadata: {}
7251                         preferences:
7252                           dummy_key: PUBLICKEY123
7253                           test_mode: true
7254                           server: test
7255                       relationships:
7256                         stores:
7257                           data:
7258                           - id: '287'
7259                             type: store
7260                     meta:
7261                       count: 5
7262                       total_count: 5
7263                       total_pages: 1
7264                     links:
7265                       self: http://www.example.com/api/v2/platform/payment_methods?page=1&per_page=&include=&filter[name]=
7266                       next: http://www.example.com/api/v2/platform/payment_methods?filter%5Bname%5D=&include=&page=1&per_page=
7267                       prev: http://www.example.com/api/v2/platform/payment_methods?filter%5Bname%5D=&include=&page=1&per_page=
7268                       last: http://www.example.com/api/v2/platform/payment_methods?filter%5Bname%5D=&include=&page=1&per_page=
7269                       first: http://www.example.com/api/v2/platform/payment_methods?filter%5Bname%5D=&include=&page=1&per_page=
7270               schema:
7271                 "$ref": "#/components/schemas/resources_list"
7272         '401':
7273           description: Authentication Failed
7274           content:
7275             application/vnd.api+json:
7276               examples:
7277                 Example:
7278                   value:
7279                     error: The access token is invalid
7280               schema:
7281                 "$ref": "#/components/schemas/error"
7282     post:
7283       summary: Create a Payment Method
7284       tags:
7285       - Payment Methods
7286       security:
7287       - bearer_auth: []
7288       description: Creates a Payment Method
7289       operationId: create-payment-method
7290       parameters:
7291       - name: include
7292         in: query
7293         description: 'Select which associated resources you would like to fetch, see:
7294           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
7295         example: stores
7296         schema:
7297           type: string
7298       responses:
7299         '201':
7300           description: Record created
7301           content:
7302             application/vnd.api+json:
7303               examples:
7304                 Example:
7305                   value:
7306                     data:
7307                       id: '24'
7308                       type: payment_method
7309                       attributes:
7310                         name: API Bogus
7311                         type: Spree::Gateway::Bogus
7312                         description:
7313                         active: true
7314                         display_on: both
7315                         auto_capture:
7316                         position: 3
7317                         created_at: '2022-11-08T19:34:48.527Z'
7318                         updated_at: '2022-11-08T19:34:48.530Z'
7319                         deleted_at:
7320                         public_metadata: {}
7321                         private_metadata: {}
7322                         preferences:
7323                           dummy_key: PUBLICKEY123
7324                           test_mode: true
7325                           server: test
7326                       relationships:
7327                         stores:
7328                           data:
7329                           - id: '291'
7330                             type: store
7331                           - id: '292'
7332                             type: store
7333               schema:
7334                 "$ref": "#/components/schemas/resource"
7335         '422':
7336           description: Invalid request
7337           content:
7338             application/vnd.api+json:
7339               examples:
7340                 Example:
7341                   value:
7342                     error: Name can't be blank
7343                     errors:
7344                       name:
7345                       - can't be blank
7346               schema:
7347                 "$ref": "#/components/schemas/validation_errors"
7348       requestBody:
7349         content:
7350           application/json:
7351             schema:
7352               "$ref": "#/components/schemas/create_payment_method_params"
7353   "/api/v2/platform/payment_methods/{id}":
7354     get:
7355       summary: Return a Payment Method
7356       tags:
7357       - Payment Methods
7358       security:
7359       - bearer_auth: []
7360       description: Returns a Payment Method
7361       operationId: show-payment-method
7362       parameters:
7363       - name: id
7364         in: path
7365         required: true
7366         schema:
7367           type: string
7368       - name: include
7369         in: query
7370         description: 'Select which associated resources you would like to fetch, see:
7371           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
7372         example: stores
7373         schema:
7374           type: string
7375       responses:
7376         '200':
7377           description: Record found
7378           content:
7379             application/vnd.api+json:
7380               examples:
7381                 Example:
7382                   value:
7383                     data:
7384                       id: '30'
7385                       type: payment_method
7386                       attributes:
7387                         name: Credit Card
7388                         type: Spree::Gateway::Bogus
7389                         description:
7390                         active: true
7391                         display_on: both
7392                         auto_capture:
7393                         position: 4
7394                         created_at: '2022-11-08T19:34:48.855Z'
7395                         updated_at: '2022-11-08T19:34:48.857Z'
7396                         deleted_at:
7397                         public_metadata: {}
7398                         private_metadata: {}
7399                         preferences:
7400                           dummy_key: PUBLICKEY123
7401                           test_mode: true
7402                           server: test
7403                       relationships:
7404                         stores:
7405                           data:
7406                           - id: '295'
7407                             type: store
7408               schema:
7409                 "$ref": "#/components/schemas/resource"
7410         '404':
7411           description: Record not found
7412           content:
7413             application/vnd.api+json:
7414               examples:
7415                 Example:
7416                   value:
7417                     error: The resource you were looking for could not be found.
7418               schema:
7419                 "$ref": "#/components/schemas/error"
7420         '401':
7421           description: Authentication Failed
7422           content:
7423             application/vnd.api+json:
7424               examples:
7425                 Example:
7426                   value:
7427                     error: The access token is invalid
7428               schema:
7429                 "$ref": "#/components/schemas/error"
7430     patch:
7431       summary: Update a Payment Method
7432       tags:
7433       - Payment Methods
7434       security:
7435       - bearer_auth: []
7436       description: Updates a Payment Method
7437       operationId: update-payment-method
7438       parameters:
7439       - name: id
7440         in: path
7441         required: true
7442         schema:
7443           type: string
7444       - name: include
7445         in: query
7446         description: 'Select which associated resources you would like to fetch, see:
7447           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
7448         example: stores
7449         schema:
7450           type: string
7451       responses:
7452         '200':
7453           description: Record updated
7454           content:
7455             application/vnd.api+json:
7456               examples:
7457                 Example:
7458                   value:
7459                     data:
7460                       id: '40'
7461                       type: payment_method
7462                       attributes:
7463                         name: Credit Card
7464                         type: Spree::Gateway::Bogus
7465                         description:
7466                         active: true
7467                         display_on: both
7468                         auto_capture:
7469                         position: 3
7470                         created_at: '2022-11-08T19:34:49.452Z'
7471                         updated_at: '2022-11-08T19:34:49.687Z'
7472                         deleted_at:
7473                         public_metadata: {}
7474                         private_metadata: {}
7475                         preferences:
7476                           dummy_key: UPDATED-DUMMY-KEY-123
7477                           test_mode: false
7478                           server: production
7479                       relationships:
7480                         stores:
7481                           data:
7482                           - id: '301'
7483                             type: store
7484               schema:
7485                 "$ref": "#/components/schemas/resource"
7486         '422':
7487           description: Invalid request
7488           content:
7489             application/vnd.api+json:
7490               examples:
7491                 Example:
7492                   value:
7493                     error: Name can't be blank
7494                     errors:
7495                       name:
7496                       - can't be blank
7497               schema:
7498                 "$ref": "#/components/schemas/validation_errors"
7499         '404':
7500           description: Record not found
7501           content:
7502             application/vnd.api+json:
7503               examples:
7504                 Example:
7505                   value:
7506                     error: The resource you were looking for could not be found.
7507               schema:
7508                 "$ref": "#/components/schemas/error"
7509         '401':
7510           description: Authentication Failed
7511           content:
7512             application/vnd.api+json:
7513               examples:
7514                 Example:
7515                   value:
7516                     error: The access token is invalid
7517               schema:
7518                 "$ref": "#/components/schemas/error"
7519       requestBody:
7520         content:
7521           application/json:
7522             schema:
7523               oneOf:
7524               - "$ref": "#/components/schemas/update_payment_method_params"
7525               - "$ref": "#/components/schemas/update_payment_method_params_bogus_gateway"
7526     delete:
7527       summary: Delete a Payment Method
7528       tags:
7529       - Payment Methods
7530       security:
7531       - bearer_auth: []
7532       description: Deletes a Payment Method
7533       operationId: delete-payment-method
7534       parameters:
7535       - name: id
7536         in: path
7537         required: true
7538         schema:
7539           type: string
7540       responses:
7541         '204':
7542           description: Record deleted
7543         '404':
7544           description: Record not found
7545           content:
7546             application/vnd.api+json:
7547               examples:
7548                 Example:
7549                   value:
7550                     error: The resource you were looking for could not be found.
7551               schema:
7552                 "$ref": "#/components/schemas/error"
7553         '401':
7554           description: Authentication Failed
7555           content:
7556             application/vnd.api+json:
7557               examples:
7558                 Example:
7559                   value:
7560                     error: The access token is invalid
7561               schema:
7562                 "$ref": "#/components/schemas/error"
7563   "/api/v2/platform/payments":
7564     get:
7565       summary: Return a list of Payments
7566       tags:
7567       - Payments
7568       security:
7569       - bearer_auth: []
7570       description: Returns a list of Payments
7571       operationId: payments-list
7572       parameters:
7573       - name: page
7574         in: query
7575         example: 1
7576         schema:
7577           type: integer
7578       - name: per_page
7579         in: query
7580         example: 50
7581         schema:
7582           type: integer
7583       - name: include
7584         in: query
7585         description: 'Select which associated resources you would like to fetch, see:
7586           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
7587         example: payment_method,order,source
7588         schema:
7589           type: string
7590       - name: filter[payment_method_id_eq]
7591         in: query
7592         description: ''
7593         example: '1'
7594         schema:
7595           type: string
7596       - name: filter[amount_gteq]
7597         in: query
7598         description: ''
7599         example: '99.90'
7600         schema:
7601           type: string
7602       responses:
7603         '200':
7604           description: Records returned
7605           content:
7606             application/vnd.api+json:
7607               examples:
7608                 Example:
7609                   value:
7610                     data:
7611                     - id: '6'
7612                       type: payment
7613                       attributes:
7614                         amount: '45.75'
7615                         source_type: Spree::CreditCard
7616                         state: invalid
7617                         response_code: '12345'
7618                         avs_response:
7619                         created_at: '2022-11-08T19:34:50.932Z'
7620                         updated_at: '2022-11-08T19:34:50.951Z'
7621                         number: PPC5V5ZL
7622                         cvv_response_code:
7623                         cvv_response_message:
7624                         public_metadata: {}
7625                         private_metadata: {}
7626                         display_amount: "$45.75"
7627                       relationships:
7628                         order:
7629                           data:
7630                             id: '72'
7631                             type: order
7632                         payment_method:
7633                           data:
7634                             id: '60'
7635                             type: payment_method
7636                         source:
7637                           data:
7638                             id: '5'
7639                             type: credit_card
7640                         log_entries:
7641                           data: []
7642                         state_changes:
7643                           data:
7644                           - id: '15'
7645                             type: state_change
7646                         payment_capture_events:
7647                           data: []
7648                         refunds:
7649                           data: []
7650                     - id: '7'
7651                       type: payment
7652                       attributes:
7653                         amount: '45.75'
7654                         source_type: Spree::CreditCard
7655                         state: checkout
7656                         response_code: '12345'
7657                         avs_response:
7658                         created_at: '2022-11-08T19:34:50.949Z'
7659                         updated_at: '2022-11-08T19:34:50.949Z'
7660                         number: PB59CC7E
7661                         cvv_response_code:
7662                         cvv_response_message:
7663                         public_metadata: {}
7664                         private_metadata: {}
7665                         display_amount: "$45.75"
7666                       relationships:
7667                         order:
7668                           data:
7669                             id: '72'
7670                             type: order
7671                         payment_method:
7672                           data:
7673                             id: '60'
7674                             type: payment_method
7675                         source:
7676                           data:
7677                             id: '6'
7678                             type: credit_card
7679                         log_entries:
7680                           data: []
7681                         state_changes:
7682                           data: []
7683                         payment_capture_events:
7684                           data: []
7685                         refunds:
7686                           data: []
7687                     meta:
7688                       count: 2
7689                       total_count: 2
7690                       total_pages: 1
7691                     links:
7692                       self: http://www.example.com/api/v2/platform/payments?page=1&per_page=&include=&filter[payment_method_id_eq]=&filter[amount_gteq]=
7693                       next: http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=
7694                       prev: http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=
7695                       last: http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=
7696                       first: http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=
7697               schema:
7698                 "$ref": "#/components/schemas/resources_list"
7699         '401':
7700           description: Authentication Failed
7701           content:
7702             application/vnd.api+json:
7703               examples:
7704                 Example:
7705                   value:
7706                     error: The access token is invalid
7707               schema:
7708                 "$ref": "#/components/schemas/error"
7709   "/api/v2/platform/payments/{id}":
7710     get:
7711       summary: Return a Payment
7712       tags:
7713       - Payments
7714       security:
7715       - bearer_auth: []
7716       description: Returns a Payment
7717       operationId: show-payment
7718       parameters:
7719       - name: id
7720         in: path
7721         required: true
7722         schema:
7723           type: string
7724       - name: include
7725         in: query
7726         description: 'Select which associated resources you would like to fetch, see:
7727           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
7728         example: payment_method,order,source
7729         schema:
7730           type: string
7731       responses:
7732         '200':
7733           description: Record found
7734           content:
7735             application/vnd.api+json:
7736               examples:
7737                 Example:
7738                   value:
7739                     data:
7740                       id: '10'
7741                       type: payment
7742                       attributes:
7743                         amount: '45.75'
7744                         source_type: Spree::CreditCard
7745                         state: checkout
7746                         response_code: '12345'
7747                         avs_response:
7748                         created_at: '2022-11-08T19:34:51.349Z'
7749                         updated_at: '2022-11-08T19:34:51.349Z'
7750                         number: PROYB91V
7751                         cvv_response_code:
7752                         cvv_response_message:
7753                         public_metadata: {}
7754                         private_metadata: {}
7755                         display_amount: "$45.75"
7756                       relationships:
7757                         order:
7758                           data:
7759                             id: '74'
7760                             type: order
7761                         payment_method:
7762                           data:
7763                             id: '66'
7764                             type: payment_method
7765                         source:
7766                           data:
7767                             id: '9'
7768                             type: credit_card
7769                         log_entries:
7770                           data: []
7771                         state_changes:
7772                           data: []
7773                         payment_capture_events:
7774                           data: []
7775                         refunds:
7776                           data: []
7777               schema:
7778                 "$ref": "#/components/schemas/resource"
7779         '404':
7780           description: Record not found
7781           content:
7782             application/vnd.api+json:
7783               examples:
7784                 Example:
7785                   value:
7786                     error: The resource you were looking for could not be found.
7787               schema:
7788                 "$ref": "#/components/schemas/error"
7789         '401':
7790           description: Authentication Failed
7791           content:
7792             application/vnd.api+json:
7793               examples:
7794                 Example:
7795                   value:
7796                     error: The access token is invalid
7797               schema:
7798                 "$ref": "#/components/schemas/error"
7799     delete:
7800       summary: Delete a Payment
7801       tags:
7802       - Payments
7803       security:
7804       - bearer_auth: []
7805       description: Deletes a Payment
7806       operationId: delete-payment
7807       parameters:
7808       - name: id
7809         in: path
7810         required: true
7811         schema:
7812           type: string
7813       responses:
7814         '204':
7815           description: Record deleted
7816         '404':
7817           description: Record not found
7818           content:
7819             application/vnd.api+json:
7820               examples:
7821                 Example:
7822                   value:
7823                     error: The resource you were looking for could not be found.
7824               schema:
7825                 "$ref": "#/components/schemas/error"
7826         '401':
7827           description: Authentication Failed
7828           content:
7829             application/vnd.api+json:
7830               examples:
7831                 Example:
7832                   value:
7833                     error: The access token is invalid
7834               schema:
7835                 "$ref": "#/components/schemas/error"
7836   "/api/v2/platform/products":
7837     get:
7838       summary: Return a list of Products
7839       tags:
7840       - Products
7841       security:
7842       - bearer_auth: []
7843       description: Returns a list of Products
7844       operationId: products-list
7845       parameters:
7846       - name: page
7847         in: query
7848         example: 1
7849         schema:
7850           type: integer
7851       - name: per_page
7852         in: query
7853         example: 50
7854         schema:
7855           type: integer
7856       - name: include
7857         in: query
7858         description: 'Select which associated resources you would like to fetch, see:
7859           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
7860         example: prices
7861         schema:
7862           type: string
7863       - name: filter[name_eq]
7864         in: query
7865         description: ''
7866         example: Green Toy Boat
7867         schema:
7868           type: string
7869       responses:
7870         '200':
7871           description: Records returned
7872           content:
7873             application/vnd.api+json:
7874               examples:
7875                 Example:
7876                   value:
7877                     data:
7878                     - id: '164'
7879                       type: product
7880                       attributes:
7881                         name: Product 1648238
7882                         description: |-
7883                           Expedita a doloribus dolorum possimus architecto eligendi sunt quod. Officiis rerum nostrum incidunt delectus sint reiciendis doloribus ut. Atque voluptate nostrum voluptas unde repellendus.
7884                           Cum natus a id amet eos eligendi laborum. Minus itaque culpa aliquid repudiandae est odio reiciendis temporibus. Nesciunt cum voluptas veniam excepturi ducimus explicabo recusandae. Error quos voluptate reiciendis numquam dicta.
7885                         available_on: '2021-11-08T19:34:52.496Z'
7886                         deleted_at:
7887                         slug: product-1648238
7888                         meta_description:
7889                         meta_keywords:
7890                         created_at: '2022-11-08T19:34:52.514Z'
7891                         updated_at: '2022-11-08T19:34:52.520Z'
7892                         promotionable: true
7893                         meta_title:
7894                         discontinue_on:
7895                         public_metadata: {}
7896                         private_metadata: {}
7897                         status: active
7898                         make_active_at: '2021-11-08T19:34:52.496Z'
7899                         display_compare_at_price:
7900                         display_price: "$19.99"
7901                         purchasable: true
7902                         in_stock: false
7903                         backorderable: true
7904                         available: true
7905                         currency: USD
7906                         price: '19.99'
7907                         compare_at_price:
7908                       relationships:
7909                         tax_category:
7910                           data:
7911                             id: '108'
7912                             type: tax_category
7913                         primary_variant:
7914                           data:
7915                             id: '231'
7916                             type: variant
7917                         default_variant:
7918                           data:
7919                             id: '231'
7920                             type: variant
7921                         variants:
7922                           data: []
7923                         option_types:
7924                           data: []
7925                         product_properties:
7926                           data: []
7927                         taxons:
7928                           data: []
7929                         images:
7930                           data: []
7931                     - id: '165'
7932                       type: product
7933                       attributes:
7934                         name: Product 1653934
7935                         description: |-
7936                           Blanditiis deleniti tempora provident culpa id doloremque. Quibusdam commodi minus magni asperiores nemo odio. Laborum mollitia alias quisquam exercitationem aliquam ex occaecati doloremque. Quos optio voluptatum suscipit soluta assumenda quaerat maxime fugit. In saepe quaerat exercitationem earum sequi.
7937                           Quidem nesciunt provident dicta explicabo autem nemo sunt. Iusto in provident officiis sed. Eveniet quam distinctio ipsam optio sint. Et autem ducimus vel voluptas facere.
7938                           Earum inventore ut eum eos numquam. Omnis nam provident atque temporibus. Natus illo voluptas enim ex optio eveniet ullam. Labore repudiandae laudantium non suscipit est quae. Odio provident a ad fuga accusamus distinctio vitae.
7939                           Doloremque quod similique ipsa quas perferendis rerum earum excepturi. Minus explicabo autem quod incidunt. Earum magnam voluptatem expedita eveniet reiciendis dolores atque et.
7940                           Inventore odio voluptate dicta dolore natus aut occaecati molestiae. Aut eum consequatur soluta voluptatum animi delectus accusantium asperiores. Facere exercitationem consequuntur adipisci nulla similique perferendis ullam. Illo ad aliquid maiores non ea.
7941                         available_on: '2021-11-08T19:34:52.538Z'
7942                         deleted_at:
7943                         slug: product-1653934
7944                         meta_description:
7945                         meta_keywords:
7946                         created_at: '2022-11-08T19:34:52.549Z'
7947                         updated_at: '2022-11-08T19:34:52.555Z'
7948                         promotionable: true
7949                         meta_title:
7950                         discontinue_on:
7951                         public_metadata: {}
7952                         private_metadata: {}
7953                         status: active
7954                         make_active_at: '2021-11-08T19:34:52.538Z'
7955                         display_compare_at_price:
7956                         display_price: "$19.99"
7957                         purchasable: true
7958                         in_stock: false
7959                         backorderable: true
7960                         available: true
7961                         currency: USD
7962                         price: '19.99'
7963                         compare_at_price:
7964                       relationships:
7965                         tax_category:
7966                           data:
7967                             id: '108'
7968                             type: tax_category
7969                         primary_variant:
7970                           data:
7971                             id: '232'
7972                             type: variant
7973                         default_variant:
7974                           data:
7975                             id: '232'
7976                             type: variant
7977                         variants:
7978                           data: []
7979                         option_types:
7980                           data: []
7981                         product_properties:
7982                           data: []
7983                         taxons:
7984                           data: []
7985                         images:
7986                           data: []
7987                     meta:
7988                       count: 2
7989                       total_count: 2
7990                       total_pages: 1
7991                     links:
7992                       self: http://www.example.com/api/v2/platform/products?page=1&per_page=&include=&filter[name_eq]=
7993                       next: http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=
7994                       prev: http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=
7995                       last: http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=
7996                       first: http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=
7997               schema:
7998                 "$ref": "#/components/schemas/resources_list"
7999         '401':
8000           description: Authentication Failed
8001           content:
8002             application/vnd.api+json:
8003               examples:
8004                 Example:
8005                   value:
8006                     error: The access token is invalid
8007               schema:
8008                 "$ref": "#/components/schemas/error"
8009     post:
8010       summary: Create a Product
8011       tags:
8012       - Products
8013       security:
8014       - bearer_auth: []
8015       description: Creates a Product
8016       operationId: create-product
8017       parameters:
8018       - name: include
8019         in: query
8020         description: 'Select which associated resources you would like to fetch, see:
8021           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8022         example: prices
8023         schema:
8024           type: string
8025       responses:
8026         '201':
8027           description: Record created
8028           content:
8029             application/vnd.api+json:
8030               examples:
8031                 Example:
8032                   value:
8033                     data:
8034                       id: '168'
8035                       type: product
8036                       attributes:
8037                         name: Spinning Top
8038                         description:
8039                         available_on:
8040                         deleted_at:
8041                         slug: spinning-top
8042                         meta_description:
8043                         meta_keywords:
8044                         created_at: '2022-11-08T19:34:53.239Z'
8045                         updated_at: '2022-11-08T19:34:53.243Z'
8046                         promotionable: true
8047                         meta_title:
8048                         discontinue_on:
8049                         public_metadata: {}
8050                         private_metadata: {}
8051                         status: draft
8052                         make_active_at:
8053                         display_compare_at_price:
8054                         display_price: "$87.43"
8055                         purchasable: false
8056                         in_stock: false
8057                         backorderable: false
8058                         available: false
8059                         currency: USD
8060                         price: '87.43'
8061                         compare_at_price:
8062                       relationships:
8063                         tax_category:
8064                           data:
8065                         primary_variant:
8066                           data:
8067                             id: '235'
8068                             type: variant
8069                         default_variant:
8070                           data:
8071                             id: '235'
8072                             type: variant
8073                         variants:
8074                           data: []
8075                         option_types:
8076                           data: []
8077                         product_properties:
8078                           data: []
8079                         taxons:
8080                           data: []
8081                         images:
8082                           data: []
8083               schema:
8084                 "$ref": "#/components/schemas/resource"
8085         '422':
8086           description: Invalid request
8087           content:
8088             application/vnd.api+json:
8089               examples:
8090                 Example:
8091                   value:
8092                     error: Name can't be blank, Shipping Category can't be blank,
8093                       and Price can't be blank
8094                     errors:
8095                       name:
8096                       - can't be blank
8097                       shipping_category:
8098                       - can't be blank
8099                       price:
8100                       - can't be blank
8101               schema:
8102                 "$ref": "#/components/schemas/validation_errors"
8103       requestBody:
8104         content:
8105           application/json:
8106             schema:
8107               "$ref": "#/components/schemas/create_product_params"
8108   "/api/v2/platform/products/{id}":
8109     get:
8110       summary: Return a Product
8111       tags:
8112       - Products
8113       security:
8114       - bearer_auth: []
8115       description: Returns a Product
8116       operationId: show-product
8117       parameters:
8118       - name: id
8119         in: path
8120         required: true
8121         schema:
8122           type: string
8123       - name: include
8124         in: query
8125         description: 'Select which associated resources you would like to fetch, see:
8126           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8127         example: prices
8128         schema:
8129           type: string
8130       responses:
8131         '200':
8132           description: Record found
8133           content:
8134             application/vnd.api+json:
8135               examples:
8136                 Example:
8137                   value:
8138                     data:
8139                       id: '169'
8140                       type: product
8141                       attributes:
8142                         name: Product 1682525
8143                         description: |-
8144                           Enim quibusdam et quis in iste. Eius labore corporis tempora suscipit molestiae sunt. Omnis vero numquam nostrum totam illum consectetur similique corporis.
8145                           Iusto neque beatae consequatur consequuntur soluta pariatur at. Magnam numquam nisi voluptatem ipsa blanditiis ullam iste mollitia. Incidunt totam earum perferendis eveniet iusto ea. Sapiente est quam corporis veniam eveniet itaque.
8146                           Repudiandae autem cumque hic nisi perferendis cum quod nostrum. Voluptatem ipsam esse provident itaque similique quia. Nobis quod blanditiis atque cupiditate eaque perspiciatis ullam in. Sequi aspernatur eaque reiciendis error illo dolorum pariatur.
8147                           Sit recusandae reiciendis magni ipsam repudiandae est dolor quae. Veritatis possimus eveniet iusto dignissimos quasi consequatur temporibus. Magni asperiores officiis occaecati provident velit quos a voluptate.
8148                         available_on: '2021-11-08T19:34:53.563Z'
8149                         deleted_at:
8150                         slug: product-1682525
8151                         meta_description:
8152                         meta_keywords:
8153                         created_at: '2022-11-08T19:34:53.582Z'
8154                         updated_at: '2022-11-08T19:34:53.588Z'
8155                         promotionable: true
8156                         meta_title:
8157                         discontinue_on:
8158                         public_metadata: {}
8159                         private_metadata: {}
8160                         status: active
8161                         make_active_at: '2021-11-08T19:34:53.563Z'
8162                         display_compare_at_price:
8163                         display_price: "$19.99"
8164                         purchasable: true
8165                         in_stock: false
8166                         backorderable: true
8167                         available: true
8168                         currency: USD
8169                         price: '19.99'
8170                         compare_at_price:
8171                       relationships:
8172                         tax_category:
8173                           data:
8174                             id: '110'
8175                             type: tax_category
8176                         primary_variant:
8177                           data:
8178                             id: '236'
8179                             type: variant
8180                         default_variant:
8181                           data:
8182                             id: '236'
8183                             type: variant
8184                         variants:
8185                           data: []
8186                         option_types:
8187                           data: []
8188                         product_properties:
8189                           data: []
8190                         taxons:
8191                           data: []
8192                         images:
8193                           data: []
8194               schema:
8195                 "$ref": "#/components/schemas/resource"
8196         '404':
8197           description: Record not found
8198           content:
8199             application/vnd.api+json:
8200               examples:
8201                 Example:
8202                   value:
8203                     error: The resource you were looking for could not be found.
8204               schema:
8205                 "$ref": "#/components/schemas/error"
8206         '401':
8207           description: Authentication Failed
8208           content:
8209             application/vnd.api+json:
8210               examples:
8211                 Example:
8212                   value:
8213                     error: The access token is invalid
8214               schema:
8215                 "$ref": "#/components/schemas/error"
8216     patch:
8217       summary: Update a Product
8218       tags:
8219       - Products
8220       security:
8221       - bearer_auth: []
8222       description: Updates a Product
8223       operationId: update-product
8224       parameters:
8225       - name: id
8226         in: path
8227         required: true
8228         schema:
8229           type: string
8230       - name: include
8231         in: query
8232         description: 'Select which associated resources you would like to fetch, see:
8233           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8234         example: prices
8235         schema:
8236           type: string
8237       responses:
8238         '200':
8239           description: Record updated
8240           content:
8241             application/vnd.api+json:
8242               examples:
8243                 Example:
8244                   value:
8245                     data:
8246                       id: '171'
8247                       type: product
8248                       attributes:
8249                         name: Twirling Bottom
8250                         description: |-
8251                           Ut quod iusto optio quos labore. Blanditiis in sunt sequi dolores eveniet reprehenderit maxime. Iusto consequuntur itaque nostrum placeat.
8252                           Laboriosam labore vero voluptatibus suscipit consectetur possimus qui. Ullam commodi corporis cumque voluptatem neque non explicabo. Quaerat atque error nesciunt recusandae rem unde qui quas. Labore perspiciatis consectetur quisquam voluptatibus similique officiis ipsam enim. Labore neque reprehenderit et tempore.
8253                           Ea minus nostrum placeat quibusdam laudantium. Illo voluptates in suscipit consequatur harum. Omnis tempora facilis distinctio quos repudiandae ex sapiente. Amet optio temporibus voluptas doloribus.
8254                           Odio at porro commodi repudiandae quia quas. Ut sequi atque accusamus voluptatum consequatur delectus explicabo. Nobis laboriosam facere molestias consectetur saepe totam eos ea. Possimus atque adipisci sequi dolorum excepturi quo. Ad esse dolorum accusantium fugiat quaerat.
8255                           Voluptas libero magnam earum reprehenderit ullam at veritatis. Magni culpa id quidem hic ad. Quidem ipsum est vero ut eaque veniam. Corrupti sint ratione maxime aspernatur itaque quo nostrum. Qui architecto ducimus quisquam iste saepe ullam.
8256                         available_on: '2021-11-08T19:34:54.192Z'
8257                         deleted_at:
8258                         slug: product-1706992
8259                         meta_description:
8260                         meta_keywords:
8261                         created_at: '2022-11-08T19:34:54.210Z'
8262                         updated_at: '2022-11-08T19:34:54.468Z'
8263                         promotionable: true
8264                         meta_title:
8265                         discontinue_on:
8266                         public_metadata: {}
8267                         private_metadata: {}
8268                         status: active
8269                         make_active_at: '2021-11-08T19:34:54.192Z'
8270                         display_compare_at_price:
8271                         display_price: "$33.21"
8272                         purchasable: true
8273                         in_stock: false
8274                         backorderable: true
8275                         available: true
8276                         currency: USD
8277                         price: '33.21'
8278                         compare_at_price:
8279                       relationships:
8280                         tax_category:
8281                           data:
8282                             id: '112'
8283                             type: tax_category
8284                         primary_variant:
8285                           data:
8286                             id: '238'
8287                             type: variant
8288                         default_variant:
8289                           data:
8290                             id: '238'
8291                             type: variant
8292                         variants:
8293                           data: []
8294                         option_types:
8295                           data: []
8296                         product_properties:
8297                           data: []
8298                         taxons:
8299                           data: []
8300                         images:
8301                           data: []
8302               schema:
8303                 "$ref": "#/components/schemas/resource"
8304         '422':
8305           description: Invalid request
8306           content:
8307             application/vnd.api+json:
8308               examples:
8309                 Example:
8310                   value:
8311                     error: Name can't be blank
8312                     errors:
8313                       name:
8314                       - can't be blank
8315               schema:
8316                 "$ref": "#/components/schemas/validation_errors"
8317         '404':
8318           description: Record not found
8319           content:
8320             application/vnd.api+json:
8321               examples:
8322                 Example:
8323                   value:
8324                     error: The resource you were looking for could not be found.
8325               schema:
8326                 "$ref": "#/components/schemas/error"
8327         '401':
8328           description: Authentication Failed
8329           content:
8330             application/vnd.api+json:
8331               examples:
8332                 Example:
8333                   value:
8334                     error: The access token is invalid
8335               schema:
8336                 "$ref": "#/components/schemas/error"
8337       requestBody:
8338         content:
8339           application/json:
8340             schema:
8341               "$ref": "#/components/schemas/update_product_params"
8342     delete:
8343       summary: Delete a Product
8344       tags:
8345       - Products
8346       security:
8347       - bearer_auth: []
8348       description: Deletes a Product
8349       operationId: delete-product
8350       parameters:
8351       - name: id
8352         in: path
8353         required: true
8354         schema:
8355           type: string
8356       responses:
8357         '204':
8358           description: Record deleted
8359         '404':
8360           description: Record not found
8361           content:
8362             application/vnd.api+json:
8363               examples:
8364                 Example:
8365                   value:
8366                     error: The resource you were looking for could not be found.
8367               schema:
8368                 "$ref": "#/components/schemas/error"
8369         '401':
8370           description: Authentication Failed
8371           content:
8372             application/vnd.api+json:
8373               examples:
8374                 Example:
8375                   value:
8376                     error: The access token is invalid
8377               schema:
8378                 "$ref": "#/components/schemas/error"
8379   "/api/v2/platform/promotion_actions":
8380     get:
8381       summary: Return a list of Promotion Actions
8382       tags:
8383       - Promotion Actions
8384       security:
8385       - bearer_auth: []
8386       description: Returns a list of Promotion Actions
8387       operationId: promotion-actions-list
8388       parameters:
8389       - name: page
8390         in: query
8391         example: 1
8392         schema:
8393           type: integer
8394       - name: per_page
8395         in: query
8396         example: 50
8397         schema:
8398           type: integer
8399       - name: include
8400         in: query
8401         description: 'Select which associated resources you would like to fetch, see:
8402           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8403         example: calculator
8404         schema:
8405           type: string
8406       - name: filter[type_eq]
8407         in: query
8408         description: ''
8409         example: Spree::Promotion::Actions::CreateAdjustment
8410         schema:
8411           type: string
8412       responses:
8413         '200':
8414           description: Records returned
8415           content:
8416             application/vnd.api+json:
8417               examples:
8418                 Example:
8419                   value:
8420                     data:
8421                     - id: '5'
8422                       type: promotion_action
8423                       attributes:
8424                         position:
8425                         type:
8426                         deleted_at:
8427                         created_at: '2022-11-08T19:34:55.838Z'
8428                         updated_at: '2022-11-08T19:34:55.838Z'
8429                       relationships:
8430                         promotion:
8431                           data:
8432                             id: '5'
8433                             type: promotion
8434                     - id: '6'
8435                       type: promotion_action
8436                       attributes:
8437                         position:
8438                         type:
8439                         deleted_at:
8440                         created_at: '2022-11-08T19:34:55.839Z'
8441                         updated_at: '2022-11-08T19:34:55.839Z'
8442                       relationships:
8443                         promotion:
8444                           data:
8445                             id: '5'
8446                             type: promotion
8447                     meta:
8448                       count: 2
8449                       total_count: 2
8450                       total_pages: 1
8451                     links:
8452                       self: http://www.example.com/api/v2/platform/promotion_actions?page=1&per_page=&include=&filter[type_eq]=
8453                       next: http://www.example.com/api/v2/platform/promotion_actions?filter%5Btype_eq%5D=&include=&page=1&per_page=
8454                       prev: http://www.example.com/api/v2/platform/promotion_actions?filter%5Btype_eq%5D=&include=&page=1&per_page=
8455                       last: http://www.example.com/api/v2/platform/promotion_actions?filter%5Btype_eq%5D=&include=&page=1&per_page=
8456                       first: http://www.example.com/api/v2/platform/promotion_actions?filter%5Btype_eq%5D=&include=&page=1&per_page=
8457               schema:
8458                 "$ref": "#/components/schemas/resources_list"
8459         '401':
8460           description: Authentication Failed
8461           content:
8462             application/vnd.api+json:
8463               examples:
8464                 Example:
8465                   value:
8466                     error: The access token is invalid
8467               schema:
8468                 "$ref": "#/components/schemas/error"
8469     post:
8470       summary: Create a Promotion Action
8471       tags:
8472       - Promotion Actions
8473       security:
8474       - bearer_auth: []
8475       description: Creates a Promotion Action
8476       operationId: create-promotion-action
8477       parameters:
8478       - name: include
8479         in: query
8480         description: 'Select which associated resources you would like to fetch, see:
8481           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8482         example: calculator
8483         schema:
8484           type: string
8485       responses:
8486         '201':
8487           description: Record created
8488           content:
8489             application/vnd.api+json:
8490               examples:
8491                 Example:
8492                   value:
8493                     data:
8494                       id: '9'
8495                       type: promotion_action
8496                       attributes:
8497                         position:
8498                         type:
8499                         deleted_at:
8500                         created_at: '2022-11-08T19:34:56.379Z'
8501                         updated_at: '2022-11-08T19:34:56.379Z'
8502                       relationships:
8503                         promotion:
8504                           data:
8505                             id: '7'
8506                             type: promotion
8507               schema:
8508                 "$ref": "#/components/schemas/resource"
8509       requestBody:
8510         content:
8511           application/json:
8512             schema:
8513               "$ref": "#/components/schemas/create_promotion_action_params"
8514   "/api/v2/platform/promotion_actions/{id}":
8515     get:
8516       summary: Return a Promotion Action
8517       tags:
8518       - Promotion Actions
8519       security:
8520       - bearer_auth: []
8521       description: Returns a Promotion Action
8522       operationId: show-promotion-action
8523       parameters:
8524       - name: id
8525         in: path
8526         required: true
8527         schema:
8528           type: string
8529       - name: include
8530         in: query
8531         description: 'Select which associated resources you would like to fetch, see:
8532           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8533         example: calculator
8534         schema:
8535           type: string
8536       responses:
8537         '200':
8538           description: Record found
8539           content:
8540             application/vnd.api+json:
8541               examples:
8542                 Example:
8543                   value:
8544                     data:
8545                       id: '10'
8546                       type: promotion_action
8547                       attributes:
8548                         position:
8549                         type:
8550                         deleted_at:
8551                         created_at: '2022-11-08T19:34:56.411Z'
8552                         updated_at: '2022-11-08T19:34:56.411Z'
8553                       relationships:
8554                         promotion:
8555                           data:
8556                             id: '8'
8557                             type: promotion
8558               schema:
8559                 "$ref": "#/components/schemas/resource"
8560         '404':
8561           description: Record not found
8562           content:
8563             application/vnd.api+json:
8564               examples:
8565                 Example:
8566                   value:
8567                     error: The resource you were looking for could not be found.
8568               schema:
8569                 "$ref": "#/components/schemas/error"
8570         '401':
8571           description: Authentication Failed
8572           content:
8573             application/vnd.api+json:
8574               examples:
8575                 Example:
8576                   value:
8577                     error: The access token is invalid
8578               schema:
8579                 "$ref": "#/components/schemas/error"
8580     patch:
8581       summary: Update a Promotion Action
8582       tags:
8583       - Promotion Actions
8584       security:
8585       - bearer_auth: []
8586       description: Updates a Promotion Action
8587       operationId: update-promotion-action
8588       parameters:
8589       - name: id
8590         in: path
8591         required: true
8592         schema:
8593           type: string
8594       - name: include
8595         in: query
8596         description: 'Select which associated resources you would like to fetch, see:
8597           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8598         example: calculator
8599         schema:
8600           type: string
8601       responses:
8602         '200':
8603           description: Record updated
8604           content:
8605             application/vnd.api+json:
8606               examples:
8607                 Example:
8608                   value:
8609                     data:
8610                       id: '12'
8611                       type: promotion_action
8612                       attributes:
8613                         position:
8614                         type: Spree::Promotion::Actions::CreateAdjustment
8615                         deleted_at:
8616                         created_at: '2022-11-08T19:34:56.948Z'
8617                         updated_at: '2022-11-08T19:34:57.178Z'
8618                       relationships:
8619                         promotion:
8620                           data:
8621                             id: '10'
8622                             type: promotion
8623               schema:
8624                 "$ref": "#/components/schemas/resource"
8625         '404':
8626           description: Record not found
8627           content:
8628             application/vnd.api+json:
8629               examples:
8630                 Example:
8631                   value:
8632                     error: The resource you were looking for could not be found.
8633               schema:
8634                 "$ref": "#/components/schemas/error"
8635         '401':
8636           description: Authentication Failed
8637           content:
8638             application/vnd.api+json:
8639               examples:
8640                 Example:
8641                   value:
8642                     error: The access token is invalid
8643               schema:
8644                 "$ref": "#/components/schemas/error"
8645       requestBody:
8646         content:
8647           application/json:
8648             schema:
8649               "$ref": "#/components/schemas/update_promotion_action_params"
8650     delete:
8651       summary: Delete a Promotion Action
8652       tags:
8653       - Promotion Actions
8654       security:
8655       - bearer_auth: []
8656       description: Deletes a Promotion Action
8657       operationId: delete-promotion-action
8658       parameters:
8659       - name: id
8660         in: path
8661         required: true
8662         schema:
8663           type: string
8664       responses:
8665         '204':
8666           description: Record deleted
8667         '404':
8668           description: Record not found
8669           content:
8670             application/vnd.api+json:
8671               examples:
8672                 Example:
8673                   value:
8674                     error: The resource you were looking for could not be found.
8675               schema:
8676                 "$ref": "#/components/schemas/error"
8677         '401':
8678           description: Authentication Failed
8679           content:
8680             application/vnd.api+json:
8681               examples:
8682                 Example:
8683                   value:
8684                     error: The access token is invalid
8685               schema:
8686                 "$ref": "#/components/schemas/error"
8687   "/api/v2/platform/promotion_categories":
8688     get:
8689       summary: Return a list of Promotion Categories
8690       tags:
8691       - Promotion Categories
8692       security:
8693       - bearer_auth: []
8694       description: Returns a list of Promotion Categories
8695       operationId: promotion-categories-list
8696       parameters:
8697       - name: page
8698         in: query
8699         example: 1
8700         schema:
8701           type: integer
8702       - name: per_page
8703         in: query
8704         example: 50
8705         schema:
8706           type: integer
8707       - name: include
8708         in: query
8709         description: 'Select which associated resources you would like to fetch, see:
8710           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8711         example: promotions
8712         schema:
8713           type: string
8714       - name: filter[code_eq]
8715         in: query
8716         description: ''
8717         example: BLK-FRI
8718         schema:
8719           type: string
8720       - name: filter[name_eq]
8721         in: query
8722         description: ''
8723         example: 2020 Promotions
8724         schema:
8725           type: string
8726       responses:
8727         '200':
8728           description: Records returned
8729           content:
8730             application/vnd.api+json:
8731               examples:
8732                 Example:
8733                   value:
8734                     data:
8735                     - id: '1'
8736                       type: promotion_category
8737                       attributes:
8738                         name: Promotion Category
8739                         created_at: '2022-11-08T19:34:58.013Z'
8740                         updated_at: '2022-11-08T19:34:58.013Z'
8741                         code: POP123
8742                       relationships:
8743                         promotions:
8744                           data: []
8745                     - id: '2'
8746                       type: promotion_category
8747                       attributes:
8748                         name: Promotion Category
8749                         created_at: '2022-11-08T19:34:58.014Z'
8750                         updated_at: '2022-11-08T19:34:58.014Z'
8751                         code: POP123
8752                       relationships:
8753                         promotions:
8754                           data: []
8755                     meta:
8756                       count: 2
8757                       total_count: 2
8758                       total_pages: 1
8759                     links:
8760                       self: http://www.example.com/api/v2/platform/promotion_categories?page=1&per_page=&include=&filter[code_eq]=&filter[name_eq]=
8761                       next: http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=
8762                       prev: http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=
8763                       last: http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=
8764                       first: http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=
8765               schema:
8766                 "$ref": "#/components/schemas/resources_list"
8767         '401':
8768           description: Authentication Failed
8769           content:
8770             application/vnd.api+json:
8771               examples:
8772                 Example:
8773                   value:
8774                     error: The access token is invalid
8775               schema:
8776                 "$ref": "#/components/schemas/error"
8777     post:
8778       summary: Create a Promotion Category
8779       tags:
8780       - Promotion Categories
8781       security:
8782       - bearer_auth: []
8783       description: Creates a Promotion Category
8784       operationId: create-promotion-category
8785       parameters:
8786       - name: include
8787         in: query
8788         description: 'Select which associated resources you would like to fetch, see:
8789           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8790         example: promotions
8791         schema:
8792           type: string
8793       responses:
8794         '201':
8795           description: Record created
8796           content:
8797             application/vnd.api+json:
8798               examples:
8799                 Example:
8800                   value:
8801                     data:
8802                       id: '5'
8803                       type: promotion_category
8804                       attributes:
8805                         name: Promotion Category
8806                         created_at: '2022-11-08T19:34:58.529Z'
8807                         updated_at: '2022-11-08T19:34:58.529Z'
8808                         code: 2021-BFM
8809                       relationships:
8810                         promotions:
8811                           data: []
8812               schema:
8813                 "$ref": "#/components/schemas/resource"
8814         '422':
8815           description: Invalid request
8816           content:
8817             application/vnd.api+json:
8818               examples:
8819                 Example:
8820                   value:
8821                     error: Name can't be blank
8822                     errors:
8823                       name:
8824                       - can't be blank
8825               schema:
8826                 "$ref": "#/components/schemas/validation_errors"
8827       requestBody:
8828         content:
8829           application/json:
8830             schema:
8831               "$ref": "#/components/schemas/create_promotion_category_params"
8832   "/api/v2/platform/promotion_categories/{id}":
8833     get:
8834       summary: Return a Promotion Category
8835       tags:
8836       - Promotion Categories
8837       security:
8838       - bearer_auth: []
8839       description: Returns a Promotion Category
8840       operationId: show-promotion-category
8841       parameters:
8842       - name: id
8843         in: path
8844         required: true
8845         schema:
8846           type: string
8847       - name: include
8848         in: query
8849         description: 'Select which associated resources you would like to fetch, see:
8850           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8851         example: promotions
8852         schema:
8853           type: string
8854       responses:
8855         '200':
8856           description: Record found
8857           content:
8858             application/vnd.api+json:
8859               examples:
8860                 Example:
8861                   value:
8862                     data:
8863                       id: '6'
8864                       type: promotion_category
8865                       attributes:
8866                         name: Promotion Category
8867                         created_at: '2022-11-08T19:34:58.794Z'
8868                         updated_at: '2022-11-08T19:34:58.794Z'
8869                         code: MJO
8870                       relationships:
8871                         promotions:
8872                           data: []
8873               schema:
8874                 "$ref": "#/components/schemas/resource"
8875         '404':
8876           description: Record not found
8877           content:
8878             application/vnd.api+json:
8879               examples:
8880                 Example:
8881                   value:
8882                     error: The resource you were looking for could not be found.
8883               schema:
8884                 "$ref": "#/components/schemas/error"
8885         '401':
8886           description: Authentication Failed
8887           content:
8888             application/vnd.api+json:
8889               examples:
8890                 Example:
8891                   value:
8892                     error: The access token is invalid
8893               schema:
8894                 "$ref": "#/components/schemas/error"
8895     patch:
8896       summary: Update a Promotion Category
8897       tags:
8898       - Promotion Categories
8899       security:
8900       - bearer_auth: []
8901       description: Updates a Promotion Category
8902       operationId: update-promotion-category
8903       parameters:
8904       - name: id
8905         in: path
8906         required: true
8907         schema:
8908           type: string
8909       - name: include
8910         in: query
8911         description: 'Select which associated resources you would like to fetch, see:
8912           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
8913         example: promotions
8914         schema:
8915           type: string
8916       responses:
8917         '200':
8918           description: Record updated
8919           content:
8920             application/vnd.api+json:
8921               examples:
8922                 Example:
8923                   value:
8924                     data:
8925                       id: '8'
8926                       type: promotion_category
8927                       attributes:
8928                         name: 2021 Promotions
8929                         created_at: '2022-11-08T19:34:59.309Z'
8930                         updated_at: '2022-11-08T19:34:59.539Z'
8931                         code: 2021-Promos
8932                       relationships:
8933                         promotions:
8934                           data: []
8935               schema:
8936                 "$ref": "#/components/schemas/resource"
8937         '422':
8938           description: Invalid request
8939           content:
8940             application/vnd.api+json:
8941               examples:
8942                 Example:
8943                   value:
8944                     error: Name can't be blank
8945                     errors:
8946                       name:
8947                       - can't be blank
8948               schema:
8949                 "$ref": "#/components/schemas/validation_errors"
8950         '404':
8951           description: Record not found
8952           content:
8953             application/vnd.api+json:
8954               examples:
8955                 Example:
8956                   value:
8957                     error: The resource you were looking for could not be found.
8958               schema:
8959                 "$ref": "#/components/schemas/error"
8960         '401':
8961           description: Authentication Failed
8962           content:
8963             application/vnd.api+json:
8964               examples:
8965                 Example:
8966                   value:
8967                     error: The access token is invalid
8968               schema:
8969                 "$ref": "#/components/schemas/error"
8970       requestBody:
8971         content:
8972           application/json:
8973             schema:
8974               "$ref": "#/components/schemas/update_promotion_category_params"
8975     delete:
8976       summary: Delete a Promotion Category
8977       tags:
8978       - Promotion Categories
8979       security:
8980       - bearer_auth: []
8981       description: Deletes a Promotion Category
8982       operationId: delete-promotion-category
8983       parameters:
8984       - name: id
8985         in: path
8986         required: true
8987         schema:
8988           type: string
8989       responses:
8990         '204':
8991           description: Record deleted
8992         '404':
8993           description: Record not found
8994           content:
8995             application/vnd.api+json:
8996               examples:
8997                 Example:
8998                   value:
8999                     error: The resource you were looking for could not be found.
9000               schema:
9001                 "$ref": "#/components/schemas/error"
9002         '401':
9003           description: Authentication Failed
9004           content:
9005             application/vnd.api+json:
9006               examples:
9007                 Example:
9008                   value:
9009                     error: The access token is invalid
9010               schema:
9011                 "$ref": "#/components/schemas/error"
9012   "/api/v2/platform/promotion_rules":
9013     get:
9014       summary: Return a list of Promotion Rules
9015       tags:
9016       - Promotion Rules
9017       security:
9018       - bearer_auth: []
9019       description: Returns a list of Promotion Rules
9020       operationId: promotion-rules-list
9021       parameters:
9022       - name: page
9023         in: query
9024         example: 1
9025         schema:
9026           type: integer
9027       - name: per_page
9028         in: query
9029         example: 50
9030         schema:
9031           type: integer
9032       - name: include
9033         in: query
9034         description: 'Select which associated resources you would like to fetch, see:
9035           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
9036         example: user
9037         schema:
9038           type: string
9039       - name: filter[type_eq]
9040         in: query
9041         description: ''
9042         example: Spree::Promotion::Rules::Product
9043         schema:
9044           type: string
9045       responses:
9046         '200':
9047           description: Records returned
9048           content:
9049             application/vnd.api+json:
9050               examples:
9051                 Example:
9052                   value:
9053                     data:
9054                     - id: '1'
9055                       type: promotion_rule
9056                       attributes:
9057                         type:
9058                         created_at: '2022-11-08T19:35:00.589Z'
9059                         updated_at: '2022-11-08T19:35:00.589Z'
9060                         code:
9061                         preferences: {}
9062                       relationships:
9063                         promotion:
9064                           data:
9065                             id: '14'
9066                             type: promotion
9067                     - id: '2'
9068                       type: promotion_rule
9069                       attributes:
9070                         type:
9071                         created_at: '2022-11-08T19:35:00.591Z'
9072                         updated_at: '2022-11-08T19:35:00.591Z'
9073                         code:
9074                         preferences: {}
9075                       relationships:
9076                         promotion:
9077                           data:
9078                             id: '14'
9079                             type: promotion
9080                     meta:
9081                       count: 2
9082                       total_count: 2
9083                       total_pages: 1
9084                     links:
9085                       self: http://www.example.com/api/v2/platform/promotion_rules?page=1&per_page=&include=&filter[type_eq]=
9086                       next: http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=
9087                       prev: http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=
9088                       last: http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=
9089                       first: http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=
9090               schema:
9091                 "$ref": "#/components/schemas/resources_list"
9092         '401':
9093           description: Authentication Failed
9094           content:
9095             application/vnd.api+json:
9096               examples:
9097                 Example:
9098                   value:
9099                     error: The access token is invalid
9100               schema:
9101                 "$ref": "#/components/schemas/error"
9102     post:
9103       summary: Create a Promotion Rule
9104       tags:
9105       - Promotion Rules
9106       security:
9107       - bearer_auth: []
9108       description: Creates a Promotion Rule
9109       operationId: create-promotion-rule
9110       parameters:
9111       - name: include
9112         in: query
9113         description: 'Select which associated resources you would like to fetch, see:
9114           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
9115         example: user
9116         schema:
9117           type: string
9118       responses:
9119         '201':
9120           description: Record created
9121           content:
9122             application/vnd.api+json:
9123               examples:
9124                 Example:
9125                   value:
9126                     data:
9127                       id: '5'
9128                       type: promotion_rule
9129                       attributes:
9130                         type:
9131                         created_at: '2022-11-08T19:35:01.131Z'
9132                         updated_at: '2022-11-08T19:35:01.131Z'
9133                         code:
9134                         preferences: {}
9135                       relationships:
9136                         promotion:
9137                           data:
9138                             id: '16'
9139                             type: promotion
9140               schema:
9141                 "$ref": "#/components/schemas/resource"
9142       requestBody:
9143         content:
9144           application/json:
9145             schema:
9146               "$ref": "#/components/schemas/create_promotion_rule_params"
9147   "/api/v2/platform/promotion_rules/{id}":
9148     get:
9149       summary: Return a Promotion Rule
9150       tags:
9151       - Promotion Rules
9152       security:
9153       - bearer_auth: []
9154       description: Returns a Promotion Rule
9155       operationId: show-promotion-rule
9156       parameters:
9157       - name: id
9158         in: path
9159         required: true
9160         schema:
9161           type: string
9162       - name: include
9163         in: query
9164         description: 'Select which associated resources you would like to fetch, see:
9165           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
9166         example: user
9167         schema:
9168           type: string
9169       responses:
9170         '200':
9171           description: Record found
9172           content:
9173             application/vnd.api+json:
9174               examples:
9175                 Example:
9176                   value:
9177                     data:
9178                       id: '6'
9179                       type: promotion_rule
9180                       attributes:
9181                         type:
9182                         created_at: '2022-11-08T19:35:01.163Z'
9183                         updated_at: '2022-11-08T19:35:01.163Z'
9184                         code:
9185                         preferences: {}
9186                       relationships:
9187                         promotion:
9188                           data:
9189                             id: '17'
9190                             type: promotion
9191               schema:
9192                 "$ref": "#/components/schemas/resource"
9193         '404':
9194           description: Record not found
9195           content:
9196             application/vnd.api+json:
9197               examples:
9198                 Example:
9199                   value:
9200                     error: The resource you were looking for could not be found.
9201               schema:
9202                 "$ref": "#/components/schemas/error"
9203         '401':
9204           description: Authentication Failed
9205           content:
9206             application/vnd.api+json:
9207               examples:
9208                 Example:
9209                   value:
9210                     error: The access token is invalid
9211               schema:
9212                 "$ref": "#/components/schemas/error"
9213     patch:
9214       summary: Update a Promotion Rule
9215       tags:
9216       - Promotion Rules
9217       security:
9218       - bearer_auth: []
9219       description: Updates a Promotion Rule
9220       operationId: update-promotion-rule
9221       parameters:
9222       - name: id
9223         in: path
9224         required: true
9225         schema:
9226           type: string
9227       - name: include
9228         in: query
9229         description: 'Select which associated resources you would like to fetch, see:
9230           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
9231         example: user
9232         schema:
9233           type: string
9234       responses:
9235         '200':
9236           description: Record updated
9237           content:
9238             application/vnd.api+json:
9239               examples:
9240                 Example:
9241                   value:
9242                     data:
9243                       id: '8'
9244                       type: promotion_rule
9245                       attributes:
9246                         type: Spree::Promotion::Rules::Country
9247                         created_at: '2022-11-08T19:35:01.723Z'
9248                         updated_at: '2022-11-08T19:35:01.953Z'
9249                         code:
9250                         preferences: {}
9251                       relationships:
9252                         promotion:
9253                           data:
9254                             id: '19'
9255                             type: promotion
9256               schema:
9257                 "$ref": "#/components/schemas/resource"
9258         '404':
9259           description: Record not found
9260           content:
9261             application/vnd.api+json:
9262               examples:
9263                 Example:
9264                   value:
9265                     error: The resource you were looking for could not be found.
9266               schema:
9267                 "$ref": "#/components/schemas/error"
9268         '401':
9269           description: Authentication Failed
9270           content:
9271             application/vnd.api+json:
9272               examples:
9273                 Example:
9274                   value:
9275                     error: The access token is invalid
9276               schema:
9277                 "$ref": "#/components/schemas/error"
9278       requestBody:
9279         content:
9280           application/json:
9281             schema:
9282               "$ref": "#/components/schemas/update_promotion_rule_params"
9283     delete:
9284       summary: Delete a Promotion Rule
9285       tags:
9286       - Promotion Rules
9287       security:
9288       - bearer_auth: []
9289       description: Deletes a Promotion Rule
9290       operationId: delete-promotion-rule
9291       parameters:
9292       - name: id
9293         in: path
9294         required: true
9295         schema:
9296           type: string
9297       responses:
9298         '204':
9299           description: Record deleted
9300         '404':
9301           description: Record not found
9302           content:
9303             application/vnd.api+json:
9304               examples:
9305                 Example:
9306                   value:
9307                     error: The resource you were looking for could not be found.
9308               schema:
9309                 "$ref": "#/components/schemas/error"
9310         '401':
9311           description: Authentication Failed
9312           content:
9313             application/vnd.api+json:
9314               examples:
9315                 Example:
9316                   value:
9317                     error: The access token is invalid
9318               schema:
9319                 "$ref": "#/components/schemas/error"
9320   "/api/v2/platform/promotions":
9321     get:
9322       summary: Return a list of Promotions
9323       tags:
9324       - Promotions
9325       security:
9326       - bearer_auth: []
9327       description: Returns a list of Promotions
9328       operationId: promotions-list
9329       parameters:
9330       - name: page
9331         in: query
9332         example: 1
9333         schema:
9334           type: integer
9335       - name: per_page
9336         in: query
9337         example: 50
9338         schema:
9339           type: integer
9340       - name: include
9341         in: query
9342         description: 'Select which associated resources you would like to fetch, see:
9343           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
9344         example: promotion_category,promotion_rules,promotion_actions,stores
9345         schema:
9346           type: string
9347       - name: filter[code_eq]
9348         in: query
9349         description: ''
9350         example: BLK-FRI
9351         schema:
9352           type: string
9353       - name: filter[name_cont]
9354         in: query
9355         description: ''
9356         example: New Customer
9357         schema:
9358           type: string
9359       responses:
9360         '200':
9361           description: Records returned
9362           content:
9363             application/vnd.api+json:
9364               examples:
9365                 Example:
9366                   value:
9367                     data:
9368                     - id: '23'
9369                       type: promotion
9370                       attributes:
9371                         description:
9372                         expires_at:
9373                         starts_at:
9374                         name: Promo
9375                         type:
9376                         usage_limit:
9377                         match_policy: all
9378                         code:
9379                         advertise: false
9380                         path:
9381                         created_at: '2022-11-08T19:35:02.793Z'
9382                         updated_at: '2022-11-08T19:35:02.795Z'
9383                         public_metadata: {}
9384                         private_metadata: {}
9385                       relationships:
9386                         promotion_category:
9387                           data:
9388                         promotion_rules:
9389                           data: []
9390                         promotion_actions:
9391                           data: []
9392                         stores:
9393                           data:
9394                           - id: '375'
9395                             type: store
9396                     - id: '24'
9397                       type: promotion
9398                       attributes:
9399                         description:
9400                         expires_at:
9401                         starts_at:
9402                         name: Promo
9403                         type:
9404                         usage_limit:
9405                         match_policy: all
9406                         code:
9407                         advertise: false
9408                         path:
9409                         created_at: '2022-11-08T19:35:02.805Z'
9410                         updated_at: '2022-11-08T19:35:02.807Z'
9411                         public_metadata: {}
9412                         private_metadata: {}
9413                       relationships:
9414                         promotion_category:
9415                           data:
9416                             id: '13'
9417                             type: promotion_category
9418                         promotion_rules:
9419                           data: []
9420                         promotion_actions:
9421                           data:
9422                           - id: '16'
9423                             type: promotion_action
9424                         stores:
9425                           data:
9426                           - id: '375'
9427                             type: store
9428                     - id: '25'
9429                       type: promotion
9430                       attributes:
9431                         description:
9432                         expires_at:
9433                         starts_at:
9434                         name: Promo
9435                         type:
9436                         usage_limit:
9437                         match_policy: all
9438                         code:
9439                         advertise: false
9440                         path:
9441                         created_at: '2022-11-08T19:35:02.822Z'
9442                         updated_at: '2022-11-08T19:35:02.824Z'
9443                         public_metadata: {}
9444                         private_metadata: {}
9445                       relationships:
9446                         promotion_category:
9447                           data:
9448                             id: '13'
9449                             type: promotion_category
9450                         promotion_rules:
9451                           data: []
9452                         promotion_actions:
9453                           data:
9454                           - id: '17'
9455                             type: promotion_action
9456                         stores:
9457                           data:
9458                           - id: '375'
9459                             type: store
9460                     - id: '26'
9461                       type: promotion
9462                       attributes:
9463                         description:
9464                         expires_at:
9465                         starts_at:
9466                         name: Promo
9467                         type:
9468                         usage_limit:
9469                         match_policy: all
9470                         code:
9471                         advertise: false
9472                         path:
9473                         created_at: '2022-11-08T19:35:02.837Z'
9474                         updated_at: '2022-11-08T19:35:02.839Z'
9475                         public_metadata: {}
9476                         private_metadata: {}
9477                       relationships:
9478                         promotion_category:
9479                           data:
9480                             id: '13'
9481                             type: promotion_category
9482                         promotion_rules:
9483                           data:
9484                           - id: '12'
9485                             type: promotion_rule
9486                         promotion_actions:
9487                           data:
9488                           - id: '18'
9489                             type: promotion_action
9490                         stores:
9491                           data:
9492                           - id: '375'
9493                             type: store
9494                     meta:
9495                       count: 4
9496                       total_count: 4
9497                       total_pages: 1
9498                     links:
9499                       self: http://www.example.com/api/v2/platform/promotions?page=1&per_page=&include=&filter[code_eq]=&filter[name_cont]=
9500                       next: http://www.example.com/api/v2/platform/promotions?filter%5Bcode_eq%5D=&filter%5Bname_cont%5D=&include=&page=1&per_page=
9501                       prev: http://www.example.com/api/v2/platform/promotions?filter%5Bcode_eq%5D=&filter%5Bname_cont%5D=&include=&page=1&per_page=
9502                       last: http://www.example.com/api/v2/platform/promotions?filter%5Bcode_eq%5D=&filter%5Bname_cont%5D=&include=&page=1&per_page=
9503                       first: http://www.example.com/api/v2/platform/promotions?filter%5Bcode_eq%5D=&filter%5Bname_cont%5D=&include=&page=1&per_page=
9504               schema:
9505                 "$ref": "#/components/schemas/resources_list"
9506         '401':
9507           description: Authentication Failed
9508           content:
9509             application/vnd.api+json:
9510               examples:
9511                 Example:
9512                   value:
9513                     error: The access token is invalid
9514               schema:
9515                 "$ref": "#/components/schemas/error"
9516     post:
9517       summary: Create a Promotion
9518       tags:
9519       - Promotions
9520       security:
9521       - bearer_auth: []
9522       description: Creates a Promotion
9523       operationId: create-promotion
9524       parameters:
9525       - name: include
9526         in: query
9527         description: 'Select which associated resources you would like to fetch, see:
9528           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
9529         example: promotion_category,promotion_rules,promotion_actions,stores
9530         schema:
9531           type: string
9532       responses:
9533         '201':
9534           description: Record created
9535           content:
9536             application/vnd.api+json:
9537               examples:
9538                 Example:
9539                   value:
9540                     data:
9541                       id: '35'
9542                       type: promotion
9543                       attributes:
9544                         description: First 1000 Customers Save 20%
9545                         expires_at: '2022-11-12T19:35:03.283Z'
9546                         starts_at: '2022-11-08T19:35:03.283Z'
9547                         name: Black Friday 20% Off
9548                         type: Spree::Promotion
9549                         usage_limit: 1000
9550                         match_policy: any
9551                         code: BLK-20
9552                         advertise: true
9553                         path: "/black-fri/today"
9554                         created_at: '2022-11-08T19:35:03.521Z'
9555                         updated_at: '2022-11-08T19:35:03.533Z'
9556                         public_metadata: {}
9557                         private_metadata: {}
9558                       relationships:
9559                         promotion_category:
9560                           data:
9561                             id: '15'
9562                             type: promotion_category
9563                         promotion_rules:
9564                           data: []
9565                         promotion_actions:
9566                           data: []
9567                         stores:
9568                           data:
9569                           - id: '382'
9570                             type: store
9571                           - id: '383'
9572                             type: store
9573                           - id: '381'
9574                             type: store
9575               schema:
9576                 "$ref": "#/components/schemas/resource"
9577         '422':
9578           description: Invalid request
9579           content:
9580             application/vnd.api+json:
9581               examples:
9582                 Example:
9583                   value:
9584                     error: Name can't be blank
9585                     errors:
9586                       name:
9587                       - can't be blank
9588               schema:
9589                 "$ref": "#/components/schemas/validation_errors"
9590       requestBody:
9591         content:
9592           application/json:
9593             schema:
9594               "$ref": "#/components/schemas/create_promotion_params"
9595   "/api/v2/platform/promotions/{id}":
9596     get:
9597       summary: Return a Promotion
9598       tags:
9599       - Promotions
9600       security:
9601       - bearer_auth: []
9602       description: Returns a Promotion
9603       operationId: show-promotion
9604       parameters:
9605       - name: id
9606         in: path
9607         required: true
9608         schema:
9609           type: string
9610       - name: include
9611         in: query
9612         description: 'Select which associated resources you would like to fetch, see:
9613           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
9614         example: promotion_category,promotion_rules,promotion_actions,stores
9615         schema:
9616           type: string
9617       responses:
9618         '200':
9619           description: Record found
9620           content:
9621             application/vnd.api+json:
9622               examples:
9623                 Example:
9624                   value:
9625                     data:
9626                       id: '44'
9627                       type: promotion
9628                       attributes:
9629                         description:
9630                         expires_at:
9631                         starts_at:
9632                         name: Promo
9633                         type:
9634                         usage_limit:
9635                         match_policy: all
9636                         code:
9637                         advertise: false
9638                         path:
9639                         created_at: '2022-11-08T19:35:03.971Z'
9640                         updated_at: '2022-11-08T19:35:03.973Z'
9641                         public_metadata: {}
9642                         private_metadata: {}
9643                       relationships:
9644                         promotion_category:
9645                           data:
9646                             id: '17'
9647                             type: promotion_category
9648                         promotion_rules:
9649                           data:
9650                           - id: '16'
9651                             type: promotion_rule
9652                         promotion_actions:
9653                           data:
9654                           - id: '31'
9655                             type: promotion_action
9656                         stores:
9657                           data:
9658                           - id: '387'
9659                             type: store
9660               schema:
9661                 "$ref": "#/components/schemas/resource"
9662         '404':
9663           description: Record not found
9664           content:
9665             application/vnd.api+json:
9666               examples:
9667                 Example:
9668                   value:
9669                     error: The resource you were looking for could not be found.
9670               schema:
9671                 "$ref": "#/components/schemas/error"
9672         '401':
9673           description: Authentication Failed
9674           content:
9675             application/vnd.api+json:
9676               examples:
9677                 Example:
9678                   value:
9679                     error: The access token is invalid
9680               schema:
9681                 "$ref": "#/components/schemas/error"
9682     patch:
9683       summary: Update a Promotion
9684       tags:
9685       - Promotions
9686       security:
9687       - bearer_auth: []
9688       description: Updates a Promotion
9689       operationId: update-promotion
9690       parameters:
9691       - name: id
9692         in: path
9693         required: true
9694         schema:
9695           type: string
9696       - name: include
9697         in: query
9698         description: 'Select which associated resources you would like to fetch, see:
9699           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
9700         example: promotion_category,promotion_rules,promotion_actions,stores
9701         schema:
9702           type: string
9703       responses:
9704         '200':
9705           description: Record updated
9706           content:
9707             application/vnd.api+json:
9708               examples:
9709                 Example:
9710                   value:
9711                     data:
9712                       id: '58'
9713                       type: promotion
9714                       attributes:
9715                         description: This is the new updated promo
9716                         expires_at:
9717                         starts_at:
9718                         name: 10% OFF
9719                         type:
9720                         usage_limit:
9721                         match_policy: all
9722                         code: RAND-10
9723                         advertise: false
9724                         path:
9725                         created_at: '2022-11-08T19:35:04.723Z'
9726                         updated_at: '2022-11-08T19:35:04.970Z'
9727                         public_metadata: {}
9728                         private_metadata: {}
9729                       relationships:
9730                         promotion_category:
9731                           data:
9732                             id: '20'
9733                             type: promotion_category
9734                         promotion_rules:
9735                           data:
9736                           - id: '19'
9737                             type: promotion_rule
9738                         promotion_actions:
9739                           data:
9740                           - id: '42'
9741                             type: promotion_action
9742                         stores:
9743                           data:
9744                           - id: '396'
9745                             type: store
9746               schema:
9747                 "$ref": "#/components/schemas/resource"
9748         '422':
9749           description: Invalid request
9750           content:
9751             application/vnd.api+json:
9752               examples:
9753                 Example:
9754                   value:
9755                     error: Name can't be blank
9756                     errors:
9757                       name:
9758                       - can't be blank
9759               schema:
9760                 "$ref": "#/components/schemas/validation_errors"
9761         '404':
9762           description: Record not found
9763           content:
9764             application/vnd.api+json:
9765               examples:
9766                 Example:
9767                   value:
9768                     error: The resource you were looking for could not be found.
9769               schema:
9770                 "$ref": "#/components/schemas/error"
9771         '401':
9772           description: Authentication Failed
9773           content:
9774             application/vnd.api+json:
9775               examples:
9776                 Example:
9777                   value:
9778                     error: The access token is invalid
9779               schema:
9780                 "$ref": "#/components/schemas/error"
9781       requestBody:
9782         content:
9783           application/json:
9784             schema:
9785               oneOf:
9786               - "$ref": "#/components/schemas/update_promotion_params"
9787               - "$ref": "#/components/schemas/update_promotion_add_rule_params"
9788               - "$ref": "#/components/schemas/update_promotion_update_rule_params"
9789               - "$ref": "#/components/schemas/update_promotion_add_action_params"
9790               - "$ref": "#/components/schemas/update_promotion_change_action_params"
9791               - "$ref": "#/components/schemas/update_promotion_action_calculator_params"
9792               - "$ref": "#/components/schemas/update_promotion_change_calculator_params"
9793     delete:
9794       summary: Delete a Promotion
9795       tags:
9796       - Promotions
9797       security:
9798       - bearer_auth: []
9799       description: Deletes a Promotion
9800       operationId: delete-promotion
9801       parameters:
9802       - name: id
9803         in: path
9804         required: true
9805         schema:
9806           type: string
9807       responses:
9808         '204':
9809           description: Record deleted
9810         '404':
9811           description: Record not found
9812           content:
9813             application/vnd.api+json:
9814               examples:
9815                 Example:
9816                   value:
9817                     error: The resource you were looking for could not be found.
9818               schema:
9819                 "$ref": "#/components/schemas/error"
9820         '401':
9821           description: Authentication Failed
9822           content:
9823             application/vnd.api+json:
9824               examples:
9825                 Example:
9826                   value:
9827                     error: The access token is invalid
9828               schema:
9829                 "$ref": "#/components/schemas/error"
9830   "/api/v2/platform/roles":
9831     get:
9832       summary: Return a list of Roles
9833       tags:
9834       - Roles
9835       security:
9836       - bearer_auth: []
9837       description: Returns a list of Roles
9838       operationId: roles-list
9839       parameters:
9840       - name: page
9841         in: query
9842         example: 1
9843         schema:
9844           type: integer
9845       - name: per_page
9846         in: query
9847         example: 50
9848         schema:
9849           type: integer
9850       - name: filter[name_eq]
9851         in: query
9852         description: ''
9853         example: admin
9854         schema:
9855           type: string
9856       responses:
9857         '200':
9858           description: Records returned
9859           content:
9860             application/vnd.api+json:
9861               examples:
9862                 Example:
9863                   value:
9864                     data:
9865                     - id: '1'
9866                       type: role
9867                       attributes:
9868                         name: Role 1
9869                         created_at: '2022-11-08T19:35:06.596Z'
9870                         updated_at: '2022-11-08T19:35:06.596Z'
9871                     - id: '2'
9872                       type: role
9873                       attributes:
9874                         name: Role 2
9875                         created_at: '2022-11-08T19:35:06.597Z'
9876                         updated_at: '2022-11-08T19:35:06.597Z'
9877                     meta:
9878                       count: 2
9879                       total_count: 2
9880                       total_pages: 1
9881                     links:
9882                       self: http://www.example.com/api/v2/platform/roles?page=1&per_page=&filter[name_eq]=
9883                       next: http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=
9884                       prev: http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=
9885                       last: http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=
9886                       first: http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=
9887               schema:
9888                 "$ref": "#/components/schemas/resources_list"
9889         '401':
9890           description: Authentication Failed
9891           content:
9892             application/vnd.api+json:
9893               examples:
9894                 Example:
9895                   value:
9896                     error: The access token is invalid
9897               schema:
9898                 "$ref": "#/components/schemas/error"
9899     post:
9900       summary: Create a Role
9901       tags:
9902       - Roles
9903       security:
9904       - bearer_auth: []
9905       description: Creates a Role
9906       operationId: create-role
9907       parameters: []
9908       responses:
9909         '201':
9910           description: Record created
9911           content:
9912             application/vnd.api+json:
9913               examples:
9914                 Example:
9915                   value:
9916                     data:
9917                       id: '5'
9918                       type: role
9919                       attributes:
9920                         name: Role 5
9921                         created_at: '2022-11-08T19:35:07.110Z'
9922                         updated_at: '2022-11-08T19:35:07.110Z'
9923               schema:
9924                 "$ref": "#/components/schemas/resource"
9925         '422':
9926           description: Invalid request
9927           content:
9928             application/vnd.api+json:
9929               examples:
9930                 Example:
9931                   value:
9932                     error: Name can't be blank
9933                     errors:
9934                       name:
9935                       - can't be blank
9936               schema:
9937                 "$ref": "#/components/schemas/validation_errors"
9938       requestBody:
9939         content:
9940           application/json:
9941             schema:
9942               "$ref": "#/components/schemas/create_role_params"
9943   "/api/v2/platform/roles/{id}":
9944     get:
9945       summary: Return a Role
9946       tags:
9947       - Roles
9948       security:
9949       - bearer_auth: []
9950       description: Returns a Role
9951       operationId: show-role
9952       parameters:
9953       - name: id
9954         in: path
9955         required: true
9956         schema:
9957           type: string
9958       responses:
9959         '200':
9960           description: Record found
9961           content:
9962             application/vnd.api+json:
9963               examples:
9964                 Example:
9965                   value:
9966                     data:
9967                       id: '6'
9968                       type: role
9969                       attributes:
9970                         name: Role 6
9971                         created_at: '2022-11-08T19:35:07.384Z'
9972                         updated_at: '2022-11-08T19:35:07.384Z'
9973               schema:
9974                 "$ref": "#/components/schemas/resource"
9975         '404':
9976           description: Record not found
9977           content:
9978             application/vnd.api+json:
9979               examples:
9980                 Example:
9981                   value:
9982                     error: The resource you were looking for could not be found.
9983               schema:
9984                 "$ref": "#/components/schemas/error"
9985         '401':
9986           description: Authentication Failed
9987           content:
9988             application/vnd.api+json:
9989               examples:
9990                 Example:
9991                   value:
9992                     error: The access token is invalid
9993               schema:
9994                 "$ref": "#/components/schemas/error"
9995     patch:
9996       summary: Update a Role
9997       tags:
9998       - Roles
9999       security:
10000       - bearer_auth: []
10001       description: Updates a Role
10002       operationId: update-role
10003       parameters:
10004       - name: id
10005         in: path
10006         required: true
10007         schema:
10008           type: string
10009       responses:
10010         '200':
10011           description: Record updated
10012           content:
10013             application/vnd.api+json:
10014               examples:
10015                 Example:
10016                   value:
10017                     data:
10018                       id: '8'
10019                       type: role
10020                       attributes:
10021                         name: administrator
10022                         created_at: '2022-11-08T19:35:07.901Z'
10023                         updated_at: '2022-11-08T19:35:08.133Z'
10024               schema:
10025                 "$ref": "#/components/schemas/resource"
10026         '422':
10027           description: Invalid request
10028           content:
10029             application/vnd.api+json:
10030               examples:
10031                 Example:
10032                   value:
10033                     error: Name can't be blank
10034                     errors:
10035                       name:
10036                       - can't be blank
10037               schema:
10038                 "$ref": "#/components/schemas/validation_errors"
10039         '404':
10040           description: Record not found
10041           content:
10042             application/vnd.api+json:
10043               examples:
10044                 Example:
10045                   value:
10046                     error: The resource you were looking for could not be found.
10047               schema:
10048                 "$ref": "#/components/schemas/error"
10049         '401':
10050           description: Authentication Failed
10051           content:
10052             application/vnd.api+json:
10053               examples:
10054                 Example:
10055                   value:
10056                     error: The access token is invalid
10057               schema:
10058                 "$ref": "#/components/schemas/error"
10059       requestBody:
10060         content:
10061           application/json:
10062             schema:
10063               "$ref": "#/components/schemas/update_role_params"
10064     delete:
10065       summary: Delete a Role
10066       tags:
10067       - Roles
10068       security:
10069       - bearer_auth: []
10070       description: Deletes a Role
10071       operationId: delete-role
10072       parameters:
10073       - name: id
10074         in: path
10075         required: true
10076         schema:
10077           type: string
10078       responses:
10079         '204':
10080           description: Record deleted
10081         '404':
10082           description: Record not found
10083           content:
10084             application/vnd.api+json:
10085               examples:
10086                 Example:
10087                   value:
10088                     error: The resource you were looking for could not be found.
10089               schema:
10090                 "$ref": "#/components/schemas/error"
10091         '401':
10092           description: Authentication Failed
10093           content:
10094             application/vnd.api+json:
10095               examples:
10096                 Example:
10097                   value:
10098                     error: The access token is invalid
10099               schema:
10100                 "$ref": "#/components/schemas/error"
10101   "/api/v2/platform/shipments":
10102     get:
10103       summary: Return a list of Shipments
10104       tags:
10105       - Shipments
10106       security:
10107       - bearer_auth: []
10108       description: Returns a list of Shipments
10109       operationId: shipments-list
10110       parameters:
10111       - name: page
10112         in: query
10113         example: 1
10114         schema:
10115           type: integer
10116       - name: per_page
10117         in: query
10118         example: 50
10119         schema:
10120           type: integer
10121       - name: include
10122         in: query
10123         description: 'Select which associated resources you would like to fetch, see:
10124           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
10125         example: line_items,variants,product
10126         schema:
10127           type: string
10128       - name: filter[state_eq]
10129         in: query
10130         description: ''
10131         example: complete
10132         schema:
10133           type: string
10134       responses:
10135         '200':
10136           description: Records returned
10137           content:
10138             application/vnd.api+json:
10139               examples:
10140                 Example:
10141                   value:
10142                     data:
10143                     - id: '28'
10144                       type: shipment
10145                       attributes:
10146                         tracking: U10000
10147                         number: H74819281258
10148                         cost: '100.0'
10149                         shipped_at:
10150                         state: pending
10151                         created_at: '2022-11-08T19:35:09.196Z'
10152                         updated_at: '2022-11-08T19:35:09.199Z'
10153                         adjustment_total: '0.0'
10154                         additional_tax_total: '0.0'
10155                         promo_total: '0.0'
10156                         included_tax_total: '0.0'
10157                         pre_tax_amount: '0.0'
10158                         taxable_adjustment_total: '0.0'
10159                         non_taxable_adjustment_total: '0.0'
10160                         public_metadata: {}
10161                         private_metadata: {}
10162                         display_discounted_cost: "$100.00"
10163                         display_item_cost: "$0.00"
10164                         display_amount: "$100.00"
10165                         display_final_price: "$100.00"
10166                         display_cost: "$100.00"
10167                         tracking_url:
10168                       relationships:
10169                         order:
10170                           data:
10171                             id: '78'
10172                             type: order
10173                         address:
10174                           data:
10175                         stock_location:
10176                           data:
10177                             id: '106'
10178                             type: stock_location
10179                         adjustments:
10180                           data: []
10181                         inventory_units:
10182                           data: []
10183                         shipping_rates:
10184                           data:
10185                           - id: '30'
10186                             type: shipping_rate
10187                         state_changes:
10188                           data: []
10189                         selected_shipping_rate:
10190                           data:
10191                             id: '30'
10192                             type: shipping_rate
10193                     - id: '29'
10194                       type: shipment
10195                       attributes:
10196                         tracking: U10000
10197                         number: H45064150244
10198                         cost: '100.0'
10199                         shipped_at:
10200                         state: pending
10201                         created_at: '2022-11-08T19:35:09.230Z'
10202                         updated_at: '2022-11-08T19:35:09.233Z'
10203                         adjustment_total: '0.0'
10204                         additional_tax_total: '0.0'
10205                         promo_total: '0.0'
10206                         included_tax_total: '0.0'
10207                         pre_tax_amount: '0.0'
10208                         taxable_adjustment_total: '0.0'
10209                         non_taxable_adjustment_total: '0.0'
10210                         public_metadata: {}
10211                         private_metadata: {}
10212                         display_discounted_cost: "$100.00"
10213                         display_item_cost: "$0.00"
10214                         display_amount: "$100.00"
10215                         display_final_price: "$100.00"
10216                         display_cost: "$100.00"
10217                         tracking_url:
10218                       relationships:
10219                         order:
10220                           data:
10221                             id: '79'
10222                             type: order
10223                         address:
10224                           data:
10225                         stock_location:
10226                           data:
10227                             id: '107'
10228                             type: stock_location
10229                         adjustments:
10230                           data: []
10231                         inventory_units:
10232                           data: []
10233                         shipping_rates:
10234                           data:
10235                           - id: '31'
10236                             type: shipping_rate
10237                         state_changes:
10238                           data: []
10239                         selected_shipping_rate:
10240                           data:
10241                             id: '31'
10242                             type: shipping_rate
10243                     meta:
10244                       count: 2
10245                       total_count: 2
10246                       total_pages: 1
10247                     links:
10248                       self: http://www.example.com/api/v2/platform/shipments?page=1&per_page=&include=&filter[state_eq]=
10249                       next: http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=
10250                       prev: http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=
10251                       last: http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=
10252                       first: http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=
10253               schema:
10254                 "$ref": "#/components/schemas/resources_list"
10255         '401':
10256           description: Authentication Failed
10257           content:
10258             application/vnd.api+json:
10259               examples:
10260                 Example:
10261                   value:
10262                     error: The access token is invalid
10263               schema:
10264                 "$ref": "#/components/schemas/error"
10265     post:
10266       summary: Create a Shipment
10267       tags:
10268       - Shipments
10269       security:
10270       - bearer_auth: []
10271       description: Creates a Shipment
10272       operationId: create-shipment
10273       parameters:
10274       - name: include
10275         in: query
10276         description: 'Select which associated resources you would like to fetch, see:
10277           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
10278         example: line_items,variants,product
10279         schema:
10280           type: string
10281       responses:
10282         '201':
10283           description: Record created
10284           content:
10285             application/vnd.api+json:
10286               examples:
10287                 Example:
10288                   value:
10289                     data:
10290                       id: '32'
10291                       type: shipment
10292                       attributes:
10293                         tracking:
10294                         number: H86798855348
10295                         cost: '0.0'
10296                         shipped_at:
10297                         state: pending
10298                         created_at: '2022-11-08T19:35:09.957Z'
10299                         updated_at: '2022-11-08T19:35:09.970Z'
10300                         adjustment_total: '0.0'
10301                         additional_tax_total: '0.0'
10302                         promo_total: '0.0'
10303                         included_tax_total: '0.0'
10304                         pre_tax_amount: '0.0'
10305                         taxable_adjustment_total: '0.0'
10306                         non_taxable_adjustment_total: '0.0'
10307                         public_metadata: {}
10308                         private_metadata: {}
10309                         display_discounted_cost: "$0.00"
10310                         display_item_cost: "$19.99"
10311                         display_amount: "$0.00"
10312                         display_final_price: "$0.00"
10313                         display_cost: "$0.00"
10314                         tracking_url:
10315                       relationships:
10316                         order:
10317                           data:
10318                             id: '82'
10319                             type: order
10320                         address:
10321                           data:
10322                         stock_location:
10323                           data:
10324                             id: '110'
10325                             type: stock_location
10326                         adjustments:
10327                           data: []
10328                         inventory_units:
10329                           data:
10330                           - id: '28'
10331                             type: inventory_unit
10332                         shipping_rates:
10333                           data: []
10334                         state_changes:
10335                           data: []
10336                         selected_shipping_rate:
10337                           data:
10338               schema:
10339                 "$ref": "#/components/schemas/resource"
10340         '422':
10341           description: Invalid request
10342           content:
10343             application/vnd.api+json:
10344               examples:
10345                 Example:
10346                   value:
10347                     error: order_not_found
10348                     errors: {}
10349               schema:
10350                 "$ref": "#/components/schemas/validation_errors"
10351       requestBody:
10352         content:
10353           application/json:
10354             schema:
10355               "$ref": "#/components/schemas/create_shipment_params"
10356   "/api/v2/platform/shipments/{id}":
10357     get:
10358       summary: Return a Shipment
10359       tags:
10360       - Shipments
10361       security:
10362       - bearer_auth: []
10363       description: Returns a Shipment
10364       operationId: show-shipment
10365       parameters:
10366       - name: id
10367         in: path
10368         required: true
10369         schema:
10370           type: string
10371       - name: include
10372         in: query
10373         description: 'Select which associated resources you would like to fetch, see:
10374           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
10375         example: line_items,variants,product
10376         schema:
10377           type: string
10378       responses:
10379         '200':
10380           description: Record found
10381           content:
10382             application/vnd.api+json:
10383               examples:
10384                 Example:
10385                   value:
10386                     data:
10387                       id: '34'
10388                       type: shipment
10389                       attributes:
10390                         tracking: U10000
10391                         number: H70979559010
10392                         cost: '100.0'
10393                         shipped_at:
10394                         state: pending
10395                         created_at: '2022-11-08T19:35:10.459Z'
10396                         updated_at: '2022-11-08T19:35:10.475Z'
10397                         adjustment_total: '0.0'
10398                         additional_tax_total: '0.0'
10399                         promo_total: '0.0'
10400                         included_tax_total: '0.0'
10401                         pre_tax_amount: '0.0'
10402                         taxable_adjustment_total: '0.0'
10403                         non_taxable_adjustment_total: '0.0'
10404                         public_metadata: {}
10405                         private_metadata: {}
10406                         display_discounted_cost: "$100.00"
10407                         display_item_cost: "$10.00"
10408                         display_amount: "$100.00"
10409                         display_final_price: "$100.00"
10410                         display_cost: "$100.00"
10411                         tracking_url:
10412                       relationships:
10413                         order:
10414                           data:
10415                             id: '83'
10416                             type: order
10417                         address:
10418                           data:
10419                         stock_location:
10420                           data:
10421                             id: '112'
10422                             type: stock_location
10423                         adjustments:
10424                           data: []
10425                         inventory_units:
10426                           data:
10427                           - id: '30'
10428                             type: inventory_unit
10429                         shipping_rates:
10430                           data:
10431                           - id: '37'
10432                             type: shipping_rate
10433                         state_changes:
10434                           data: []
10435                         selected_shipping_rate:
10436                           data:
10437                             id: '37'
10438                             type: shipping_rate
10439               schema:
10440                 "$ref": "#/components/schemas/resource"
10441         '404':
10442           description: Record not found
10443           content:
10444             application/vnd.api+json:
10445               examples:
10446                 Example:
10447                   value:
10448                     error: The resource you were looking for could not be found.
10449               schema:
10450                 "$ref": "#/components/schemas/error"
10451         '401':
10452           description: Authentication Failed
10453           content:
10454             application/vnd.api+json:
10455               examples:
10456                 Example:
10457                   value:
10458                     error: The access token is invalid
10459               schema:
10460                 "$ref": "#/components/schemas/error"
10461     patch:
10462       summary: Update a Shipment
10463       tags:
10464       - Shipments
10465       security:
10466       - bearer_auth: []
10467       description: Updates a Shipment
10468       operationId: update-shipment
10469       parameters:
10470       - name: id
10471         in: path
10472         required: true
10473         schema:
10474           type: string
10475       - name: include
10476         in: query
10477         description: 'Select which associated resources you would like to fetch, see:
10478           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
10479         example: line_items,variants,product
10480         schema:
10481           type: string
10482       responses:
10483         '200':
10484           description: Record updated
10485           content:
10486             application/vnd.api+json:
10487               examples:
10488                 Example:
10489                   value:
10490                     data:
10491                       id: '38'
10492                       type: shipment
10493                       attributes:
10494                         tracking: MY-TRACKING-NUMBER-1234
10495                         number: H91981279448
10496                         cost: '100.0'
10497                         shipped_at:
10498                         state: pending
10499                         created_at: '2022-11-08T19:35:11.360Z'
10500                         updated_at: '2022-11-08T19:35:11.610Z'
10501                         adjustment_total: '0.0'
10502                         additional_tax_total: '0.0'
10503                         promo_total: '0.0'
10504                         included_tax_total: '0.0'
10505                         pre_tax_amount: '0.0'
10506                         taxable_adjustment_total: '0.0'
10507                         non_taxable_adjustment_total: '0.0'
10508                         public_metadata: {}
10509                         private_metadata: {}
10510                         display_discounted_cost: "$100.00"
10511                         display_item_cost: "$10.00"
10512                         display_amount: "$100.00"
10513                         display_final_price: "$100.00"
10514                         display_cost: "$100.00"
10515                         tracking_url:
10516                       relationships:
10517                         order:
10518                           data:
10519                             id: '85'
10520                             type: order
10521                         address:
10522                           data:
10523                         stock_location:
10524                           data:
10525                             id: '116'
10526                             type: stock_location
10527                         adjustments:
10528                           data: []
10529                         inventory_units:
10530                           data:
10531                           - id: '34'
10532                             type: inventory_unit
10533                         shipping_rates:
10534                           data:
10535                           - id: '45'
10536                             type: shipping_rate
10537                         state_changes:
10538                           data: []
10539                         selected_shipping_rate:
10540                           data:
10541                             id: '45'
10542                             type: shipping_rate
10543               schema:
10544                 "$ref": "#/components/schemas/resource"
10545         '422':
10546           description: Invalid request
10547           content:
10548             application/vnd.api+json:
10549               examples:
10550                 Example:
10551                   value:
10552                     error: Stock location can't be blank
10553                     errors:
10554                       stock_location:
10555                       - can't be blank
10556               schema:
10557                 "$ref": "#/components/schemas/validation_errors"
10558         '404':
10559           description: Record not found
10560           content:
10561             application/vnd.api+json:
10562               examples:
10563                 Example:
10564                   value:
10565                     error: The resource you were looking for could not be found.
10566               schema:
10567                 "$ref": "#/components/schemas/error"
10568         '401':
10569           description: Authentication Failed
10570           content:
10571             application/vnd.api+json:
10572               examples:
10573                 Example:
10574                   value:
10575                     error: The access token is invalid
10576               schema:
10577                 "$ref": "#/components/schemas/error"
10578       requestBody:
10579         content:
10580           application/json:
10581             schema:
10582               "$ref": "#/components/schemas/update_shipment_params"
10583     delete:
10584       summary: Delete a Shipment
10585       tags:
10586       - Shipments
10587       security:
10588       - bearer_auth: []
10589       description: Deletes a Shipment
10590       operationId: delete-shipment
10591       parameters:
10592       - name: id
10593         in: path
10594         required: true
10595         schema:
10596           type: string
10597       responses:
10598         '204':
10599           description: Record deleted
10600         '404':
10601           description: Record not found
10602           content:
10603             application/vnd.api+json:
10604               examples:
10605                 Example:
10606                   value:
10607                     error: The resource you were looking for could not be found.
10608               schema:
10609                 "$ref": "#/components/schemas/error"
10610         '401':
10611           description: Authentication Failed
10612           content:
10613             application/vnd.api+json:
10614               examples:
10615                 Example:
10616                   value:
10617                     error: The access token is invalid
10618               schema:
10619                 "$ref": "#/components/schemas/error"
10620   "/api/v2/platform/shipments/{id}/add_item":
10621     patch:
10622       summary: Adds item (Variant) to an existing Shipment
10623       tags:
10624       - Shipments
10625       security:
10626       - bearer_auth: []
10627       description: If selected Variant was already added to Order it will increase
10628         the quantity of existing Line Item, if not it will create a new Line Item
10629       operationId: add-item-shipment
10630       parameters:
10631       - name: id
10632         in: path
10633         required: true
10634         schema:
10635           type: string
10636       - name: include
10637         in: query
10638         description: 'Select which associated resources you would like to fetch, see:
10639           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
10640         example: line_items,variants,product
10641         schema:
10642           type: string
10643       responses:
10644         '200':
10645           description: Record updated
10646           content:
10647             application/vnd.api+json:
10648               examples:
10649                 Example:
10650                   value:
10651                     data:
10652                       id: '48'
10653                       type: shipment
10654                       attributes:
10655                         tracking: U10000
10656                         number: H80492609966
10657                         cost: '0.0'
10658                         shipped_at:
10659                         state: pending
10660                         created_at: '2022-11-08T19:35:13.675Z'
10661                         updated_at: '2022-11-08T19:35:13.998Z'
10662                         adjustment_total: '0.0'
10663                         additional_tax_total: '0.0'
10664                         promo_total: '0.0'
10665                         included_tax_total: '0.0'
10666                         pre_tax_amount: '0.0'
10667                         taxable_adjustment_total: '0.0'
10668                         non_taxable_adjustment_total: '0.0'
10669                         public_metadata: {}
10670                         private_metadata: {}
10671                         display_discounted_cost: "$0.00"
10672                         display_item_cost: "$29.99"
10673                         display_amount: "$0.00"
10674                         display_final_price: "$0.00"
10675                         display_cost: "$0.00"
10676                         tracking_url:
10677                       relationships:
10678                         order:
10679                           data:
10680                             id: '90'
10681                             type: order
10682                         address:
10683                           data:
10684                         stock_location:
10685                           data:
10686                             id: '126'
10687                             type: stock_location
10688                         adjustments:
10689                           data: []
10690                         inventory_units:
10691                           data:
10692                           - id: '44'
10693                             type: inventory_unit
10694                           - id: '45'
10695                             type: inventory_unit
10696                         shipping_rates:
10697                           data:
10698                           - id: '76'
10699                             type: shipping_rate
10700                           - id: '77'
10701                             type: shipping_rate
10702                         state_changes:
10703                           data: []
10704                         selected_shipping_rate:
10705                           data:
10706                             id: '77'
10707                             type: shipping_rate
10708               schema:
10709                 "$ref": "#/components/schemas/resource"
10710         '404':
10711           description: Record not found
10712           content:
10713             application/vnd.api+json:
10714               examples:
10715                 Example:
10716                   value:
10717                     error: The resource you were looking for could not be found.
10718               schema:
10719                 "$ref": "#/components/schemas/error"
10720         '401':
10721           description: Authentication Failed
10722           content:
10723             application/vnd.api+json:
10724               examples:
10725                 Example:
10726                   value:
10727                     error: The access token is invalid
10728               schema:
10729                 "$ref": "#/components/schemas/error"
10730       requestBody:
10731         content:
10732           application/json:
10733             schema:
10734               "$ref": "#/components/schemas/add_item_shipment_params"
10735   "/api/v2/platform/shipments/{id}/remove_item":
10736     patch:
10737       summary: Removes item (Variant) from Shipment
10738       tags:
10739       - Shipments
10740       security:
10741       - bearer_auth: []
10742       description: If selected Variant is removed completely and Shipment doesn't
10743         include any other Line Items, Shipment itself will be deleted
10744       operationId: remove-item-shipment
10745       parameters:
10746       - name: id
10747         in: path
10748         required: true
10749         schema:
10750           type: string
10751       - name: include
10752         in: query
10753         description: 'Select which associated resources you would like to fetch, see:
10754           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
10755         example: line_items,variants,product
10756         schema:
10757           type: string
10758       responses:
10759         '204':
10760           description: Record deleted
10761         '200':
10762           description: Record updated
10763           content:
10764             application/vnd.api+json:
10765               examples:
10766                 Example:
10767                   value:
10768                     data:
10769                       id: '54'
10770                       type: shipment
10771                       attributes:
10772                         tracking: U10000
10773                         number: H51498419568
10774                         cost: '0.0'
10775                         shipped_at:
10776                         state: pending
10777                         created_at: '2022-11-08T19:35:15.496Z'
10778                         updated_at: '2022-11-08T19:35:15.944Z'
10779                         adjustment_total: '0.0'
10780                         additional_tax_total: '0.0'
10781                         promo_total: '0.0'
10782                         included_tax_total: '0.0'
10783                         pre_tax_amount: '0.0'
10784                         taxable_adjustment_total: '0.0'
10785                         non_taxable_adjustment_total: '0.0'
10786                         public_metadata: {}
10787                         private_metadata: {}
10788                         display_discounted_cost: "$0.00"
10789                         display_item_cost: "$10.00"
10790                         display_amount: "$0.00"
10791                         display_final_price: "$0.00"
10792                         display_cost: "$0.00"
10793                         tracking_url:
10794                       relationships:
10795                         order:
10796                           data:
10797                             id: '93'
10798                             type: order
10799                         address:
10800                           data:
10801                         stock_location:
10802                           data:
10803                             id: '133'
10804                             type: stock_location
10805                         adjustments:
10806                           data: []
10807                         inventory_units:
10808                           data:
10809                           - id: '51'
10810                             type: inventory_unit
10811                         shipping_rates:
10812                           data:
10813                           - id: '100'
10814                             type: shipping_rate
10815                           - id: '101'
10816                             type: shipping_rate
10817                         state_changes:
10818                           data: []
10819                         selected_shipping_rate:
10820                           data:
10821                             id: '97'
10822                             type: shipping_rate
10823               schema:
10824                 "$ref": "#/components/schemas/resource"
10825         '404':
10826           description: Record not found
10827           content:
10828             application/vnd.api+json:
10829               examples:
10830                 Example:
10831                   value:
10832                     error: The resource you were looking for could not be found.
10833               schema:
10834                 "$ref": "#/components/schemas/error"
10835         '401':
10836           description: Authentication Failed
10837           content:
10838             application/vnd.api+json:
10839               examples:
10840                 Example:
10841                   value:
10842                     error: The access token is invalid
10843               schema:
10844                 "$ref": "#/components/schemas/error"
10845       requestBody:
10846         content:
10847           application/json:
10848             schema:
10849               "$ref": "#/components/schemas/remove_item_shipment_params"
10850   "/api/v2/platform/shipments/{id}/ready":
10851     patch:
10852       summary: Mark Shipment as ready to be shipped
10853       tags:
10854       - Shipments
10855       security:
10856       - bearer_auth: []
10857       description: Marks Shipment as ready to be shipped
10858       operationId: ready-shipment
10859       parameters:
10860       - name: id
10861         in: path
10862         required: true
10863         schema:
10864           type: string
10865       - name: include
10866         in: query
10867         description: 'Select which associated resources you would like to fetch, see:
10868           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
10869         example: line_items,variants,product
10870         schema:
10871           type: string
10872       responses:
10873         '200':
10874           description: Record updated
10875           content:
10876             application/vnd.api+json:
10877               examples:
10878                 Example:
10879                   value:
10880                     data:
10881                       id: '58'
10882                       type: shipment
10883                       attributes:
10884                         tracking: U10000
10885                         number: H47907335950
10886                         cost: '100.0'
10887                         shipped_at:
10888                         state: ready
10889                         created_at: '2022-11-08T19:35:16.670Z'
10890                         updated_at: '2022-11-08T19:35:16.922Z'
10891                         adjustment_total: '0.0'
10892                         additional_tax_total: '0.0'
10893                         promo_total: '0.0'
10894                         included_tax_total: '0.0'
10895                         pre_tax_amount: '0.0'
10896                         taxable_adjustment_total: '0.0'
10897                         non_taxable_adjustment_total: '0.0'
10898                         public_metadata: {}
10899                         private_metadata: {}
10900                         display_discounted_cost: "$100.00"
10901                         display_item_cost: "$10.00"
10902                         display_amount: "$100.00"
10903                         display_final_price: "$100.00"
10904                         display_cost: "$100.00"
10905                         tracking_url:
10906                       relationships:
10907                         order:
10908                           data:
10909                             id: '95'
10910                             type: order
10911                         address:
10912                           data:
10913                         stock_location:
10914                           data:
10915                             id: '137'
10916                             type: stock_location
10917                         adjustments:
10918                           data: []
10919                         inventory_units:
10920                           data:
10921                           - id: '55'
10922                             type: inventory_unit
10923                         shipping_rates:
10924                           data:
10925                           - id: '109'
10926                             type: shipping_rate
10927                         state_changes:
10928                           data:
10929                           - id: '25'
10930                             type: state_change
10931                         selected_shipping_rate:
10932                           data:
10933                             id: '109'
10934                             type: shipping_rate
10935               schema:
10936                 "$ref": "#/components/schemas/resource"
10937         '404':
10938           description: Record not found
10939           content:
10940             application/vnd.api+json:
10941               examples:
10942                 Example:
10943                   value:
10944                     error: The resource you were looking for could not be found.
10945               schema:
10946                 "$ref": "#/components/schemas/error"
10947         '401':
10948           description: Authentication Failed
10949           content:
10950             application/vnd.api+json:
10951               examples:
10952                 Example:
10953                   value:
10954                     error: The access token is invalid
10955               schema:
10956                 "$ref": "#/components/schemas/error"
10957   "/api/v2/platform/shipments/{id}/ship":
10958     patch:
10959       summary: Mark Shipment as shipped
10960       tags:
10961       - Shipments
10962       security:
10963       - bearer_auth: []
10964       description: Marks Shipment as shipped
10965       operationId: ship-shipment
10966       parameters:
10967       - name: id
10968         in: path
10969         required: true
10970         schema:
10971           type: string
10972       - name: include
10973         in: query
10974         description: 'Select which associated resources you would like to fetch, see:
10975           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
10976         example: line_items,variants,product
10977         schema:
10978           type: string
10979       responses:
10980         '200':
10981           description: Record updated
10982           content:
10983             application/vnd.api+json:
10984               examples:
10985                 Example:
10986                   value:
10987                     data:
10988                       id: '62'
10989                       type: shipment
10990                       attributes:
10991                         tracking: U10000
10992                         number: H98524317894
10993                         cost: '100.0'
10994                         shipped_at: '2022-11-08T19:35:17.839Z'
10995                         state: shipped
10996                         created_at: '2022-11-08T19:35:17.583Z'
10997                         updated_at: '2022-11-08T19:35:17.839Z'
10998                         adjustment_total: '0.0'
10999                         additional_tax_total: '0.0'
11000                         promo_total: '0.0'
11001                         included_tax_total: '0.0'
11002                         pre_tax_amount: '0.0'
11003                         taxable_adjustment_total: '0.0'
11004                         non_taxable_adjustment_total: '0.0'
11005                         public_metadata: {}
11006                         private_metadata: {}
11007                         display_discounted_cost: "$100.00"
11008                         display_item_cost: "$10.00"
11009                         display_amount: "$100.00"
11010                         display_final_price: "$100.00"
11011                         display_cost: "$100.00"
11012                         tracking_url:
11013                       relationships:
11014                         order:
11015                           data:
11016                             id: '97'
11017                             type: order
11018                         address:
11019                           data:
11020                         stock_location:
11021                           data:
11022                             id: '141'
11023                             type: stock_location
11024                         adjustments:
11025                           data: []
11026                         inventory_units:
11027                           data:
11028                           - id: '59'
11029                             type: inventory_unit
11030                         shipping_rates:
11031                           data:
11032                           - id: '117'
11033                             type: shipping_rate
11034                         state_changes:
11035                           data:
11036                           - id: '27'
11037                             type: state_change
11038                         selected_shipping_rate:
11039                           data:
11040                             id: '117'
11041                             type: shipping_rate
11042               schema:
11043                 "$ref": "#/components/schemas/resource"
11044         '404':
11045           description: Record not found
11046           content:
11047             application/vnd.api+json:
11048               examples:
11049                 Example:
11050                   value:
11051                     error: The resource you were looking for could not be found.
11052               schema:
11053                 "$ref": "#/components/schemas/error"
11054         '401':
11055           description: Authentication Failed
11056           content:
11057             application/vnd.api+json:
11058               examples:
11059                 Example:
11060                   value:
11061                     error: The access token is invalid
11062               schema:
11063                 "$ref": "#/components/schemas/error"
11064   "/api/v2/platform/shipments/{id}/cancel":
11065     patch:
11066       summary: Cancels the Shipment
11067       tags:
11068       - Shipments
11069       security:
11070       - bearer_auth: []
11071       description: Cancels the Shipment
11072       operationId: cancel-shipment
11073       parameters:
11074       - name: id
11075         in: path
11076         required: true
11077         schema:
11078           type: string
11079       - name: include
11080         in: query
11081         description: 'Select which associated resources you would like to fetch, see:
11082           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
11083         example: line_items,variants,product
11084         schema:
11085           type: string
11086       responses:
11087         '200':
11088           description: Record updated
11089           content:
11090             application/vnd.api+json:
11091               examples:
11092                 Example:
11093                   value:
11094                     data:
11095                       id: '66'
11096                       type: shipment
11097                       attributes:
11098                         tracking: U10000
11099                         number: H87762281833
11100                         cost: '100.0'
11101                         shipped_at:
11102                         state: canceled
11103                         created_at: '2022-11-08T19:35:18.498Z'
11104                         updated_at: '2022-11-08T19:35:18.748Z'
11105                         adjustment_total: '0.0'
11106                         additional_tax_total: '0.0'
11107                         promo_total: '0.0'
11108                         included_tax_total: '0.0'
11109                         pre_tax_amount: '0.0'
11110                         taxable_adjustment_total: '0.0'
11111                         non_taxable_adjustment_total: '0.0'
11112                         public_metadata: {}
11113                         private_metadata: {}
11114                         display_discounted_cost: "$100.00"
11115                         display_item_cost: "$10.00"
11116                         display_amount: "$100.00"
11117                         display_final_price: "$100.00"
11118                         display_cost: "$100.00"
11119                         tracking_url:
11120                       relationships:
11121                         order:
11122                           data:
11123                             id: '99'
11124                             type: order
11125                         address:
11126                           data:
11127                         stock_location:
11128                           data:
11129                             id: '145'
11130                             type: stock_location
11131                         adjustments:
11132                           data: []
11133                         inventory_units:
11134                           data:
11135                           - id: '63'
11136                             type: inventory_unit
11137                         shipping_rates:
11138                           data:
11139                           - id: '125'
11140                             type: shipping_rate
11141                         state_changes:
11142                           data:
11143                           - id: '28'
11144                             type: state_change
11145                         selected_shipping_rate:
11146                           data:
11147                             id: '125'
11148                             type: shipping_rate
11149               schema:
11150                 "$ref": "#/components/schemas/resource"
11151         '404':
11152           description: Record not found
11153           content:
11154             application/vnd.api+json:
11155               examples:
11156                 Example:
11157                   value:
11158                     error: The resource you were looking for could not be found.
11159               schema:
11160                 "$ref": "#/components/schemas/error"
11161         '401':
11162           description: Authentication Failed
11163           content:
11164             application/vnd.api+json:
11165               examples:
11166                 Example:
11167                   value:
11168                     error: The access token is invalid
11169               schema:
11170                 "$ref": "#/components/schemas/error"
11171   "/api/v2/platform/shipments/{id}/resume":
11172     patch:
11173       summary: Resumes the Shipment
11174       tags:
11175       - Shipments
11176       security:
11177       - bearer_auth: []
11178       description: Resumes previously canceled Shipment
11179       operationId: resume-shipment
11180       parameters:
11181       - name: id
11182         in: path
11183         required: true
11184         schema:
11185           type: string
11186       - name: include
11187         in: query
11188         description: 'Select which associated resources you would like to fetch, see:
11189           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
11190         example: line_items,variants,product
11191         schema:
11192           type: string
11193       responses:
11194         '200':
11195           description: Record updated
11196           content:
11197             application/vnd.api+json:
11198               examples:
11199                 Example:
11200                   value:
11201                     data:
11202                       id: '70'
11203                       type: shipment
11204                       attributes:
11205                         tracking: U10000
11206                         number: H65608010898
11207                         cost: '100.0'
11208                         shipped_at:
11209                         state: ready
11210                         created_at: '2022-11-08T19:35:19.500Z'
11211                         updated_at: '2022-11-08T19:35:19.754Z'
11212                         adjustment_total: '0.0'
11213                         additional_tax_total: '0.0'
11214                         promo_total: '0.0'
11215                         included_tax_total: '0.0'
11216                         pre_tax_amount: '0.0'
11217                         taxable_adjustment_total: '0.0'
11218                         non_taxable_adjustment_total: '0.0'
11219                         public_metadata: {}
11220                         private_metadata: {}
11221                         display_discounted_cost: "$100.00"
11222                         display_item_cost: "$10.00"
11223                         display_amount: "$100.00"
11224                         display_final_price: "$100.00"
11225                         display_cost: "$100.00"
11226                         tracking_url:
11227                       relationships:
11228                         order:
11229                           data:
11230                             id: '101'
11231                             type: order
11232                         address:
11233                           data:
11234                         stock_location:
11235                           data:
11236                             id: '149'
11237                             type: stock_location
11238                         adjustments:
11239                           data: []
11240                         inventory_units:
11241                           data:
11242                           - id: '67'
11243                             type: inventory_unit
11244                         shipping_rates:
11245                           data:
11246                           - id: '133'
11247                             type: shipping_rate
11248                         state_changes:
11249                           data:
11250                           - id: '29'
11251                             type: state_change
11252                         selected_shipping_rate:
11253                           data:
11254                             id: '133'
11255                             type: shipping_rate
11256               schema:
11257                 "$ref": "#/components/schemas/resource"
11258         '404':
11259           description: Record not found
11260           content:
11261             application/vnd.api+json:
11262               examples:
11263                 Example:
11264                   value:
11265                     error: The resource you were looking for could not be found.
11266               schema:
11267                 "$ref": "#/components/schemas/error"
11268         '401':
11269           description: Authentication Failed
11270           content:
11271             application/vnd.api+json:
11272               examples:
11273                 Example:
11274                   value:
11275                     error: The access token is invalid
11276               schema:
11277                 "$ref": "#/components/schemas/error"
11278   "/api/v2/platform/shipments/{id}/pend":
11279     patch:
11280       summary: Moves Shipment back to pending state
11281       tags:
11282       - Shipments
11283       security:
11284       - bearer_auth: []
11285       description: Moves Shipment back to pending state
11286       operationId: pend-shipment
11287       parameters:
11288       - name: id
11289         in: path
11290         required: true
11291         schema:
11292           type: string
11293       - name: include
11294         in: query
11295         description: 'Select which associated resources you would like to fetch, see:
11296           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
11297         example: line_items,variants,product
11298         schema:
11299           type: string
11300       responses:
11301         '200':
11302           description: Record updated
11303           content:
11304             application/vnd.api+json:
11305               examples:
11306                 Example:
11307                   value:
11308                     data:
11309                       id: '75'
11310                       type: shipment
11311                       attributes:
11312                         tracking: U10000
11313                         number: H29346097126
11314                         cost: '100.0'
11315                         shipped_at:
11316                         state: pending
11317                         created_at: '2022-11-08T19:35:20.604Z'
11318                         updated_at: '2022-11-08T19:35:20.853Z'
11319                         adjustment_total: '0.0'
11320                         additional_tax_total: '0.0'
11321                         promo_total: '0.0'
11322                         included_tax_total: '0.0'
11323                         pre_tax_amount: '0.0'
11324                         taxable_adjustment_total: '0.0'
11325                         non_taxable_adjustment_total: '0.0'
11326                         public_metadata: {}
11327                         private_metadata: {}
11328                         display_discounted_cost: "$100.00"
11329                         display_item_cost: "$10.00"
11330                         display_amount: "$100.00"
11331                         display_final_price: "$100.00"
11332                         display_cost: "$100.00"
11333                         tracking_url:
11334                       relationships:
11335                         order:
11336                           data:
11337                             id: '104'
11338                             type: order
11339                         address:
11340                           data:
11341                         stock_location:
11342                           data:
11343                             id: '154'
11344                             type: stock_location
11345                         adjustments:
11346                           data: []
11347                         inventory_units:
11348                           data:
11349                           - id: '72'
11350                             type: inventory_unit
11351                         shipping_rates:
11352                           data:
11353                           - id: '144'
11354                             type: shipping_rate
11355                         state_changes:
11356                           data:
11357                           - id: '30'
11358                             type: state_change
11359                         selected_shipping_rate:
11360                           data:
11361                             id: '144'
11362                             type: shipping_rate
11363               schema:
11364                 "$ref": "#/components/schemas/resource"
11365         '404':
11366           description: Record not found
11367           content:
11368             application/vnd.api+json:
11369               examples:
11370                 Example:
11371                   value:
11372                     error: The resource you were looking for could not be found.
11373               schema:
11374                 "$ref": "#/components/schemas/error"
11375         '401':
11376           description: Authentication Failed
11377           content:
11378             application/vnd.api+json:
11379               examples:
11380                 Example:
11381                   value:
11382                     error: The access token is invalid
11383               schema:
11384                 "$ref": "#/components/schemas/error"
11385   "/api/v2/platform/shipping_categories":
11386     get:
11387       summary: Return a list of Shipping Categories
11388       tags:
11389       - Shipping Categories
11390       security:
11391       - bearer_auth: []
11392       description: Returns a list of Shipping Categories
11393       operationId: shipping-categories-list
11394       parameters:
11395       - name: page
11396         in: query
11397         example: 1
11398         schema:
11399           type: integer
11400       - name: per_page
11401         in: query
11402         example: 50
11403         schema:
11404           type: integer
11405       - name: filter[name_i_cont]
11406         in: query
11407         description: ''
11408         example: default
11409         schema:
11410           type: string
11411       responses:
11412         '200':
11413           description: Records returned
11414           content:
11415             application/vnd.api+json:
11416               examples:
11417                 Example:
11418                   value:
11419                     data:
11420                     - id: '134'
11421                       type: shipping_category
11422                       attributes:
11423                         name: ShippingCategory 134
11424                         created_at: '2022-11-08T19:35:21.335Z'
11425                         updated_at: '2022-11-08T19:35:21.335Z'
11426                     - id: '135'
11427                       type: shipping_category
11428                       attributes:
11429                         name: ShippingCategory 135
11430                         created_at: '2022-11-08T19:35:21.336Z'
11431                         updated_at: '2022-11-08T19:35:21.336Z'
11432                     meta:
11433                       count: 2
11434                       total_count: 2
11435                       total_pages: 1
11436                     links:
11437                       self: http://www.example.com/api/v2/platform/shipping_categories?page=1&per_page=&filter[name_i_cont]=
11438                       next: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
11439                       prev: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
11440                       last: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
11441                       first: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
11442               schema:
11443                 "$ref": "#/components/schemas/resources_list"
11444         '401':
11445           description: Authentication Failed
11446           content:
11447             application/vnd.api+json:
11448               examples:
11449                 Example:
11450                   value:
11451                     error: The access token is invalid
11452               schema:
11453                 "$ref": "#/components/schemas/error"
11454     post:
11455       summary: Create a Shipping Category
11456       tags:
11457       - Shipping Categories
11458       security:
11459       - bearer_auth: []
11460       description: Creates a Shipping Category
11461       operationId: create-shipping-category
11462       parameters: []
11463       responses:
11464         '201':
11465           description: Record created
11466           content:
11467             application/vnd.api+json:
11468               examples:
11469                 Example:
11470                   value:
11471                     data:
11472                       id: '138'
11473                       type: shipping_category
11474                       attributes:
11475                         name: ShippingCategory 138
11476                         created_at: '2022-11-08T19:35:21.863Z'
11477                         updated_at: '2022-11-08T19:35:21.863Z'
11478               schema:
11479                 "$ref": "#/components/schemas/resource"
11480         '422':
11481           description: Invalid request
11482           content:
11483             application/vnd.api+json:
11484               examples:
11485                 Example:
11486                   value:
11487                     error: Name can't be blank
11488                     errors:
11489                       name:
11490                       - can't be blank
11491               schema:
11492                 "$ref": "#/components/schemas/validation_errors"
11493       requestBody:
11494         content:
11495           application/json:
11496             schema:
11497               "$ref": "#/components/schemas/create_shipping_category_params"
11498   "/api/v2/platform/shipping_categories/{id}":
11499     get:
11500       summary: Return a Shipping Category
11501       tags:
11502       - Shipping Categories
11503       security:
11504       - bearer_auth: []
11505       description: Returns a Shipping Category
11506       operationId: show-shipping-category
11507       parameters:
11508       - name: id
11509         in: path
11510         required: true
11511         schema:
11512           type: string
11513       responses:
11514         '200':
11515           description: Record found
11516           content:
11517             application/vnd.api+json:
11518               examples:
11519                 Example:
11520                   value:
11521                     data:
11522                       id: '139'
11523                       type: shipping_category
11524                       attributes:
11525                         name: ShippingCategory 139
11526                         created_at: '2022-11-08T19:35:22.131Z'
11527                         updated_at: '2022-11-08T19:35:22.131Z'
11528               schema:
11529                 "$ref": "#/components/schemas/resource"
11530         '404':
11531           description: Record not found
11532           content:
11533             application/vnd.api+json:
11534               examples:
11535                 Example:
11536                   value:
11537                     error: The resource you were looking for could not be found.
11538               schema:
11539                 "$ref": "#/components/schemas/error"
11540         '401':
11541           description: Authentication Failed
11542           content:
11543             application/vnd.api+json:
11544               examples:
11545                 Example:
11546                   value:
11547                     error: The access token is invalid
11548               schema:
11549                 "$ref": "#/components/schemas/error"
11550     patch:
11551       summary: Update a Shipping Category
11552       tags:
11553       - Shipping Categories
11554       security:
11555       - bearer_auth: []
11556       description: Updates a Shipping Category
11557       operationId: update-shipping-category
11558       parameters:
11559       - name: id
11560         in: path
11561         required: true
11562         schema:
11563           type: string
11564       responses:
11565         '200':
11566           description: Record updated
11567           content:
11568             application/vnd.api+json:
11569               examples:
11570                 Example:
11571                   value:
11572                     data:
11573                       id: '141'
11574                       type: shipping_category
11575                       attributes:
11576                         name: Default
11577                         created_at: '2022-11-08T19:35:22.647Z'
11578                         updated_at: '2022-11-08T19:35:22.876Z'
11579               schema:
11580                 "$ref": "#/components/schemas/resource"
11581         '422':
11582           description: Invalid request
11583           content:
11584             application/vnd.api+json:
11585               examples:
11586                 Example:
11587                   value:
11588                     error: Name can't be blank
11589                     errors:
11590                       name:
11591                       - can't be blank
11592               schema:
11593                 "$ref": "#/components/schemas/validation_errors"
11594         '404':
11595           description: Record not found
11596           content:
11597             application/vnd.api+json:
11598               examples:
11599                 Example:
11600                   value:
11601                     error: The resource you were looking for could not be found.
11602               schema:
11603                 "$ref": "#/components/schemas/error"
11604         '401':
11605           description: Authentication Failed
11606           content:
11607             application/vnd.api+json:
11608               examples:
11609                 Example:
11610                   value:
11611                     error: The access token is invalid
11612               schema:
11613                 "$ref": "#/components/schemas/error"
11614       requestBody:
11615         content:
11616           application/json:
11617             schema:
11618               "$ref": "#/components/schemas/update_shipping_category_params"
11619     delete:
11620       summary: Delete a Shipping Category
11621       tags:
11622       - Shipping Categories
11623       security:
11624       - bearer_auth: []
11625       description: Deletes a Shipping Category
11626       operationId: delete-shipping-category
11627       parameters:
11628       - name: id
11629         in: path
11630         required: true
11631         schema:
11632           type: string
11633       responses:
11634         '204':
11635           description: Record deleted
11636         '404':
11637           description: Record not found
11638           content:
11639             application/vnd.api+json:
11640               examples:
11641                 Example:
11642                   value:
11643                     error: The resource you were looking for could not be found.
11644               schema:
11645                 "$ref": "#/components/schemas/error"
11646         '401':
11647           description: Authentication Failed
11648           content:
11649             application/vnd.api+json:
11650               examples:
11651                 Example:
11652                   value:
11653                     error: The access token is invalid
11654               schema:
11655                 "$ref": "#/components/schemas/error"
11656   "/api/v2/platform/shipping_methods":
11657     get:
11658       summary: Return a list of Shipping Methods
11659       tags:
11660       - Shipping Methods
11661       security:
11662       - bearer_auth: []
11663       description: Returns a list of Shipping Methods
11664       operationId: shipping-methods-list
11665       parameters:
11666       - name: page
11667         in: query
11668         example: 1
11669         schema:
11670           type: integer
11671       - name: per_page
11672         in: query
11673         example: 50
11674         schema:
11675           type: integer
11676       - name: include
11677         in: query
11678         description: 'Select which associated resources you would like to fetch, see:
11679           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
11680         example: calculator,shipping_categories,shipping_rates,tax_category
11681         schema:
11682           type: string
11683       - name: filter[name]
11684         in: query
11685         description: ''
11686         example: DHL Express
11687         schema:
11688           type: string
11689       - name: filter[title_cont]
11690         in: query
11691         description: ''
11692         example: About Us
11693         schema:
11694           type: string
11695       responses:
11696         '200':
11697           description: Records returned
11698           content:
11699             application/vnd.api+json:
11700               examples:
11701                 Example:
11702                   value:
11703                     data:
11704                     - id: '77'
11705                       type: shipping_method
11706                       attributes:
11707                         name: UPS Ground
11708                         code: UPS_GROUND
11709                         admin_name:
11710                         display_on: both
11711                         tracking_url:
11712                         created_at: '2022-11-08T19:35:23.928Z'
11713                         updated_at: '2022-11-08T19:35:23.928Z'
11714                         deleted_at:
11715                         public_metadata: {}
11716                         private_metadata: {}
11717                       relationships:
11718                         shipping_categories:
11719                           data:
11720                           - id: '146'
11721                             type: shipping_category
11722                         shipping_rates:
11723                           data: []
11724                         tax_category:
11725                           data:
11726                         calculator:
11727                           data:
11728                             id: '137'
11729                             type: calculator
11730                     - id: '78'
11731                       type: shipping_method
11732                       attributes:
11733                         name: UPS Ground
11734                         code: UPS_GROUND
11735                         admin_name:
11736                         display_on: both
11737                         tracking_url:
11738                         created_at: '2022-11-08T19:35:23.939Z'
11739                         updated_at: '2022-11-08T19:35:23.939Z'
11740                         deleted_at:
11741                         public_metadata: {}
11742                         private_metadata: {}
11743                       relationships:
11744                         shipping_categories:
11745                           data:
11746                           - id: '146'
11747                             type: shipping_category
11748                         shipping_rates:
11749                           data: []
11750                         tax_category:
11751                           data:
11752                         calculator:
11753                           data:
11754                             id: '138'
11755                             type: calculator
11756                     meta:
11757                       count: 2
11758                       total_count: 2
11759                       total_pages: 1
11760                     links:
11761                       self: http://www.example.com/api/v2/platform/shipping_methods?page=1&per_page=&include=&filter[name]=&filter[title_cont]=
11762                       next: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
11763                       prev: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
11764                       last: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
11765                       first: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
11766               schema:
11767                 "$ref": "#/components/schemas/resources_list"
11768         '401':
11769           description: Authentication Failed
11770           content:
11771             application/vnd.api+json:
11772               examples:
11773                 Example:
11774                   value:
11775                     error: The access token is invalid
11776               schema:
11777                 "$ref": "#/components/schemas/error"
11778     post:
11779       summary: Create a Shipping Method
11780       tags:
11781       - Shipping Methods
11782       security:
11783       - bearer_auth: []
11784       description: Creates a Shipping Method
11785       operationId: create-shipping-method
11786       parameters:
11787       - name: include
11788         in: query
11789         description: 'Select which associated resources you would like to fetch, see:
11790           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
11791         example: calculator,shipping_categories,shipping_rates,tax_category
11792         schema:
11793           type: string
11794       responses:
11795         '201':
11796           description: Record created
11797           content:
11798             application/vnd.api+json:
11799               examples:
11800                 Example:
11801                   value:
11802                     data:
11803                       id: '81'
11804                       type: shipping_method
11805                       attributes:
11806                         name: DHL Express Domestic
11807                         code: DDD
11808                         admin_name: DHL Express- Zone A
11809                         display_on: both
11810                         tracking_url:
11811                         created_at: '2022-11-08T19:35:24.485Z'
11812                         updated_at: '2022-11-08T19:35:24.485Z'
11813                         deleted_at:
11814                         public_metadata: {}
11815                         private_metadata: {}
11816                       relationships:
11817                         shipping_categories:
11818                           data:
11819                           - id: '148'
11820                             type: shipping_category
11821                         shipping_rates:
11822                           data: []
11823                         tax_category:
11824                           data:
11825                             id: '142'
11826                             type: tax_category
11827                         calculator:
11828                           data:
11829                             id: '141'
11830                             type: calculator
11831               schema:
11832                 "$ref": "#/components/schemas/resource"
11833         '422':
11834           description: Invalid request
11835           content:
11836             application/vnd.api+json:
11837               examples:
11838                 Example:
11839                   value:
11840                     error: Calculator can't be blank, Name can't be blank, Display
11841                       on can't be blank, and You must select at least one shipping
11842                       category
11843                     errors:
11844                       calculator:
11845                       - can't be blank
11846                       name:
11847                       - can't be blank
11848                       display_on:
11849                       - can't be blank
11850                       base:
11851                       - You must select at least one shipping category
11852               schema:
11853                 "$ref": "#/components/schemas/validation_errors"
11854       requestBody:
11855         content:
11856           application/json:
11857             schema:
11858               "$ref": "#/components/schemas/create_shipping_method_params"
11859   "/api/v2/platform/shipping_methods/{id}":
11860     get:
11861       summary: Return a Shipping Method
11862       tags:
11863       - Shipping Methods
11864       security:
11865       - bearer_auth: []
11866       description: Returns a Shipping Method
11867       operationId: show-shipping-method
11868       parameters:
11869       - name: id
11870         in: path
11871         required: true
11872         schema:
11873           type: string
11874       - name: include
11875         in: query
11876         description: 'Select which associated resources you would like to fetch, see:
11877           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
11878         example: calculator,shipping_categories,shipping_rates,tax_category
11879         schema:
11880           type: string
11881       responses:
11882         '200':
11883           description: Record found
11884           content:
11885             application/vnd.api+json:
11886               examples:
11887                 Example:
11888                   value:
11889                     data:
11890                       id: '82'
11891                       type: shipping_method
11892                       attributes:
11893                         name: UPS Ground
11894                         code: UPS_GROUND
11895                         admin_name:
11896                         display_on: both
11897                         tracking_url:
11898                         created_at: '2022-11-08T19:35:24.769Z'
11899                         updated_at: '2022-11-08T19:35:24.769Z'
11900                         deleted_at:
11901                         public_metadata: {}
11902                         private_metadata: {}
11903                       relationships:
11904                         shipping_categories:
11905                           data:
11906                           - id: '149'
11907                             type: shipping_category
11908                         shipping_rates:
11909                           data: []
11910                         tax_category:
11911                           data:
11912                         calculator:
11913                           data:
11914                             id: '142'
11915                             type: calculator
11916               schema:
11917                 "$ref": "#/components/schemas/resource"
11918         '404':
11919           description: Record not found
11920           content:
11921             application/vnd.api+json:
11922               examples:
11923                 Example:
11924                   value:
11925                     error: The resource you were looking for could not be found.
11926               schema:
11927                 "$ref": "#/components/schemas/error"
11928         '401':
11929           description: Authentication Failed
11930           content:
11931             application/vnd.api+json:
11932               examples:
11933                 Example:
11934                   value:
11935                     error: The access token is invalid
11936               schema:
11937                 "$ref": "#/components/schemas/error"
11938     patch:
11939       summary: Update a Shipping Method
11940       tags:
11941       - Shipping Methods
11942       security:
11943       - bearer_auth: []
11944       description: Updates a Shipping Method
11945       operationId: update-shipping-method
11946       parameters:
11947       - name: id
11948         in: path
11949         required: true
11950         schema:
11951           type: string
11952       - name: include
11953         in: query
11954         description: 'Select which associated resources you would like to fetch, see:
11955           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
11956         example: calculator,shipping_categories,shipping_rates,tax_category
11957         schema:
11958           type: string
11959       responses:
11960         '200':
11961           description: Record updated
11962           content:
11963             application/vnd.api+json:
11964               examples:
11965                 Example:
11966                   value:
11967                     data:
11968                       id: '84'
11969                       type: shipping_method
11970                       attributes:
11971                         name: FedEx Expedited
11972                         code: UPS_GROUND
11973                         admin_name:
11974                         display_on: both
11975                         tracking_url:
11976                         created_at: '2022-11-08T19:35:25.390Z'
11977                         updated_at: '2022-11-08T19:35:25.626Z'
11978                         deleted_at:
11979                         public_metadata: {}
11980                         private_metadata: {}
11981                       relationships:
11982                         shipping_categories:
11983                           data:
11984                           - id: '151'
11985                             type: shipping_category
11986                         shipping_rates:
11987                           data: []
11988                         tax_category:
11989                           data:
11990                         calculator:
11991                           data:
11992                             id: '145'
11993                             type: calculator
11994               schema:
11995                 "$ref": "#/components/schemas/resource"
11996         '422':
11997           description: Invalid request
11998           content:
11999             application/vnd.api+json:
12000               examples:
12001                 Example:
12002                   value:
12003                     error: Name can't be blank
12004                     errors:
12005                       name:
12006                       - can't be blank
12007               schema:
12008                 "$ref": "#/components/schemas/validation_errors"
12009         '404':
12010           description: Record not found
12011           content:
12012             application/vnd.api+json:
12013               examples:
12014                 Example:
12015                   value:
12016                     error: The resource you were looking for could not be found.
12017               schema:
12018                 "$ref": "#/components/schemas/error"
12019         '401':
12020           description: Authentication Failed
12021           content:
12022             application/vnd.api+json:
12023               examples:
12024                 Example:
12025                   value:
12026                     error: The access token is invalid
12027               schema:
12028                 "$ref": "#/components/schemas/error"
12029       requestBody:
12030         content:
12031           application/json:
12032             schema:
12033               "$ref": "#/components/schemas/update_shipping_method_params"
12034     delete:
12035       summary: Delete a Shipping Method
12036       tags:
12037       - Shipping Methods
12038       security:
12039       - bearer_auth: []
12040       description: Deletes a Shipping Method
12041       operationId: delete-shipping-method
12042       parameters:
12043       - name: id
12044         in: path
12045         required: true
12046         schema:
12047           type: string
12048       responses:
12049         '204':
12050           description: Record deleted
12051         '404':
12052           description: Record not found
12053           content:
12054             application/vnd.api+json:
12055               examples:
12056                 Example:
12057                   value:
12058                     error: The resource you were looking for could not be found.
12059               schema:
12060                 "$ref": "#/components/schemas/error"
12061         '401':
12062           description: Authentication Failed
12063           content:
12064             application/vnd.api+json:
12065               examples:
12066                 Example:
12067                   value:
12068                     error: The access token is invalid
12069               schema:
12070                 "$ref": "#/components/schemas/error"
12071   "/api/v2/platform/states":
12072     get:
12073       summary: Returns a list of States
12074       tags:
12075       - States
12076       security:
12077       - bearer_auth: []
12078       operationId: states-list
12079       description: Returns a list of States
12080       parameters:
12081       - name: page
12082         in: query
12083         example: 1
12084         schema:
12085           type: integer
12086       - name: per_page
12087         in: query
12088         example: 50
12089         schema:
12090           type: integer
12091       - name: include
12092         in: query
12093         description: 'Select which associated resources you would like to fetch, see:
12094           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
12095         example: country
12096         schema:
12097           type: string
12098       - name: filter[country_id_eq]
12099         in: query
12100         description: ''
12101         example: '4'
12102         schema:
12103           type: string
12104       responses:
12105         '200':
12106           description: Records returned
12107           content:
12108             application/vnd.api+json:
12109               examples:
12110                 Example:
12111                   value:
12112                     data:
12113                     - id: '230'
12114                       type: state
12115                       attributes:
12116                         name: STATE_NAME_230
12117                         abbr: STATE_ABBR_230
12118                         updated_at: '2022-11-08T19:35:26.719Z'
12119                         created_at: '2022-11-08T19:35:26.719Z'
12120                       relationships:
12121                         country:
12122                           data:
12123                             id: '394'
12124                             type: country
12125                     - id: '231'
12126                       type: state
12127                       attributes:
12128                         name: STATE_NAME_231
12129                         abbr: STATE_ABBR_231
12130                         updated_at: '2022-11-08T19:35:26.721Z'
12131                         created_at: '2022-11-08T19:35:26.721Z'
12132                       relationships:
12133                         country:
12134                           data:
12135                             id: '394'
12136                             type: country
12137                     meta:
12138                       count: 2
12139                       total_count: 2
12140                       total_pages: 1
12141                     links:
12142                       self: http://www.example.com/api/v2/platform/states?page=1&per_page=&include=&filter[country_id_eq]=
12143                       next: http://www.example.com/api/v2/platform/states?filter%5Bcountry_id_eq%5D=&include=&page=1&per_page=
12144                       prev: http://www.example.com/api/v2/platform/states?filter%5Bcountry_id_eq%5D=&include=&page=1&per_page=
12145                       last: http://www.example.com/api/v2/platform/states?filter%5Bcountry_id_eq%5D=&include=&page=1&per_page=
12146                       first: http://www.example.com/api/v2/platform/states?filter%5Bcountry_id_eq%5D=&include=&page=1&per_page=
12147               schema:
12148                 "$ref": "#/components/schemas/resources_list"
12149         '401':
12150           description: Authentication Failed
12151           content:
12152             application/vnd.api+json:
12153               examples:
12154                 Example:
12155                   value:
12156                     error: The access token is invalid
12157               schema:
12158                 "$ref": "#/components/schemas/error"
12159   "/api/v2/platform/states/{id}":
12160     get:
12161       summary: Returns a State
12162       tags:
12163       - States
12164       security:
12165       - bearer_auth: []
12166       operationId: show-state
12167       description: Returns a State
12168       parameters:
12169       - name: id
12170         in: path
12171         required: true
12172         schema:
12173           type: string
12174       responses:
12175         '200':
12176           description: Record found
12177           content:
12178             application/vnd.api+json:
12179               examples:
12180                 Example:
12181                   value:
12182                     data:
12183                       id: '234'
12184                       type: state
12185                       attributes:
12186                         name: STATE_NAME_234
12187                         abbr: STATE_ABBR_234
12188                         updated_at: '2022-11-08T19:35:27.007Z'
12189                         created_at: '2022-11-08T19:35:27.007Z'
12190                       relationships:
12191                         country:
12192                           data:
12193                             id: '396'
12194                             type: country
12195               schema:
12196                 "$ref": "#/components/schemas/resource"
12197         '404':
12198           description: Record not found
12199           content:
12200             application/vnd.api+json:
12201               examples:
12202                 Example:
12203                   value:
12204                     error: The resource you were looking for could not be found.
12205               schema:
12206                 "$ref": "#/components/schemas/error"
12207         '401':
12208           description: Authentication Failed
12209           content:
12210             application/vnd.api+json:
12211               examples:
12212                 Example:
12213                   value:
12214                     error: The access token is invalid
12215               schema:
12216                 "$ref": "#/components/schemas/error"
12217   "/api/v2/platform/stock_items":
12218     get:
12219       summary: Return a list of Stock Items
12220       tags:
12221       - Stock Items
12222       security:
12223       - bearer_auth: []
12224       description: Returns a list of Stock Items
12225       operationId: stock-items-list
12226       parameters:
12227       - name: page
12228         in: query
12229         example: 1
12230         schema:
12231           type: integer
12232       - name: per_page
12233         in: query
12234         example: 50
12235         schema:
12236           type: integer
12237       - name: include
12238         in: query
12239         description: 'Select which associated resources you would like to fetch, see:
12240           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
12241         example: stock_location,variant
12242         schema:
12243           type: string
12244       responses:
12245         '200':
12246           description: Records returned
12247           content:
12248             application/vnd.api+json:
12249               examples:
12250                 Example:
12251                   value:
12252                     data:
12253                     - id: '276'
12254                       type: stock_item
12255                       attributes:
12256                         count_on_hand: 0
12257                         created_at: '2022-11-08T19:35:27.570Z'
12258                         updated_at: '2022-11-08T19:35:27.614Z'
12259                         backorderable: false
12260                         deleted_at:
12261                         public_metadata: {}
12262                         private_metadata: {}
12263                         is_available: false
12264                       relationships:
12265                         stock_location:
12266                           data:
12267                             id: '157'
12268                             type: stock_location
12269                         variant:
12270                           data:
12271                             id: '271'
12272                             type: variant
12273                     - id: '278'
12274                       type: stock_item
12275                       attributes:
12276                         count_on_hand: 10
12277                         created_at: '2022-11-08T19:35:27.634Z'
12278                         updated_at: '2022-11-08T19:35:27.644Z'
12279                         backorderable: true
12280                         deleted_at:
12281                         public_metadata: {}
12282                         private_metadata: {}
12283                         is_available: true
12284                       relationships:
12285                         stock_location:
12286                           data:
12287                             id: '157'
12288                             type: stock_location
12289                         variant:
12290                           data:
12291                             id: '272'
12292                             type: variant
12293                     meta:
12294                       count: 2
12295                       total_count: 2
12296                       total_pages: 1
12297                     links:
12298                       self: http://www.example.com/api/v2/platform/stock_items?page=1&per_page=&include=
12299                       next: http://www.example.com/api/v2/platform/stock_items?include=&page=1&per_page=
12300                       prev: http://www.example.com/api/v2/platform/stock_items?include=&page=1&per_page=
12301                       last: http://www.example.com/api/v2/platform/stock_items?include=&page=1&per_page=
12302                       first: http://www.example.com/api/v2/platform/stock_items?include=&page=1&per_page=
12303               schema:
12304                 "$ref": "#/components/schemas/resources_list"
12305         '401':
12306           description: Authentication Failed
12307           content:
12308             application/vnd.api+json:
12309               examples:
12310                 Example:
12311                   value:
12312                     error: The access token is invalid
12313               schema:
12314                 "$ref": "#/components/schemas/error"
12315     post:
12316       summary: Create a Stock Item
12317       tags:
12318       - Stock Items
12319       security:
12320       - bearer_auth: []
12321       description: Creates a Stock Item
12322       operationId: create-stock-item
12323       parameters:
12324       - name: include
12325         in: query
12326         description: 'Select which associated resources you would like to fetch, see:
12327           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
12328         example: stock_location,variant
12329         schema:
12330           type: string
12331       responses:
12332         '201':
12333           description: Record created
12334           content:
12335             application/vnd.api+json:
12336               examples:
12337                 Example:
12338                   value:
12339                     data:
12340                       id: '285'
12341                       type: stock_item
12342                       attributes:
12343                         count_on_hand: 0
12344                         created_at: '2022-11-08T19:35:28.366Z'
12345                         updated_at: '2022-11-08T19:35:28.366Z'
12346                         backorderable: false
12347                         deleted_at:
12348                         public_metadata: {}
12349                         private_metadata: {}
12350                         is_available: false
12351                       relationships:
12352                         stock_location:
12353                           data:
12354                             id: '160'
12355                             type: stock_location
12356                         variant:
12357                           data:
12358                             id: '276'
12359                             type: variant
12360               schema:
12361                 "$ref": "#/components/schemas/resource"
12362         '422':
12363           description: Invalid request
12364           content:
12365             application/vnd.api+json:
12366               examples:
12367                 Example:
12368                   value:
12369                     error: Stock location can't be blank and Variant can't be blank
12370                     errors:
12371                       stock_location:
12372                       - can't be blank
12373                       variant:
12374                       - can't be blank
12375               schema:
12376                 "$ref": "#/components/schemas/validation_errors"
12377       requestBody:
12378         content:
12379           application/json:
12380             schema:
12381               "$ref": "#/components/schemas/create_stock_item_params"
12382   "/api/v2/platform/stock_items/{id}":
12383     get:
12384       summary: Return a Stock Item
12385       tags:
12386       - Stock Items
12387       security:
12388       - bearer_auth: []
12389       description: Returns a Stock Item
12390       operationId: show-stock-item
12391       parameters:
12392       - name: id
12393         in: path
12394         required: true
12395         schema:
12396           type: string
12397       - name: include
12398         in: query
12399         description: 'Select which associated resources you would like to fetch, see:
12400           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
12401         example: stock_location,variant
12402         schema:
12403           type: string
12404       responses:
12405         '200':
12406           description: Record found
12407           content:
12408             application/vnd.api+json:
12409               examples:
12410                 Example:
12411                   value:
12412                     data:
12413                       id: '287'
12414                       type: stock_item
12415                       attributes:
12416                         count_on_hand: 10
12417                         created_at: '2022-11-08T19:35:28.695Z'
12418                         updated_at: '2022-11-08T19:35:28.707Z'
12419                         backorderable: true
12420                         deleted_at:
12421                         public_metadata: {}
12422                         private_metadata: {}
12423                         is_available: true
12424                       relationships:
12425                         stock_location:
12426                           data:
12427                             id: '162'
12428                             type: stock_location
12429                         variant:
12430                           data:
12431                             id: '277'
12432                             type: variant
12433               schema:
12434                 "$ref": "#/components/schemas/resource"
12435         '404':
12436           description: Record not found
12437           content:
12438             application/vnd.api+json:
12439               examples:
12440                 Example:
12441                   value:
12442                     error: The resource you were looking for could not be found.
12443               schema:
12444                 "$ref": "#/components/schemas/error"
12445         '401':
12446           description: Authentication Failed
12447           content:
12448             application/vnd.api+json:
12449               examples:
12450                 Example:
12451                   value:
12452                     error: The access token is invalid
12453               schema:
12454                 "$ref": "#/components/schemas/error"
12455     patch:
12456       summary: Update a Stock Item
12457       tags:
12458       - Stock Items
12459       security:
12460       - bearer_auth: []
12461       description: Updates a Stock Item
12462       operationId: update-stock-item
12463       parameters:
12464       - name: id
12465         in: path
12466         required: true
12467         schema:
12468           type: string
12469       - name: include
12470         in: query
12471         description: 'Select which associated resources you would like to fetch, see:
12472           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
12473         example: stock_location,variant
12474         schema:
12475           type: string
12476       responses:
12477         '200':
12478           description: Record updated
12479           content:
12480             application/vnd.api+json:
12481               examples:
12482                 Example:
12483                   value:
12484                     data:
12485                       id: '291'
12486                       type: stock_item
12487                       attributes:
12488                         count_on_hand: 200
12489                         created_at: '2022-11-08T19:35:29.347Z'
12490                         updated_at: '2022-11-08T19:35:29.598Z'
12491                         backorderable: true
12492                         deleted_at:
12493                         public_metadata: {}
12494                         private_metadata: {}
12495                         is_available: true
12496                       relationships:
12497                         stock_location:
12498                           data:
12499                             id: '166'
12500                             type: stock_location
12501                         variant:
12502                           data:
12503                             id: '279'
12504                             type: variant
12505               schema:
12506                 "$ref": "#/components/schemas/resource"
12507         '422':
12508           description: Invalid request
12509           content:
12510             application/vnd.api+json:
12511               examples:
12512                 Example:
12513                   value:
12514                     error: Variant can't be blank
12515                     errors:
12516                       variant:
12517                       - can't be blank
12518               schema:
12519                 "$ref": "#/components/schemas/validation_errors"
12520         '404':
12521           description: Record not found
12522           content:
12523             application/vnd.api+json:
12524               examples:
12525                 Example:
12526                   value:
12527                     error: The resource you were looking for could not be found.
12528               schema:
12529                 "$ref": "#/components/schemas/error"
12530         '401':
12531           description: Authentication Failed
12532           content:
12533             application/vnd.api+json:
12534               examples:
12535                 Example:
12536                   value:
12537                     error: The access token is invalid
12538               schema:
12539                 "$ref": "#/components/schemas/error"
12540       requestBody:
12541         content:
12542           application/json:
12543             schema:
12544               "$ref": "#/components/schemas/update_stock_item_params"
12545     delete:
12546       summary: Delete a Stock Item
12547       tags:
12548       - Stock Items
12549       security:
12550       - bearer_auth: []
12551       description: Deletes a Stock Item
12552       operationId: delete-stock-item
12553       parameters:
12554       - name: id
12555         in: path
12556         required: true
12557         schema:
12558           type: string
12559       responses:
12560         '204':
12561           description: Record deleted
12562         '404':
12563           description: Record not found
12564           content:
12565             application/vnd.api+json:
12566               examples:
12567                 Example:
12568                   value:
12569                     error: The resource you were looking for could not be found.
12570               schema:
12571                 "$ref": "#/components/schemas/error"
12572         '401':
12573           description: Authentication Failed
12574           content:
12575             application/vnd.api+json:
12576               examples:
12577                 Example:
12578                   value:
12579                     error: The access token is invalid
12580               schema:
12581                 "$ref": "#/components/schemas/error"
12582   "/api/v2/platform/stock_locations":
12583     get:
12584       summary: Return a list of Stock Locations
12585       tags:
12586       - Stock Locations
12587       security:
12588       - bearer_auth: []
12589       description: Returns a list of Stock Locations
12590       operationId: stock-locations-list
12591       parameters:
12592       - name: page
12593         in: query
12594         example: 1
12595         schema:
12596           type: integer
12597       - name: per_page
12598         in: query
12599         example: 50
12600         schema:
12601           type: integer
12602       - name: include
12603         in: query
12604         description: 'Select which associated resources you would like to fetch, see:
12605           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
12606         example: country
12607         schema:
12608           type: string
12609       responses:
12610         '200':
12611           description: Records returned
12612           content:
12613             application/vnd.api+json:
12614               examples:
12615                 Example:
12616                   value:
12617                     data:
12618                     - id: '175'
12619                       type: stock_location
12620                       attributes:
12621                         name: Jonnie Pollich
12622                         created_at: '2022-11-08T19:35:30.989Z'
12623                         updated_at: '2022-11-08T19:35:30.989Z'
12624                         default: false
12625                         address1: 1600 Pennsylvania Ave NW
12626                         address2:
12627                         city: Washington
12628                         state_name:
12629                         zipcode: '20500'
12630                         phone: "(202) 456-1111"
12631                         active: true
12632                         backorderable_default: true
12633                         propagate_all_variants: false
12634                         admin_name:
12635                       relationships:
12636                         country:
12637                           data:
12638                             id: '413'
12639                             type: country
12640                     - id: '176'
12641                       type: stock_location
12642                       attributes:
12643                         name: Lidia Hamill
12644                         created_at: '2022-11-08T19:35:30.991Z'
12645                         updated_at: '2022-11-08T19:35:30.991Z'
12646                         default: false
12647                         address1: 1600 Pennsylvania Ave NW
12648                         address2:
12649                         city: Washington
12650                         state_name:
12651                         zipcode: '20500'
12652                         phone: "(202) 456-1111"
12653                         active: true
12654                         backorderable_default: true
12655                         propagate_all_variants: false
12656                         admin_name:
12657                       relationships:
12658                         country:
12659                           data:
12660                             id: '413'
12661                             type: country
12662                     meta:
12663                       count: 2
12664                       total_count: 2
12665                       total_pages: 1
12666                     links:
12667                       self: http://www.example.com/api/v2/platform/stock_locations?page=1&per_page=&include=
12668                       next: http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=
12669                       prev: http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=
12670                       last: http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=
12671                       first: http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=
12672               schema:
12673                 "$ref": "#/components/schemas/resources_list"
12674         '401':
12675           description: Authentication Failed
12676           content:
12677             application/vnd.api+json:
12678               examples:
12679                 Example:
12680                   value:
12681                     error: The access token is invalid
12682               schema:
12683                 "$ref": "#/components/schemas/error"
12684     post:
12685       summary: Create a Stock Location
12686       tags:
12687       - Stock Locations
12688       security:
12689       - bearer_auth: []
12690       description: Creates a Stock Location
12691       operationId: create-stock-location
12692       parameters:
12693       - name: include
12694         in: query
12695         description: 'Select which associated resources you would like to fetch, see:
12696           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
12697         example: country
12698         schema:
12699           type: string
12700       responses:
12701         '201':
12702           description: Record created
12703           content:
12704             application/vnd.api+json:
12705               examples:
12706                 Example:
12707                   value:
12708                     data:
12709                       id: '179'
12710                       type: stock_location
12711                       attributes:
12712                         name: Lon McClure
12713                         created_at: '2022-11-08T19:35:31.517Z'
12714                         updated_at: '2022-11-08T19:35:31.517Z'
12715                         default: false
12716                         address1: 1600 Pennsylvania Ave NW
12717                         address2:
12718                         city: Washington
12719                         state_name:
12720                         zipcode: '20500'
12721                         phone: "(202) 456-1111"
12722                         active: true
12723                         backorderable_default: true
12724                         propagate_all_variants: false
12725                         admin_name:
12726                       relationships:
12727                         country:
12728                           data:
12729                             id: '415'
12730                             type: country
12731               schema:
12732                 "$ref": "#/components/schemas/resource"
12733         '422':
12734           description: Invalid request
12735           content:
12736             application/vnd.api+json:
12737               examples:
12738                 Example:
12739                   value:
12740                     error: Name can't be blank
12741                     errors:
12742                       name:
12743                       - can't be blank
12744               schema:
12745                 "$ref": "#/components/schemas/validation_errors"
12746       requestBody:
12747         content:
12748           application/json:
12749             schema:
12750               "$ref": "#/components/schemas/create_stock_location_params"
12751   "/api/v2/platform/stock_locations/{id}":
12752     get:
12753       summary: Return a Stock Location
12754       tags:
12755       - Stock Locations
12756       security:
12757       - bearer_auth: []
12758       description: Returns a Stock Location
12759       operationId: show-stock-location
12760       parameters:
12761       - name: id
12762         in: path
12763         required: true
12764         schema:
12765           type: string
12766       - name: include
12767         in: query
12768         description: 'Select which associated resources you would like to fetch, see:
12769           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
12770         example: country
12771         schema:
12772           type: string
12773       responses:
12774         '200':
12775           description: Record found
12776           content:
12777             application/vnd.api+json:
12778               examples:
12779                 Example:
12780                   value:
12781                     data:
12782                       id: '180'
12783                       type: stock_location
12784                       attributes:
12785                         name: Dian Hills
12786                         created_at: '2022-11-08T19:35:31.785Z'
12787                         updated_at: '2022-11-08T19:35:31.785Z'
12788                         default: false
12789                         address1: 1600 Pennsylvania Ave NW
12790                         address2:
12791                         city: Washington
12792                         state_name:
12793                         zipcode: '20500'
12794                         phone: "(202) 456-1111"
12795                         active: true
12796                         backorderable_default: true
12797                         propagate_all_variants: false
12798                         admin_name:
12799                       relationships:
12800                         country:
12801                           data:
12802                             id: '417'
12803                             type: country
12804               schema:
12805                 "$ref": "#/components/schemas/resource"
12806         '404':
12807           description: Record not found
12808           content:
12809             application/vnd.api+json:
12810               examples:
12811                 Example:
12812                   value:
12813                     error: The resource you were looking for could not be found.
12814               schema:
12815                 "$ref": "#/components/schemas/error"
12816         '401':
12817           description: Authentication Failed
12818           content:
12819             application/vnd.api+json:
12820               examples:
12821                 Example:
12822                   value:
12823                     error: The access token is invalid
12824               schema:
12825                 "$ref": "#/components/schemas/error"
12826     patch:
12827       summary: Update a Stock Location
12828       tags:
12829       - Stock Locations
12830       security:
12831       - bearer_auth: []
12832       description: Updates a Stock Location
12833       operationId: update-stock-location
12834       parameters:
12835       - name: id
12836         in: path
12837         required: true
12838         schema:
12839           type: string
12840       - name: include
12841         in: query
12842         description: 'Select which associated resources you would like to fetch, see:
12843           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
12844         example: country
12845         schema:
12846           type: string
12847       responses:
12848         '200':
12849           description: Record updated
12850           content:
12851             application/vnd.api+json:
12852               examples:
12853                 Example:
12854                   value:
12855                     data:
12856                       id: '182'
12857                       type: stock_location
12858                       attributes:
12859                         name: Warehouse 3
12860                         created_at: '2022-11-08T19:35:32.309Z'
12861                         updated_at: '2022-11-08T19:35:32.538Z'
12862                         default: true
12863                         address1: South Street 8/2
12864                         address2:
12865                         city: Los Angeles
12866                         state_name:
12867                         zipcode: '11223'
12868                         phone: "(202) 456-1111"
12869                         active: true
12870                         backorderable_default: true
12871                         propagate_all_variants: false
12872                         admin_name:
12873                       relationships:
12874                         country:
12875                           data:
12876                             id: '420'
12877                             type: country
12878               schema:
12879                 "$ref": "#/components/schemas/resource"
12880         '422':
12881           description: Invalid request
12882           content:
12883             application/vnd.api+json:
12884               examples:
12885                 Example:
12886                   value:
12887                     error: Name can't be blank
12888                     errors:
12889                       name:
12890                       - can't be blank
12891               schema:
12892                 "$ref": "#/components/schemas/validation_errors"
12893         '404':
12894           description: Record not found
12895           content:
12896             application/vnd.api+json:
12897               examples:
12898                 Example:
12899                   value:
12900                     error: The resource you were looking for could not be found.
12901               schema:
12902                 "$ref": "#/components/schemas/error"
12903         '401':
12904           description: Authentication Failed
12905           content:
12906             application/vnd.api+json:
12907               examples:
12908                 Example:
12909                   value:
12910                     error: The access token is invalid
12911               schema:
12912                 "$ref": "#/components/schemas/error"
12913       requestBody:
12914         content:
12915           application/json:
12916             schema:
12917               "$ref": "#/components/schemas/update_stock_location_params"
12918     delete:
12919       summary: Delete a Stock Location
12920       tags:
12921       - Stock Locations
12922       security:
12923       - bearer_auth: []
12924       description: Deletes a Stock Location
12925       operationId: delete-stock-location
12926       parameters:
12927       - name: id
12928         in: path
12929         required: true
12930         schema:
12931           type: string
12932       responses:
12933         '204':
12934           description: Record deleted
12935         '404':
12936           description: Record not found
12937           content:
12938             application/vnd.api+json:
12939               examples:
12940                 Example:
12941                   value:
12942                     error: The resource you were looking for could not be found.
12943               schema:
12944                 "$ref": "#/components/schemas/error"
12945         '401':
12946           description: Authentication Failed
12947           content:
12948             application/vnd.api+json:
12949               examples:
12950                 Example:
12951                   value:
12952                     error: The access token is invalid
12953               schema:
12954                 "$ref": "#/components/schemas/error"
12955   "/api/v2/platform/store_credit_categories":
12956     get:
12957       summary: Return a list of Store Credit Categories
12958       tags:
12959       - Store Credit Categories
12960       security:
12961       - bearer_auth: []
12962       description: Returns a list of Store Credit Categories
12963       operationId: store-credit-categories-list
12964       parameters:
12965       - name: page
12966         in: query
12967         example: 1
12968         schema:
12969           type: integer
12970       - name: per_page
12971         in: query
12972         example: 50
12973         schema:
12974           type: integer
12975       - name: filter[name_eq]
12976         in: query
12977         description: ''
12978         example: refunded
12979         schema:
12980           type: string
12981       responses:
12982         '200':
12983           description: Records returned
12984           content:
12985             application/vnd.api+json:
12986               examples:
12987                 Example:
12988                   value:
12989                     data:
12990                     - id: '2'
12991                       type: store_credit_category
12992                       attributes:
12993                         name: Exchange
12994                         created_at: '2022-11-08T19:35:33.588Z'
12995                         updated_at: '2022-11-08T19:35:33.588Z'
12996                     - id: '3'
12997                       type: store_credit_category
12998                       attributes:
12999                         name: Exchange
13000                         created_at: '2022-11-08T19:35:33.589Z'
13001                         updated_at: '2022-11-08T19:35:33.589Z'
13002                     meta:
13003                       count: 2
13004                       total_count: 2
13005                       total_pages: 1
13006                     links:
13007                       self: http://www.example.com/api/v2/platform/store_credit_categories?page=1&per_page=&filter[name_eq]=
13008                       next: http://www.example.com/api/v2/platform/store_credit_categories?filter%5Bname_eq%5D=&page=1&per_page=
13009                       prev: http://www.example.com/api/v2/platform/store_credit_categories?filter%5Bname_eq%5D=&page=1&per_page=
13010                       last: http://www.example.com/api/v2/platform/store_credit_categories?filter%5Bname_eq%5D=&page=1&per_page=
13011                       first: http://www.example.com/api/v2/platform/store_credit_categories?filter%5Bname_eq%5D=&page=1&per_page=
13012               schema:
13013                 "$ref": "#/components/schemas/resources_list"
13014         '401':
13015           description: Authentication Failed
13016           content:
13017             application/vnd.api+json:
13018               examples:
13019                 Example:
13020                   value:
13021                     error: The access token is invalid
13022               schema:
13023                 "$ref": "#/components/schemas/error"
13024     post:
13025       summary: Create a Store Credit Category
13026       tags:
13027       - Store Credit Categories
13028       security:
13029       - bearer_auth: []
13030       description: Creates a Store Credit Category
13031       operationId: create-store-credit-category
13032       parameters: []
13033       responses:
13034         '201':
13035           description: Record created
13036           content:
13037             application/vnd.api+json:
13038               examples:
13039                 Example:
13040                   value:
13041                     data:
13042                       id: '6'
13043                       type: store_credit_category
13044                       attributes:
13045                         name: Exchange
13046                         created_at: '2022-11-08T19:35:34.099Z'
13047                         updated_at: '2022-11-08T19:35:34.099Z'
13048               schema:
13049                 "$ref": "#/components/schemas/resource"
13050         '422':
13051           description: Invalid request
13052           content:
13053             application/vnd.api+json:
13054               examples:
13055                 Example:
13056                   value:
13057                     error: Name can't be blank
13058                     errors:
13059                       name:
13060                       - can't be blank
13061               schema:
13062                 "$ref": "#/components/schemas/validation_errors"
13063       requestBody:
13064         content:
13065           application/json:
13066             schema:
13067               "$ref": "#/components/schemas/create_store_credit_category_params"
13068   "/api/v2/platform/store_credit_categories/{id}":
13069     get:
13070       summary: Return a Store Credit Category
13071       tags:
13072       - Store Credit Categories
13073       security:
13074       - bearer_auth: []
13075       description: Returns a Store Credit Category
13076       operationId: show-store-credit-category
13077       parameters:
13078       - name: id
13079         in: path
13080         required: true
13081         schema:
13082           type: string
13083       responses:
13084         '200':
13085           description: Record found
13086           content:
13087             application/vnd.api+json:
13088               examples:
13089                 Example:
13090                   value:
13091                     data:
13092                       id: '7'
13093                       type: store_credit_category
13094                       attributes:
13095                         name: Exchange
13096                         created_at: '2022-11-08T19:35:34.365Z'
13097                         updated_at: '2022-11-08T19:35:34.365Z'
13098               schema:
13099                 "$ref": "#/components/schemas/resource"
13100         '404':
13101           description: Record not found
13102           content:
13103             application/vnd.api+json:
13104               examples:
13105                 Example:
13106                   value:
13107                     error: The resource you were looking for could not be found.
13108               schema:
13109                 "$ref": "#/components/schemas/error"
13110         '401':
13111           description: Authentication Failed
13112           content:
13113             application/vnd.api+json:
13114               examples:
13115                 Example:
13116                   value:
13117                     error: The access token is invalid
13118               schema:
13119                 "$ref": "#/components/schemas/error"
13120     patch:
13121       summary: Update a Store Credit Category
13122       tags:
13123       - Store Credit Categories
13124       security:
13125       - bearer_auth: []
13126       description: Updates a Store Credit Category
13127       operationId: update-store-credit-category
13128       parameters:
13129       - name: id
13130         in: path
13131         required: true
13132         schema:
13133           type: string
13134       responses:
13135         '200':
13136           description: Record updated
13137           content:
13138             application/vnd.api+json:
13139               examples:
13140                 Example:
13141                   value:
13142                     data:
13143                       id: '9'
13144                       type: store_credit_category
13145                       attributes:
13146                         name: refunded
13147                         created_at: '2022-11-08T19:35:34.884Z'
13148                         updated_at: '2022-11-08T19:35:35.112Z'
13149               schema:
13150                 "$ref": "#/components/schemas/resource"
13151         '422':
13152           description: Invalid request
13153           content:
13154             application/vnd.api+json:
13155               examples:
13156                 Example:
13157                   value:
13158                     error: Name can't be blank
13159                     errors:
13160                       name:
13161                       - can't be blank
13162               schema:
13163                 "$ref": "#/components/schemas/validation_errors"
13164         '404':
13165           description: Record not found
13166           content:
13167             application/vnd.api+json:
13168               examples:
13169                 Example:
13170                   value:
13171                     error: The resource you were looking for could not be found.
13172               schema:
13173                 "$ref": "#/components/schemas/error"
13174         '401':
13175           description: Authentication Failed
13176           content:
13177             application/vnd.api+json:
13178               examples:
13179                 Example:
13180                   value:
13181                     error: The access token is invalid
13182               schema:
13183                 "$ref": "#/components/schemas/error"
13184       requestBody:
13185         content:
13186           application/json:
13187             schema:
13188               "$ref": "#/components/schemas/update_store_credit_category_params"
13189     delete:
13190       summary: Delete a Store Credit Category
13191       tags:
13192       - Store Credit Categories
13193       security:
13194       - bearer_auth: []
13195       description: Deletes a Store Credit Category
13196       operationId: delete-store-credit-category
13197       parameters:
13198       - name: id
13199         in: path
13200         required: true
13201         schema:
13202           type: string
13203       responses:
13204         '204':
13205           description: Record deleted
13206         '404':
13207           description: Record not found
13208           content:
13209             application/vnd.api+json:
13210               examples:
13211                 Example:
13212                   value:
13213                     error: The resource you were looking for could not be found.
13214               schema:
13215                 "$ref": "#/components/schemas/error"
13216         '401':
13217           description: Authentication Failed
13218           content:
13219             application/vnd.api+json:
13220               examples:
13221                 Example:
13222                   value:
13223                     error: The access token is invalid
13224               schema:
13225                 "$ref": "#/components/schemas/error"
13226   "/api/v2/platform/store_credit_types":
13227     get:
13228       summary: Return a list of Store Credit Types
13229       tags:
13230       - Store Credit Types
13231       security:
13232       - bearer_auth: []
13233       description: Returns a list of Store Credit Types
13234       operationId: store-credit-types-list
13235       parameters:
13236       - name: page
13237         in: query
13238         example: 1
13239         schema:
13240           type: integer
13241       - name: per_page
13242         in: query
13243         example: 50
13244         schema:
13245           type: integer
13246       responses:
13247         '200':
13248           description: Records returned
13249           content:
13250             application/vnd.api+json:
13251               examples:
13252                 Example:
13253                   value:
13254                     data:
13255                     - id: '2'
13256                       type: store_credit_type
13257                       attributes:
13258                         name: Expiring
13259                         priority: 1
13260                         created_at: '2022-11-08T19:35:36.152Z'
13261                         updated_at: '2022-11-08T19:35:36.152Z'
13262                     - id: '3'
13263                       type: store_credit_type
13264                       attributes:
13265                         name: Expiring
13266                         priority: 1
13267                         created_at: '2022-11-08T19:35:36.153Z'
13268                         updated_at: '2022-11-08T19:35:36.153Z'
13269                     meta:
13270                       count: 2
13271                       total_count: 2
13272                       total_pages: 1
13273                     links:
13274                       self: http://www.example.com/api/v2/platform/store_credit_types?page=1&per_page=
13275                       next: http://www.example.com/api/v2/platform/store_credit_types?page=1&per_page=
13276                       prev: http://www.example.com/api/v2/platform/store_credit_types?page=1&per_page=
13277                       last: http://www.example.com/api/v2/platform/store_credit_types?page=1&per_page=
13278                       first: http://www.example.com/api/v2/platform/store_credit_types?page=1&per_page=
13279               schema:
13280                 "$ref": "#/components/schemas/resources_list"
13281         '401':
13282           description: Authentication Failed
13283           content:
13284             application/vnd.api+json:
13285               examples:
13286                 Example:
13287                   value:
13288                     error: The access token is invalid
13289               schema:
13290                 "$ref": "#/components/schemas/error"
13291     post:
13292       summary: Create a Store Credit Type
13293       tags:
13294       - Store Credit Types
13295       security:
13296       - bearer_auth: []
13297       description: Creates a Store Credit Type
13298       operationId: create-store-credit-type
13299       parameters: []
13300       responses:
13301         '201':
13302           description: Record created
13303           content:
13304             application/vnd.api+json:
13305               examples:
13306                 Example:
13307                   value:
13308                     data:
13309                       id: '6'
13310                       type: store_credit_type
13311                       attributes:
13312                         name: Expiring
13313                         priority: 1
13314                         created_at: '2022-11-08T19:35:36.660Z'
13315                         updated_at: '2022-11-08T19:35:36.660Z'
13316               schema:
13317                 "$ref": "#/components/schemas/resource"
13318         '422':
13319           description: Invalid request
13320           content:
13321             application/vnd.api+json:
13322               examples:
13323                 Example:
13324                   value:
13325                     error: Name can't be blank
13326                     errors:
13327                       name:
13328                       - can't be blank
13329               schema:
13330                 "$ref": "#/components/schemas/validation_errors"
13331       requestBody:
13332         content:
13333           application/json:
13334             schema:
13335               "$ref": "#/components/schemas/create_store_credit_type_params"
13336   "/api/v2/platform/store_credit_types/{id}":
13337     get:
13338       summary: Return a Store Credit Type
13339       tags:
13340       - Store Credit Types
13341       security:
13342       - bearer_auth: []
13343       description: Returns a Store Credit Type
13344       operationId: show-store-credit-type
13345       parameters:
13346       - name: id
13347         in: path
13348         required: true
13349         schema:
13350           type: string
13351       responses:
13352         '200':
13353           description: Record found
13354           content:
13355             application/vnd.api+json:
13356               examples:
13357                 Example:
13358                   value:
13359                     data:
13360                       id: '7'
13361                       type: store_credit_type
13362                       attributes:
13363                         name: Expiring
13364                         priority: 1
13365                         created_at: '2022-11-08T19:35:36.930Z'
13366                         updated_at: '2022-11-08T19:35:36.930Z'
13367               schema:
13368                 "$ref": "#/components/schemas/resource"
13369         '404':
13370           description: Record not found
13371           content:
13372             application/vnd.api+json:
13373               examples:
13374                 Example:
13375                   value:
13376                     error: The resource you were looking for could not be found.
13377               schema:
13378                 "$ref": "#/components/schemas/error"
13379         '401':
13380           description: Authentication Failed
13381           content:
13382             application/vnd.api+json:
13383               examples:
13384                 Example:
13385                   value:
13386                     error: The access token is invalid
13387               schema:
13388                 "$ref": "#/components/schemas/error"
13389     patch:
13390       summary: Update a Store Credit Type
13391       tags:
13392       - Store Credit Types
13393       security:
13394       - bearer_auth: []
13395       description: Updates a Store Credit Type
13396       operationId: update-store-credit-type
13397       parameters:
13398       - name: id
13399         in: path
13400         required: true
13401         schema:
13402           type: string
13403       responses:
13404         '200':
13405           description: Record updated
13406           content:
13407             application/vnd.api+json:
13408               examples:
13409                 Example:
13410                   value:
13411                     data:
13412                       id: '9'
13413                       type: store_credit_type
13414                       attributes:
13415                         name: default
13416                         priority: 1
13417                         created_at: '2022-11-08T19:35:37.442Z'
13418                         updated_at: '2022-11-08T19:35:37.670Z'
13419               schema:
13420                 "$ref": "#/components/schemas/resource"
13421         '422':
13422           description: Invalid request
13423           content:
13424             application/vnd.api+json:
13425               examples:
13426                 Example:
13427                   value:
13428                     error: Name can't be blank
13429                     errors:
13430                       name:
13431                       - can't be blank
13432               schema:
13433                 "$ref": "#/components/schemas/validation_errors"
13434         '404':
13435           description: Record not found
13436           content:
13437             application/vnd.api+json:
13438               examples:
13439                 Example:
13440                   value:
13441                     error: The resource you were looking for could not be found.
13442               schema:
13443                 "$ref": "#/components/schemas/error"
13444         '401':
13445           description: Authentication Failed
13446           content:
13447             application/vnd.api+json:
13448               examples:
13449                 Example:
13450                   value:
13451                     error: The access token is invalid
13452               schema:
13453                 "$ref": "#/components/schemas/error"
13454       requestBody:
13455         content:
13456           application/json:
13457             schema:
13458               "$ref": "#/components/schemas/update_store_credit_type_params"
13459     delete:
13460       summary: Delete a Store Credit Type
13461       tags:
13462       - Store Credit Types
13463       security:
13464       - bearer_auth: []
13465       description: Deletes a Store Credit Type
13466       operationId: delete-store-credit-type
13467       parameters:
13468       - name: id
13469         in: path
13470         required: true
13471         schema:
13472           type: string
13473       responses:
13474         '204':
13475           description: Record deleted
13476         '404':
13477           description: Record not found
13478           content:
13479             application/vnd.api+json:
13480               examples:
13481                 Example:
13482                   value:
13483                     error: The resource you were looking for could not be found.
13484               schema:
13485                 "$ref": "#/components/schemas/error"
13486         '401':
13487           description: Authentication Failed
13488           content:
13489             application/vnd.api+json:
13490               examples:
13491                 Example:
13492                   value:
13493                     error: The access token is invalid
13494               schema:
13495                 "$ref": "#/components/schemas/error"
13496   "/api/v2/platform/store_credits":
13497     get:
13498       summary: Return a list of Store Credits
13499       tags:
13500       - Store Credits
13501       security:
13502       - bearer_auth: []
13503       description: Returns a list of Store Credits
13504       operationId: store-credits-list
13505       parameters:
13506       - name: page
13507         in: query
13508         example: 1
13509         schema:
13510           type: integer
13511       - name: per_page
13512         in: query
13513         example: 50
13514         schema:
13515           type: integer
13516       - name: include
13517         in: query
13518         description: 'Select which associated resources you would like to fetch, see:
13519           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
13520         example: user,created_by,category,credit_type
13521         schema:
13522           type: string
13523       - name: filter[user_id_eq]
13524         in: query
13525         description: ''
13526         example: '5'
13527         schema:
13528           type: string
13529       - name: filter[created_by_id_eq]
13530         in: query
13531         description: ''
13532         example: '2'
13533         schema:
13534           type: string
13535       - name: filter[amount_gteq]
13536         in: query
13537         description: ''
13538         example: '50.0'
13539         schema:
13540           type: string
13541       - name: filter[currency_eq]
13542         in: query
13543         description: ''
13544         example: USD
13545         schema:
13546           type: string
13547       responses:
13548         '200':
13549           description: Records returned
13550           content:
13551             application/vnd.api+json:
13552               examples:
13553                 Example:
13554                   value:
13555                     data:
13556                     - id: '2'
13557                       type: store_credit
13558                       attributes:
13559                         amount: '150.0'
13560                         amount_used: '0.0'
13561                         memo:
13562                         deleted_at:
13563                         currency: USD
13564                         amount_authorized: '0.0'
13565                         originator_type:
13566                         created_at: '2022-11-08T19:35:38.714Z'
13567                         updated_at: '2022-11-08T19:35:38.714Z'
13568                         public_metadata: {}
13569                         private_metadata: {}
13570                         display_amount: "$150.00"
13571                         display_amount_used: "$0.00"
13572                       relationships:
13573                         user:
13574                           data:
13575                             id: '107'
13576                             type: user
13577                         created_by:
13578                           data:
13579                             id: '108'
13580                             type: user
13581                         store_credit_category:
13582                           data:
13583                             id: '14'
13584                             type: store_credit_category
13585                         store_credit_type:
13586                           data:
13587                             id: '14'
13588                             type: store_credit_type
13589                         store_credit_events:
13590                           data:
13591                           - id: '3'
13592                             type: store_credit_event
13593                     - id: '3'
13594                       type: store_credit
13595                       attributes:
13596                         amount: '150.0'
13597                         amount_used: '0.0'
13598                         memo:
13599                         deleted_at:
13600                         currency: USD
13601                         amount_authorized: '0.0'
13602                         originator_type:
13603                         created_at: '2022-11-08T19:35:38.722Z'
13604                         updated_at: '2022-11-08T19:35:38.722Z'
13605                         public_metadata: {}
13606                         private_metadata: {}
13607                         display_amount: "$150.00"
13608                         display_amount_used: "$0.00"
13609                       relationships:
13610                         user:
13611                           data:
13612                             id: '107'
13613                             type: user
13614                         created_by:
13615                           data:
13616                             id: '109'
13617                             type: user
13618                         store_credit_category:
13619                           data:
13620                             id: '15'
13621                             type: store_credit_category
13622                         store_credit_type:
13623                           data:
13624                             id: '15'
13625                             type: store_credit_type
13626                         store_credit_events:
13627                           data:
13628                           - id: '4'
13629                             type: store_credit_event
13630                     meta:
13631                       count: 2
13632                       total_count: 2
13633                       total_pages: 1
13634                     links:
13635                       self: http://www.example.com/api/v2/platform/store_credits?page=1&per_page=&include=&filter[user_id_eq]=&filter[created_by_id_eq]=&filter[amount_gteq]=&filter[currency_eq]=
13636                       next: http://www.example.com/api/v2/platform/store_credits?filter%5Bamount_gteq%5D=&filter%5Bcreated_by_id_eq%5D=&filter%5Bcurrency_eq%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
13637                       prev: http://www.example.com/api/v2/platform/store_credits?filter%5Bamount_gteq%5D=&filter%5Bcreated_by_id_eq%5D=&filter%5Bcurrency_eq%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
13638                       last: http://www.example.com/api/v2/platform/store_credits?filter%5Bamount_gteq%5D=&filter%5Bcreated_by_id_eq%5D=&filter%5Bcurrency_eq%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
13639                       first: http://www.example.com/api/v2/platform/store_credits?filter%5Bamount_gteq%5D=&filter%5Bcreated_by_id_eq%5D=&filter%5Bcurrency_eq%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
13640               schema:
13641                 "$ref": "#/components/schemas/resources_list"
13642         '401':
13643           description: Authentication Failed
13644           content:
13645             application/vnd.api+json:
13646               examples:
13647                 Example:
13648                   value:
13649                     error: The access token is invalid
13650               schema:
13651                 "$ref": "#/components/schemas/error"
13652     post:
13653       summary: Create a Store Credit
13654       tags:
13655       - Store Credits
13656       security:
13657       - bearer_auth: []
13658       description: Creates a Store Credit
13659       operationId: create-store-credit
13660       parameters:
13661       - name: include
13662         in: query
13663         description: 'Select which associated resources you would like to fetch, see:
13664           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
13665         example: user,created_by,category,credit_type
13666         schema:
13667           type: string
13668       responses:
13669         '201':
13670           description: Record created
13671           content:
13672             application/vnd.api+json:
13673               examples:
13674                 Example:
13675                   value:
13676                     data:
13677                       id: '6'
13678                       type: store_credit
13679                       attributes:
13680                         amount: '150.0'
13681                         amount_used: '0.0'
13682                         memo:
13683                         deleted_at:
13684                         currency: USD
13685                         amount_authorized: '0.0'
13686                         originator_type:
13687                         created_at: '2022-11-08T19:35:39.272Z'
13688                         updated_at: '2022-11-08T19:35:39.272Z'
13689                         public_metadata: {}
13690                         private_metadata: {}
13691                         display_amount: "$150.00"
13692                         display_amount_used: "$0.00"
13693                       relationships:
13694                         user:
13695                           data:
13696                             id: '113'
13697                             type: user
13698                         created_by:
13699                           data:
13700                             id: '114'
13701                             type: user
13702                         store_credit_category:
13703                           data:
13704                             id: '18'
13705                             type: store_credit_category
13706                         store_credit_type:
13707                           data:
13708                             id: '18'
13709                             type: store_credit_type
13710                         store_credit_events:
13711                           data:
13712                           - id: '7'
13713                             type: store_credit_event
13714               schema:
13715                 "$ref": "#/components/schemas/resource"
13716         '422':
13717           description: Invalid request
13718           content:
13719             application/vnd.api+json:
13720               examples:
13721                 Example:
13722                   value:
13723                     error: User can't be blank, Category can't be blank, Created by
13724                       can't be blank, Currency can't be blank, Amount must be greater
13725                       than 0, Amount used Cannot be greater than amount., and Amount
13726                       authorized Exceeds total credits.
13727                     errors:
13728                       user:
13729                       - can't be blank
13730                       category:
13731                       - can't be blank
13732                       created_by:
13733                       - can't be blank
13734                       currency:
13735                       - can't be blank
13736                       amount:
13737                       - must be greater than 0
13738                       amount_used:
13739                       - Cannot be greater than amount.
13740                       amount_authorized:
13741                       - Exceeds total credits.
13742               schema:
13743                 "$ref": "#/components/schemas/validation_errors"
13744       requestBody:
13745         content:
13746           application/json:
13747             schema:
13748               "$ref": "#/components/schemas/create_store_credit_params"
13749   "/api/v2/platform/store_credits/{id}":
13750     get:
13751       summary: Return a Store Credit
13752       tags:
13753       - Store Credits
13754       security:
13755       - bearer_auth: []
13756       description: Returns a Store Credit
13757       operationId: show-store-credit
13758       parameters:
13759       - name: id
13760         in: path
13761         required: true
13762         schema:
13763           type: string
13764       - name: include
13765         in: query
13766         description: 'Select which associated resources you would like to fetch, see:
13767           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
13768         example: user,created_by,category,credit_type
13769         schema:
13770           type: string
13771       responses:
13772         '200':
13773           description: Record found
13774           content:
13775             application/vnd.api+json:
13776               examples:
13777                 Example:
13778                   value:
13779                     data:
13780                       id: '7'
13781                       type: store_credit
13782                       attributes:
13783                         amount: '150.0'
13784                         amount_used: '0.0'
13785                         memo:
13786                         deleted_at:
13787                         currency: USD
13788                         amount_authorized: '0.0'
13789                         originator_type:
13790                         created_at: '2022-11-08T19:35:39.554Z'
13791                         updated_at: '2022-11-08T19:35:39.554Z'
13792                         public_metadata: {}
13793                         private_metadata: {}
13794                         display_amount: "$150.00"
13795                         display_amount_used: "$0.00"
13796                       relationships:
13797                         user:
13798                           data:
13799                             id: '115'
13800                             type: user
13801                         created_by:
13802                           data:
13803                             id: '116'
13804                             type: user
13805                         store_credit_category:
13806                           data:
13807                             id: '19'
13808                             type: store_credit_category
13809                         store_credit_type:
13810                           data:
13811                             id: '20'
13812                             type: store_credit_type
13813                         store_credit_events:
13814                           data:
13815                           - id: '8'
13816                             type: store_credit_event
13817               schema:
13818                 "$ref": "#/components/schemas/resource"
13819         '404':
13820           description: Record not found
13821           content:
13822             application/vnd.api+json:
13823               examples:
13824                 Example:
13825                   value:
13826                     error: The resource you were looking for could not be found.
13827               schema:
13828                 "$ref": "#/components/schemas/error"
13829         '401':
13830           description: Authentication Failed
13831           content:
13832             application/vnd.api+json:
13833               examples:
13834                 Example:
13835                   value:
13836                     error: The access token is invalid
13837               schema:
13838                 "$ref": "#/components/schemas/error"
13839     patch:
13840       summary: Update a Store Credit
13841       tags:
13842       - Store Credits
13843       security:
13844       - bearer_auth: []
13845       description: Updates a Store Credit
13846       operationId: update-store-credit
13847       parameters:
13848       - name: id
13849         in: path
13850         required: true
13851         schema:
13852           type: string
13853       - name: include
13854         in: query
13855         description: 'Select which associated resources you would like to fetch, see:
13856           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
13857         example: user,created_by,category,credit_type
13858         schema:
13859           type: string
13860       responses:
13861         '200':
13862           description: Record updated
13863           content:
13864             application/vnd.api+json:
13865               examples:
13866                 Example:
13867                   value:
13868                     data:
13869                       id: '9'
13870                       type: store_credit
13871                       attributes:
13872                         amount: '500.0'
13873                         amount_used: '0.0'
13874                         memo: The user is awarded
13875                         deleted_at:
13876                         currency: CAD
13877                         amount_authorized: '0.0'
13878                         originator_type:
13879                         created_at: '2022-11-08T19:35:40.170Z'
13880                         updated_at: '2022-11-08T19:35:40.405Z'
13881                         public_metadata:
13882                           loyalty_reward: true
13883                         private_metadata: {}
13884                         display_amount: "$500.00"
13885                         display_amount_used: "$0.00"
13886                       relationships:
13887                         user:
13888                           data:
13889                             id: '119'
13890                             type: user
13891                         created_by:
13892                           data:
13893                             id: '120'
13894                             type: user
13895                         store_credit_category:
13896                           data:
13897                             id: '21'
13898                             type: store_credit_category
13899                         store_credit_type:
13900                           data:
13901                             id: '22'
13902                             type: store_credit_type
13903                         store_credit_events:
13904                           data:
13905                           - id: '10'
13906                             type: store_credit_event
13907               schema:
13908                 "$ref": "#/components/schemas/resource"
13909         '422':
13910           description: Invalid request
13911           content:
13912             application/vnd.api+json:
13913               examples:
13914                 Example:
13915                   value:
13916                     error: Amount must be greater than 0, Amount used Cannot be greater
13917                       than amount., and Amount authorized Exceeds total credits.
13918                     errors:
13919                       amount:
13920                       - must be greater than 0
13921                       amount_used:
13922                       - Cannot be greater than amount.
13923                       amount_authorized:
13924                       - Exceeds total credits.
13925               schema:
13926                 "$ref": "#/components/schemas/validation_errors"
13927         '404':
13928           description: Record not found
13929           content:
13930             application/vnd.api+json:
13931               examples:
13932                 Example:
13933                   value:
13934                     error: The resource you were looking for could not be found.
13935               schema:
13936                 "$ref": "#/components/schemas/error"
13937         '401':
13938           description: Authentication Failed
13939           content:
13940             application/vnd.api+json:
13941               examples:
13942                 Example:
13943                   value:
13944                     error: The access token is invalid
13945               schema:
13946                 "$ref": "#/components/schemas/error"
13947       requestBody:
13948         content:
13949           application/json:
13950             schema:
13951               "$ref": "#/components/schemas/update_store_credit_params"
13952     delete:
13953       summary: Delete a Store Credit
13954       tags:
13955       - Store Credits
13956       security:
13957       - bearer_auth: []
13958       description: Deletes a Store Credit
13959       operationId: delete-store-credit
13960       parameters:
13961       - name: id
13962         in: path
13963         required: true
13964         schema:
13965           type: string
13966       responses:
13967         '204':
13968           description: Record deleted
13969         '404':
13970           description: Record not found
13971           content:
13972             application/vnd.api+json:
13973               examples:
13974                 Example:
13975                   value:
13976                     error: The resource you were looking for could not be found.
13977               schema:
13978                 "$ref": "#/components/schemas/error"
13979         '401':
13980           description: Authentication Failed
13981           content:
13982             application/vnd.api+json:
13983               examples:
13984                 Example:
13985                   value:
13986                     error: The access token is invalid
13987               schema:
13988                 "$ref": "#/components/schemas/error"
13989   "/api/v2/platform/tax_categories":
13990     get:
13991       summary: Return a list of Tax Categories
13992       tags:
13993       - Tax Categories
13994       security:
13995       - bearer_auth: []
13996       description: Returns a list of Tax Categories
13997       operationId: tax-categories-list
13998       parameters:
13999       - name: page
14000         in: query
14001         example: 1
14002         schema:
14003           type: integer
14004       - name: per_page
14005         in: query
14006         example: 50
14007         schema:
14008           type: integer
14009       - name: include
14010         in: query
14011         description: 'Select which associated resources you would like to fetch, see:
14012           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14013         example: tax_rates
14014         schema:
14015           type: string
14016       - name: filter[name_eq]
14017         in: query
14018         description: ''
14019         example: Clothing
14020         schema:
14021           type: string
14022       - name: filter[is_default_true]
14023         in: query
14024         description: ''
14025         example: '1'
14026         schema:
14027           type: string
14028       - name: filter[tax_code_eq]
14029         in: query
14030         description: ''
14031         example: 1257L
14032         schema:
14033           type: string
14034       responses:
14035         '200':
14036           description: Records returned
14037           content:
14038             application/vnd.api+json:
14039               examples:
14040                 Example:
14041                   value:
14042                     data:
14043                     - id: '153'
14044                       type: tax_category
14045                       attributes:
14046                         name: TaxCategory - 54232
14047                         description: Velit qui dignissimos excepturi eum corrupti.
14048                         is_default: false
14049                         deleted_at:
14050                         created_at: '2022-11-08T19:35:41.496Z'
14051                         updated_at: '2022-11-08T19:35:41.496Z'
14052                         tax_code:
14053                       relationships:
14054                         tax_rates:
14055                           data: []
14056                     - id: '154'
14057                       type: tax_category
14058                       attributes:
14059                         name: TaxCategory - 100586
14060                         description: Placeat nihil quaerat nostrum cumque ipsa eius
14061                           perferendis.
14062                         is_default: false
14063                         deleted_at:
14064                         created_at: '2022-11-08T19:35:41.497Z'
14065                         updated_at: '2022-11-08T19:35:41.497Z'
14066                         tax_code:
14067                       relationships:
14068                         tax_rates:
14069                           data: []
14070                     meta:
14071                       count: 2
14072                       total_count: 2
14073                       total_pages: 1
14074                     links:
14075                       self: http://www.example.com/api/v2/platform/tax_categories?page=1&per_page=&include=&filter[name_eq]=&filter[is_default_true]=&filter[tax_code_eq]=
14076                       next: http://www.example.com/api/v2/platform/tax_categories?filter%5Bis_default_true%5D=&filter%5Bname_eq%5D=&filter%5Btax_code_eq%5D=&include=&page=1&per_page=
14077                       prev: http://www.example.com/api/v2/platform/tax_categories?filter%5Bis_default_true%5D=&filter%5Bname_eq%5D=&filter%5Btax_code_eq%5D=&include=&page=1&per_page=
14078                       last: http://www.example.com/api/v2/platform/tax_categories?filter%5Bis_default_true%5D=&filter%5Bname_eq%5D=&filter%5Btax_code_eq%5D=&include=&page=1&per_page=
14079                       first: http://www.example.com/api/v2/platform/tax_categories?filter%5Bis_default_true%5D=&filter%5Bname_eq%5D=&filter%5Btax_code_eq%5D=&include=&page=1&per_page=
14080               schema:
14081                 "$ref": "#/components/schemas/resources_list"
14082         '401':
14083           description: Authentication Failed
14084           content:
14085             application/vnd.api+json:
14086               examples:
14087                 Example:
14088                   value:
14089                     error: The access token is invalid
14090               schema:
14091                 "$ref": "#/components/schemas/error"
14092     post:
14093       summary: Create a Tax Category
14094       tags:
14095       - Tax Categories
14096       security:
14097       - bearer_auth: []
14098       description: Creates a Tax Category
14099       operationId: create-tax-category
14100       parameters:
14101       - name: include
14102         in: query
14103         description: 'Select which associated resources you would like to fetch, see:
14104           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14105         example: tax_rates
14106         schema:
14107           type: string
14108       responses:
14109         '201':
14110           description: Record created
14111           content:
14112             application/vnd.api+json:
14113               examples:
14114                 Example:
14115                   value:
14116                     data:
14117                       id: '157'
14118                       type: tax_category
14119                       attributes:
14120                         name: TaxCategory - 646810
14121                         description: Facilis quis quos unde reiciendis.
14122                         is_default: false
14123                         deleted_at:
14124                         created_at: '2022-11-08T19:35:42.001Z'
14125                         updated_at: '2022-11-08T19:35:42.001Z'
14126                         tax_code:
14127                       relationships:
14128                         tax_rates:
14129                           data: []
14130               schema:
14131                 "$ref": "#/components/schemas/resource"
14132         '422':
14133           description: Invalid request
14134           content:
14135             application/vnd.api+json:
14136               examples:
14137                 Example:
14138                   value:
14139                     error: Name can't be blank
14140                     errors:
14141                       name:
14142                       - can't be blank
14143               schema:
14144                 "$ref": "#/components/schemas/validation_errors"
14145       requestBody:
14146         content:
14147           application/json:
14148             schema:
14149               "$ref": "#/components/schemas/create_tax_category_params"
14150   "/api/v2/platform/tax_categories/{id}":
14151     get:
14152       summary: Return a Tax Category
14153       tags:
14154       - Tax Categories
14155       security:
14156       - bearer_auth: []
14157       description: Returns a Tax Category
14158       operationId: show-tax-category
14159       parameters:
14160       - name: id
14161         in: path
14162         required: true
14163         schema:
14164           type: string
14165       - name: include
14166         in: query
14167         description: 'Select which associated resources you would like to fetch, see:
14168           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14169         example: tax_rates
14170         schema:
14171           type: string
14172       responses:
14173         '200':
14174           description: Record found
14175           content:
14176             application/vnd.api+json:
14177               examples:
14178                 Example:
14179                   value:
14180                     data:
14181                       id: '158'
14182                       type: tax_category
14183                       attributes:
14184                         name: TaxCategory - 71294
14185                         description: Sunt ut autem corrupti explicabo quibusdam nam
14186                           voluptas.
14187                         is_default: false
14188                         deleted_at:
14189                         created_at: '2022-11-08T19:35:42.273Z'
14190                         updated_at: '2022-11-08T19:35:42.273Z'
14191                         tax_code:
14192                       relationships:
14193                         tax_rates:
14194                           data: []
14195               schema:
14196                 "$ref": "#/components/schemas/resource"
14197         '404':
14198           description: Record not found
14199           content:
14200             application/vnd.api+json:
14201               examples:
14202                 Example:
14203                   value:
14204                     error: The resource you were looking for could not be found.
14205               schema:
14206                 "$ref": "#/components/schemas/error"
14207         '401':
14208           description: Authentication Failed
14209           content:
14210             application/vnd.api+json:
14211               examples:
14212                 Example:
14213                   value:
14214                     error: The access token is invalid
14215               schema:
14216                 "$ref": "#/components/schemas/error"
14217     patch:
14218       summary: Update a Tax Category
14219       tags:
14220       - Tax Categories
14221       security:
14222       - bearer_auth: []
14223       description: Updates a Tax Category
14224       operationId: update-tax-category
14225       parameters:
14226       - name: id
14227         in: path
14228         required: true
14229         schema:
14230           type: string
14231       - name: include
14232         in: query
14233         description: 'Select which associated resources you would like to fetch, see:
14234           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14235         example: tax_rates
14236         schema:
14237           type: string
14238       responses:
14239         '200':
14240           description: Record updated
14241           content:
14242             application/vnd.api+json:
14243               examples:
14244                 Example:
14245                   value:
14246                     data:
14247                       id: '160'
14248                       type: tax_category
14249                       attributes:
14250                         name: Clothing
14251                         description: Men's, women's and children's clothing
14252                         is_default: true
14253                         deleted_at:
14254                         created_at: '2022-11-08T19:35:42.789Z'
14255                         updated_at: '2022-11-08T19:35:43.019Z'
14256                         tax_code: 1233K
14257                       relationships:
14258                         tax_rates:
14259                           data: []
14260               schema:
14261                 "$ref": "#/components/schemas/resource"
14262         '422':
14263           description: Invalid request
14264           content:
14265             application/vnd.api+json:
14266               examples:
14267                 Example:
14268                   value:
14269                     error: Name can't be blank
14270                     errors:
14271                       name:
14272                       - can't be blank
14273               schema:
14274                 "$ref": "#/components/schemas/validation_errors"
14275         '404':
14276           description: Record not found
14277           content:
14278             application/vnd.api+json:
14279               examples:
14280                 Example:
14281                   value:
14282                     error: The resource you were looking for could not be found.
14283               schema:
14284                 "$ref": "#/components/schemas/error"
14285         '401':
14286           description: Authentication Failed
14287           content:
14288             application/vnd.api+json:
14289               examples:
14290                 Example:
14291                   value:
14292                     error: The access token is invalid
14293               schema:
14294                 "$ref": "#/components/schemas/error"
14295       requestBody:
14296         content:
14297           application/json:
14298             schema:
14299               "$ref": "#/components/schemas/update_tax_category_params"
14300     delete:
14301       summary: Delete a Tax Category
14302       tags:
14303       - Tax Categories
14304       security:
14305       - bearer_auth: []
14306       description: Deletes a Tax Category
14307       operationId: delete-tax-category
14308       parameters:
14309       - name: id
14310         in: path
14311         required: true
14312         schema:
14313           type: string
14314       responses:
14315         '204':
14316           description: Record deleted
14317         '404':
14318           description: Record not found
14319           content:
14320             application/vnd.api+json:
14321               examples:
14322                 Example:
14323                   value:
14324                     error: The resource you were looking for could not be found.
14325               schema:
14326                 "$ref": "#/components/schemas/error"
14327         '401':
14328           description: Authentication Failed
14329           content:
14330             application/vnd.api+json:
14331               examples:
14332                 Example:
14333                   value:
14334                     error: The access token is invalid
14335               schema:
14336                 "$ref": "#/components/schemas/error"
14337   "/api/v2/platform/tax_rates":
14338     get:
14339       summary: Return a list of Tax Rates
14340       tags:
14341       - Tax Rates
14342       security:
14343       - bearer_auth: []
14344       description: Returns a list of Tax Rates
14345       operationId: tax-rates-list
14346       parameters:
14347       - name: page
14348         in: query
14349         example: 1
14350         schema:
14351           type: integer
14352       - name: per_page
14353         in: query
14354         example: 50
14355         schema:
14356           type: integer
14357       - name: include
14358         in: query
14359         description: 'Select which associated resources you would like to fetch, see:
14360           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14361         example: zone,tax_category
14362         schema:
14363           type: string
14364       - name: filter[zone_id_eq]
14365         in: query
14366         description: ''
14367         example: '3'
14368         schema:
14369           type: string
14370       - name: filter[amount_gt]
14371         in: query
14372         description: ''
14373         example: '0.05'
14374         schema:
14375           type: string
14376       - name: filter[tax_category_id_eq]
14377         in: query
14378         description: ''
14379         example: '1'
14380         schema:
14381           type: string
14382       responses:
14383         '200':
14384           description: Records returned
14385           content:
14386             application/vnd.api+json:
14387               examples:
14388                 Example:
14389                   value:
14390                     data:
14391                     - id: '12'
14392                       type: tax_rate
14393                       attributes:
14394                         amount: '0.1'
14395                         included_in_price: false
14396                         created_at: '2022-11-08T19:35:44.070Z'
14397                         updated_at: '2022-11-08T19:35:44.070Z'
14398                         name: TaxRate - 903896
14399                         show_rate_in_label: true
14400                         deleted_at:
14401                         public_metadata: {}
14402                         private_metadata: {}
14403                       relationships:
14404                         zone:
14405                           data:
14406                             id: '99'
14407                             type: zone
14408                         tax_category:
14409                           data:
14410                             id: '165'
14411                             type: tax_category
14412                     - id: '13'
14413                       type: tax_rate
14414                       attributes:
14415                         amount: '0.1'
14416                         included_in_price: false
14417                         created_at: '2022-11-08T19:35:44.073Z'
14418                         updated_at: '2022-11-08T19:35:44.073Z'
14419                         name: TaxRate - 477775
14420                         show_rate_in_label: true
14421                         deleted_at:
14422                         public_metadata: {}
14423                         private_metadata: {}
14424                       relationships:
14425                         zone:
14426                           data:
14427                             id: '100'
14428                             type: zone
14429                         tax_category:
14430                           data:
14431                             id: '165'
14432                             type: tax_category
14433                     meta:
14434                       count: 2
14435                       total_count: 2
14436                       total_pages: 1
14437                     links:
14438                       self: http://www.example.com/api/v2/platform/tax_rates?page=1&per_page=&include=&filter[zone_id_eq]=&filter[amount_gt]=&filter[tax_category_id_eq]=
14439                       next: http://www.example.com/api/v2/platform/tax_rates?filter%5Bamount_gt%5D=&filter%5Btax_category_id_eq%5D=&filter%5Bzone_id_eq%5D=&include=&page=1&per_page=
14440                       prev: http://www.example.com/api/v2/platform/tax_rates?filter%5Bamount_gt%5D=&filter%5Btax_category_id_eq%5D=&filter%5Bzone_id_eq%5D=&include=&page=1&per_page=
14441                       last: http://www.example.com/api/v2/platform/tax_rates?filter%5Bamount_gt%5D=&filter%5Btax_category_id_eq%5D=&filter%5Bzone_id_eq%5D=&include=&page=1&per_page=
14442                       first: http://www.example.com/api/v2/platform/tax_rates?filter%5Bamount_gt%5D=&filter%5Btax_category_id_eq%5D=&filter%5Bzone_id_eq%5D=&include=&page=1&per_page=
14443               schema:
14444                 "$ref": "#/components/schemas/resources_list"
14445         '401':
14446           description: Authentication Failed
14447           content:
14448             application/vnd.api+json:
14449               examples:
14450                 Example:
14451                   value:
14452                     error: The access token is invalid
14453               schema:
14454                 "$ref": "#/components/schemas/error"
14455     post:
14456       summary: Create a Tax Rate
14457       tags:
14458       - Tax Rates
14459       security:
14460       - bearer_auth: []
14461       description: Creates a Tax Rate
14462       operationId: create-tax-rate
14463       parameters:
14464       - name: include
14465         in: query
14466         description: 'Select which associated resources you would like to fetch, see:
14467           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14468         example: zone,tax_category
14469         schema:
14470           type: string
14471       responses:
14472         '201':
14473           description: Record created
14474           content:
14475             application/vnd.api+json:
14476               examples:
14477                 Example:
14478                   value:
14479                     data:
14480                       id: '16'
14481                       type: tax_rate
14482                       attributes:
14483                         amount: '0.1'
14484                         included_in_price: false
14485                         created_at: '2022-11-08T19:35:44.601Z'
14486                         updated_at: '2022-11-08T19:35:44.601Z'
14487                         name: TaxRate - 772641
14488                         show_rate_in_label: true
14489                         deleted_at:
14490                         public_metadata: {}
14491                         private_metadata: {}
14492                       relationships:
14493                         zone:
14494                           data:
14495                         tax_category:
14496                           data:
14497                             id: '167'
14498                             type: tax_category
14499               schema:
14500                 "$ref": "#/components/schemas/resource"
14501         '422':
14502           description: Invalid request
14503           content:
14504             application/vnd.api+json:
14505               examples:
14506                 Example:
14507                   value:
14508                     error: Calculator can't be blank, Rate can't be blank, Tax category
14509                       can't be blank, and Name can't be blank
14510                     errors:
14511                       calculator:
14512                       - can't be blank
14513                       amount:
14514                       - can't be blank
14515                       tax_category:
14516                       - can't be blank
14517                       name:
14518                       - can't be blank
14519               schema:
14520                 "$ref": "#/components/schemas/validation_errors"
14521       requestBody:
14522         content:
14523           application/json:
14524             schema:
14525               "$ref": "#/components/schemas/create_tax_rate_params"
14526   "/api/v2/platform/tax_rates/{id}":
14527     get:
14528       summary: Return a Tax Rate
14529       tags:
14530       - Tax Rates
14531       security:
14532       - bearer_auth: []
14533       description: Returns a Tax Rate
14534       operationId: show-tax-rate
14535       parameters:
14536       - name: id
14537         in: path
14538         required: true
14539         schema:
14540           type: string
14541       - name: include
14542         in: query
14543         description: 'Select which associated resources you would like to fetch, see:
14544           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14545         example: zone,tax_category
14546         schema:
14547           type: string
14548       responses:
14549         '200':
14550           description: Record found
14551           content:
14552             application/vnd.api+json:
14553               examples:
14554                 Example:
14555                   value:
14556                     data:
14557                       id: '17'
14558                       type: tax_rate
14559                       attributes:
14560                         amount: '0.1'
14561                         included_in_price: false
14562                         created_at: '2022-11-08T19:35:44.874Z'
14563                         updated_at: '2022-11-08T19:35:44.874Z'
14564                         name: TaxRate - 83823
14565                         show_rate_in_label: true
14566                         deleted_at:
14567                         public_metadata: {}
14568                         private_metadata: {}
14569                       relationships:
14570                         zone:
14571                           data:
14572                             id: '103'
14573                             type: zone
14574                         tax_category:
14575                           data:
14576                             id: '168'
14577                             type: tax_category
14578               schema:
14579                 "$ref": "#/components/schemas/resource"
14580         '404':
14581           description: Record not found
14582           content:
14583             application/vnd.api+json:
14584               examples:
14585                 Example:
14586                   value:
14587                     error: The resource you were looking for could not be found.
14588               schema:
14589                 "$ref": "#/components/schemas/error"
14590         '401':
14591           description: Authentication Failed
14592           content:
14593             application/vnd.api+json:
14594               examples:
14595                 Example:
14596                   value:
14597                     error: The access token is invalid
14598               schema:
14599                 "$ref": "#/components/schemas/error"
14600     patch:
14601       summary: Update a Tax Rate
14602       tags:
14603       - Tax Rates
14604       security:
14605       - bearer_auth: []
14606       description: Updates a Tax Rate
14607       operationId: update-tax-rate
14608       parameters:
14609       - name: id
14610         in: path
14611         required: true
14612         schema:
14613           type: string
14614       - name: include
14615         in: query
14616         description: 'Select which associated resources you would like to fetch, see:
14617           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14618         example: zone,tax_category
14619         schema:
14620           type: string
14621       responses:
14622         '200':
14623           description: Record updated
14624           content:
14625             application/vnd.api+json:
14626               examples:
14627                 Example:
14628                   value:
14629                     data:
14630                       id: '19'
14631                       type: tax_rate
14632                       attributes:
14633                         amount: '25.9'
14634                         included_in_price: true
14635                         created_at: '2022-11-08T19:35:45.406Z'
14636                         updated_at: '2022-11-08T19:35:45.637Z'
14637                         name: TaxRate - 33807
14638                         show_rate_in_label: true
14639                         deleted_at:
14640                         public_metadata: {}
14641                         private_metadata: {}
14642                       relationships:
14643                         zone:
14644                           data:
14645                             id: '106'
14646                             type: zone
14647                         tax_category:
14648                           data:
14649                             id: '170'
14650                             type: tax_category
14651               schema:
14652                 "$ref": "#/components/schemas/resource"
14653         '422':
14654           description: Invalid request
14655           content:
14656             application/vnd.api+json:
14657               examples:
14658                 Example:
14659                   value:
14660                     error: Rate can't be blank
14661                     errors:
14662                       amount:
14663                       - can't be blank
14664               schema:
14665                 "$ref": "#/components/schemas/validation_errors"
14666         '404':
14667           description: Record not found
14668           content:
14669             application/vnd.api+json:
14670               examples:
14671                 Example:
14672                   value:
14673                     error: The resource you were looking for could not be found.
14674               schema:
14675                 "$ref": "#/components/schemas/error"
14676         '401':
14677           description: Authentication Failed
14678           content:
14679             application/vnd.api+json:
14680               examples:
14681                 Example:
14682                   value:
14683                     error: The access token is invalid
14684               schema:
14685                 "$ref": "#/components/schemas/error"
14686       requestBody:
14687         content:
14688           application/json:
14689             schema:
14690               "$ref": "#/components/schemas/update_tax_rate_params"
14691     delete:
14692       summary: Delete a Tax Rate
14693       tags:
14694       - Tax Rates
14695       security:
14696       - bearer_auth: []
14697       description: Deletes a Tax Rate
14698       operationId: delete-tax-rate
14699       parameters:
14700       - name: id
14701         in: path
14702         required: true
14703         schema:
14704           type: string
14705       responses:
14706         '204':
14707           description: Record deleted
14708         '404':
14709           description: Record not found
14710           content:
14711             application/vnd.api+json:
14712               examples:
14713                 Example:
14714                   value:
14715                     error: The resource you were looking for could not be found.
14716               schema:
14717                 "$ref": "#/components/schemas/error"
14718         '401':
14719           description: Authentication Failed
14720           content:
14721             application/vnd.api+json:
14722               examples:
14723                 Example:
14724                   value:
14725                     error: The access token is invalid
14726               schema:
14727                 "$ref": "#/components/schemas/error"
14728   "/api/v2/platform/taxonomies":
14729     get:
14730       summary: Return a list of Taxonomies
14731       tags:
14732       - Taxonomies
14733       security:
14734       - bearer_auth: []
14735       description: Returns a list of Taxonomies
14736       operationId: taxonomies-list
14737       parameters:
14738       - name: page
14739         in: query
14740         example: 1
14741         schema:
14742           type: integer
14743       - name: per_page
14744         in: query
14745         example: 50
14746         schema:
14747           type: integer
14748       - name: include
14749         in: query
14750         description: 'Select which associated resources you would like to fetch, see:
14751           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14752         example: taxons,root
14753         schema:
14754           type: string
14755       - name: filter[name_eq]
14756         in: query
14757         description: ''
14758         example: Categories
14759         schema:
14760           type: string
14761       responses:
14762         '200':
14763           description: Records returned
14764           content:
14765             application/vnd.api+json:
14766               examples:
14767                 Example:
14768                   value:
14769                     data:
14770                     - id: '13'
14771                       type: taxonomy
14772                       attributes:
14773                         name: taxonomy_13
14774                         created_at: '2022-11-08T19:35:46.789Z'
14775                         updated_at: '2022-11-08T19:35:46.801Z'
14776                         position: 1
14777                         public_metadata: {}
14778                         private_metadata: {}
14779                       relationships:
14780                         taxons:
14781                           data:
14782                           - id: '25'
14783                             type: taxon
14784                         root:
14785                           data:
14786                             id: '25'
14787                             type: taxon
14788                     - id: '14'
14789                       type: taxonomy
14790                       attributes:
14791                         name: taxonomy_14
14792                         created_at: '2022-11-08T19:35:46.804Z'
14793                         updated_at: '2022-11-08T19:35:46.814Z'
14794                         position: 2
14795                         public_metadata: {}
14796                         private_metadata: {}
14797                       relationships:
14798                         taxons:
14799                           data:
14800                           - id: '26'
14801                             type: taxon
14802                         root:
14803                           data:
14804                             id: '26'
14805                             type: taxon
14806                     meta:
14807                       count: 2
14808                       total_count: 2
14809                       total_pages: 1
14810                     links:
14811                       self: http://www.example.com/api/v2/platform/taxonomies?page=1&per_page=&include=&filter[name_eq]=
14812                       next: http://www.example.com/api/v2/platform/taxonomies?filter%5Bname_eq%5D=&include=&page=1&per_page=
14813                       prev: http://www.example.com/api/v2/platform/taxonomies?filter%5Bname_eq%5D=&include=&page=1&per_page=
14814                       last: http://www.example.com/api/v2/platform/taxonomies?filter%5Bname_eq%5D=&include=&page=1&per_page=
14815                       first: http://www.example.com/api/v2/platform/taxonomies?filter%5Bname_eq%5D=&include=&page=1&per_page=
14816               schema:
14817                 "$ref": "#/components/schemas/resources_list"
14818         '401':
14819           description: Authentication Failed
14820           content:
14821             application/vnd.api+json:
14822               examples:
14823                 Example:
14824                   value:
14825                     error: The access token is invalid
14826               schema:
14827                 "$ref": "#/components/schemas/error"
14828     post:
14829       summary: Create a Taxonomy
14830       tags:
14831       - Taxonomies
14832       security:
14833       - bearer_auth: []
14834       description: Creates a Taxonomy
14835       operationId: create-taxonomy
14836       parameters:
14837       - name: include
14838         in: query
14839         description: 'Select which associated resources you would like to fetch, see:
14840           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14841         example: taxons,root
14842         schema:
14843           type: string
14844       responses:
14845         '201':
14846           description: Record created
14847           content:
14848             application/vnd.api+json:
14849               examples:
14850                 Example:
14851                   value:
14852                     data:
14853                       id: '17'
14854                       type: taxonomy
14855                       attributes:
14856                         name: taxonomy_17
14857                         created_at: '2022-11-08T19:35:47.351Z'
14858                         updated_at: '2022-11-08T19:35:47.361Z'
14859                         position: 1
14860                         public_metadata: {}
14861                         private_metadata: {}
14862                       relationships:
14863                         taxons:
14864                           data:
14865                           - id: '29'
14866                             type: taxon
14867                         root:
14868                           data:
14869                             id: '29'
14870                             type: taxon
14871               schema:
14872                 "$ref": "#/components/schemas/resource"
14873         '422':
14874           description: Invalid request
14875           content:
14876             application/vnd.api+json:
14877               examples:
14878                 Example:
14879                   value:
14880                     error: Name can't be blank
14881                     errors:
14882                       name:
14883                       - can't be blank
14884               schema:
14885                 "$ref": "#/components/schemas/validation_errors"
14886       requestBody:
14887         content:
14888           application/json:
14889             schema:
14890               "$ref": "#/components/schemas/create_taxonomy_params"
14891   "/api/v2/platform/taxonomies/{id}":
14892     get:
14893       summary: Return a Taxonomy
14894       tags:
14895       - Taxonomies
14896       security:
14897       - bearer_auth: []
14898       description: Returns a Taxonomy
14899       operationId: show-taxonomy
14900       parameters:
14901       - name: id
14902         in: path
14903         required: true
14904         schema:
14905           type: string
14906       - name: include
14907         in: query
14908         description: 'Select which associated resources you would like to fetch, see:
14909           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14910         example: taxons,root
14911         schema:
14912           type: string
14913       responses:
14914         '200':
14915           description: Record found
14916           content:
14917             application/vnd.api+json:
14918               examples:
14919                 Example:
14920                   value:
14921                     data:
14922                       id: '18'
14923                       type: taxonomy
14924                       attributes:
14925                         name: taxonomy_18
14926                         created_at: '2022-11-08T19:35:47.637Z'
14927                         updated_at: '2022-11-08T19:35:47.648Z'
14928                         position: 1
14929                         public_metadata: {}
14930                         private_metadata: {}
14931                       relationships:
14932                         taxons:
14933                           data:
14934                           - id: '30'
14935                             type: taxon
14936                         root:
14937                           data:
14938                             id: '30'
14939                             type: taxon
14940               schema:
14941                 "$ref": "#/components/schemas/resource"
14942         '404':
14943           description: Record not found
14944           content:
14945             application/vnd.api+json:
14946               examples:
14947                 Example:
14948                   value:
14949                     error: The resource you were looking for could not be found.
14950               schema:
14951                 "$ref": "#/components/schemas/error"
14952         '401':
14953           description: Authentication Failed
14954           content:
14955             application/vnd.api+json:
14956               examples:
14957                 Example:
14958                   value:
14959                     error: The access token is invalid
14960               schema:
14961                 "$ref": "#/components/schemas/error"
14962     patch:
14963       summary: Update a Taxonomy
14964       tags:
14965       - Taxonomies
14966       security:
14967       - bearer_auth: []
14968       description: Updates a Taxonomy
14969       operationId: update-taxonomy
14970       parameters:
14971       - name: id
14972         in: path
14973         required: true
14974         schema:
14975           type: string
14976       - name: include
14977         in: query
14978         description: 'Select which associated resources you would like to fetch, see:
14979           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
14980         example: taxons,root
14981         schema:
14982           type: string
14983       responses:
14984         '200':
14985           description: Record updated
14986           content:
14987             application/vnd.api+json:
14988               examples:
14989                 Example:
14990                   value:
14991                     data:
14992                       id: '20'
14993                       type: taxonomy
14994                       attributes:
14995                         name: Categories
14996                         created_at: '2022-11-08T19:35:48.183Z'
14997                         updated_at: '2022-11-08T19:35:48.430Z'
14998                         position: 1
14999                         public_metadata:
15000                           balanced: true
15001                         private_metadata: {}
15002                       relationships:
15003                         taxons:
15004                           data:
15005                           - id: '32'
15006                             type: taxon
15007                         root:
15008                           data:
15009                             id: '32'
15010                             type: taxon
15011               schema:
15012                 "$ref": "#/components/schemas/resource"
15013         '422':
15014           description: Invalid request
15015           content:
15016             application/vnd.api+json:
15017               examples:
15018                 Example:
15019                   value:
15020                     error: Name can't be blank
15021                     errors:
15022                       name:
15023                       - can't be blank
15024               schema:
15025                 "$ref": "#/components/schemas/validation_errors"
15026         '404':
15027           description: Record not found
15028           content:
15029             application/vnd.api+json:
15030               examples:
15031                 Example:
15032                   value:
15033                     error: The resource you were looking for could not be found.
15034               schema:
15035                 "$ref": "#/components/schemas/error"
15036         '401':
15037           description: Authentication Failed
15038           content:
15039             application/vnd.api+json:
15040               examples:
15041                 Example:
15042                   value:
15043                     error: The access token is invalid
15044               schema:
15045                 "$ref": "#/components/schemas/error"
15046       requestBody:
15047         content:
15048           application/json:
15049             schema:
15050               "$ref": "#/components/schemas/update_taxonomy_params"
15051     delete:
15052       summary: Delete a Taxonomy
15053       tags:
15054       - Taxonomies
15055       security:
15056       - bearer_auth: []
15057       description: Deletes a Taxonomy
15058       operationId: delete-taxonomy
15059       parameters:
15060       - name: id
15061         in: path
15062         required: true
15063         schema:
15064           type: string
15065       responses:
15066         '204':
15067           description: Record deleted
15068         '404':
15069           description: Record not found
15070           content:
15071             application/vnd.api+json:
15072               examples:
15073                 Example:
15074                   value:
15075                     error: The resource you were looking for could not be found.
15076               schema:
15077                 "$ref": "#/components/schemas/error"
15078         '401':
15079           description: Authentication Failed
15080           content:
15081             application/vnd.api+json:
15082               examples:
15083                 Example:
15084                   value:
15085                     error: The access token is invalid
15086               schema:
15087                 "$ref": "#/components/schemas/error"
15088   "/api/v2/platform/taxons":
15089     get:
15090       summary: Return a list of Taxons
15091       tags:
15092       - Taxons
15093       security:
15094       - bearer_auth: []
15095       description: Returns a list of Taxons
15096       operationId: taxons-list
15097       parameters:
15098       - name: page
15099         in: query
15100         example: 1
15101         schema:
15102           type: integer
15103       - name: per_page
15104         in: query
15105         example: 50
15106         schema:
15107           type: integer
15108       - name: include
15109         in: query
15110         description: 'Select which associated resources you would like to fetch, see:
15111           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
15112         example: taxonomy,parent,children
15113         schema:
15114           type: string
15115       - name: filter[taxonomy_id_eq]
15116         in: query
15117         description: ''
15118         example: '1'
15119         schema:
15120           type: string
15121       - name: filter[name_cont]
15122         in: query
15123         description: ''
15124         example: Shirts
15125         schema:
15126           type: string
15127       responses:
15128         '200':
15129           description: Records returned
15130           content:
15131             application/vnd.api+json:
15132               examples:
15133                 Example:
15134                   value:
15135                     data:
15136                     - id: '38'
15137                       type: taxon
15138                       attributes:
15139                         position: 0
15140                         name: Shorts
15141                         permalink: taxonomy-25/shorts
15142                         lft: 2
15143                         rgt: 3
15144                         description:
15145                         created_at: '2022-11-08T19:35:49.576Z'
15146                         updated_at: '2022-11-08T19:35:49.581Z'
15147                         meta_title:
15148                         meta_description:
15149                         meta_keywords:
15150                         depth: 1
15151                         public_metadata: {}
15152                         private_metadata: {}
15153                         pretty_name: taxonomy_25 -> Shorts
15154                         seo_title: Shorts
15155                         is_root: false
15156                         is_child: true
15157                         is_leaf: true
15158                       relationships:
15159                         parent:
15160                           data:
15161                             id: '37'
15162                             type: taxon
15163                         taxonomy:
15164                           data:
15165                             id: '25'
15166                             type: taxonomy
15167                         children:
15168                           data: []
15169                         image:
15170                           data:
15171                             id: '89'
15172                             type: taxon_image
15173                     - id: '39'
15174                       type: taxon
15175                       attributes:
15176                         position: 0
15177                         name: taxon_13
15178                         permalink: taxonomy-25/taxon-13
15179                         lft: 4
15180                         rgt: 5
15181                         description:
15182                         created_at: '2022-11-08T19:35:49.603Z'
15183                         updated_at: '2022-11-08T19:35:49.606Z'
15184                         meta_title:
15185                         meta_description:
15186                         meta_keywords:
15187                         depth: 1
15188                         public_metadata: {}
15189                         private_metadata: {}
15190                         pretty_name: taxonomy_25 -> taxon_13
15191                         seo_title: taxon_13
15192                         is_root: false
15193                         is_child: true
15194                         is_leaf: true
15195                       relationships:
15196                         parent:
15197                           data:
15198                             id: '37'
15199                             type: taxon
15200                         taxonomy:
15201                           data:
15202                             id: '25'
15203                             type: taxonomy
15204                         children:
15205                           data: []
15206                         image:
15207                           data:
15208                             id: '90'
15209                             type: taxon_image
15210                     - id: '40'
15211                       type: taxon
15212                       attributes:
15213                         position: 0
15214                         name: taxon_14
15215                         permalink: taxonomy-25/taxon-14
15216                         lft: 6
15217                         rgt: 7
15218                         description:
15219                         created_at: '2022-11-08T19:35:49.625Z'
15220                         updated_at: '2022-11-08T19:35:49.628Z'
15221                         meta_title:
15222                         meta_description:
15223                         meta_keywords:
15224                         depth: 1
15225                         public_metadata: {}
15226                         private_metadata: {}
15227                         pretty_name: taxonomy_25 -> taxon_14
15228                         seo_title: taxon_14
15229                         is_root: false
15230                         is_child: true
15231                         is_leaf: true
15232                       relationships:
15233                         parent:
15234                           data:
15235                             id: '37'
15236                             type: taxon
15237                         taxonomy:
15238                           data:
15239                             id: '25'
15240                             type: taxonomy
15241                         children:
15242                           data: []
15243                         image:
15244                           data:
15245                             id: '91'
15246                             type: taxon_image
15247                     - id: '37'
15248                       type: taxon
15249                       attributes:
15250                         position: 0
15251                         name: taxonomy_25
15252                         permalink: taxonomy-25
15253                         lft: 1
15254                         rgt: 8
15255                         description:
15256                         created_at: '2022-11-08T19:35:49.552Z'
15257                         updated_at: '2022-11-08T19:35:49.636Z'
15258                         meta_title:
15259                         meta_description:
15260                         meta_keywords:
15261                         depth: 0
15262                         public_metadata: {}
15263                         private_metadata: {}
15264                         pretty_name: taxonomy_25
15265                         seo_title: taxonomy_25
15266                         is_root: true
15267                         is_child: false
15268                         is_leaf: false
15269                       relationships:
15270                         parent:
15271                           data:
15272                         taxonomy:
15273                           data:
15274                             id: '25'
15275                             type: taxonomy
15276                         children:
15277                           data:
15278                           - id: '38'
15279                             type: taxon
15280                           - id: '39'
15281                             type: taxon
15282                           - id: '40'
15283                             type: taxon
15284                         image:
15285                           data:
15286                     meta:
15287                       count: 4
15288                       total_count: 4
15289                       total_pages: 1
15290                     links:
15291                       self: http://www.example.com/api/v2/platform/taxons?page=1&per_page=&include=&filter[taxonomy_id_eq]=&filter[name_cont]=
15292                       next: http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=
15293                       prev: http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=
15294                       last: http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=
15295                       first: http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=
15296               schema:
15297                 "$ref": "#/components/schemas/resources_list"
15298         '401':
15299           description: Authentication Failed
15300           content:
15301             application/vnd.api+json:
15302               examples:
15303                 Example:
15304                   value:
15305                     error: The access token is invalid
15306               schema:
15307                 "$ref": "#/components/schemas/error"
15308     post:
15309       summary: Create a Taxon
15310       tags:
15311       - Taxons
15312       security:
15313       - bearer_auth: []
15314       description: Creates a Taxon
15315       operationId: create-taxon
15316       parameters:
15317       - name: include
15318         in: query
15319         description: 'Select which associated resources you would like to fetch, see:
15320           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
15321         example: taxonomy,parent,children
15322         schema:
15323           type: string
15324       responses:
15325         '201':
15326           description: Record created
15327           content:
15328             application/vnd.api+json:
15329               examples:
15330                 Example:
15331                   value:
15332                     data:
15333                       id: '47'
15334                       type: taxon
15335                       attributes:
15336                         position: 0
15337                         name: taxon_17
15338                         permalink: taxonomy-27/taxon-17
15339                         lft: 4
15340                         rgt: 5
15341                         description:
15342                         created_at: '2022-11-08T19:35:50.279Z'
15343                         updated_at: '2022-11-08T19:35:50.283Z'
15344                         meta_title:
15345                         meta_description:
15346                         meta_keywords:
15347                         depth: 1
15348                         public_metadata: {}
15349                         private_metadata: {}
15350                         pretty_name: taxonomy_27 -> taxon_17
15351                         seo_title: taxon_17
15352                         is_root: false
15353                         is_child: true
15354                         is_leaf: true
15355                       relationships:
15356                         parent:
15357                           data:
15358                             id: '45'
15359                             type: taxon
15360                         taxonomy:
15361                           data:
15362                             id: '27'
15363                             type: taxonomy
15364                         children:
15365                           data: []
15366                         image:
15367                           data:
15368               schema:
15369                 "$ref": "#/components/schemas/resource"
15370         '422':
15371           description: Invalid request
15372           content:
15373             application/vnd.api+json:
15374               examples:
15375                 Example:
15376                   value:
15377                     error: Name can't be blank and Taxonomy can't be blank
15378                     errors:
15379                       name:
15380                       - can't be blank
15381                       taxonomy:
15382                       - can't be blank
15383               schema:
15384                 "$ref": "#/components/schemas/validation_errors"
15385       requestBody:
15386         content:
15387           application/json:
15388             schema:
15389               "$ref": "#/components/schemas/create_taxon_params"
15390   "/api/v2/platform/taxons/{id}":
15391     get:
15392       summary: Return a Taxon
15393       tags:
15394       - Taxons
15395       security:
15396       - bearer_auth: []
15397       description: Returns a Taxon
15398       operationId: show-taxon
15399       parameters:
15400       - name: id
15401         in: path
15402         required: true
15403         schema:
15404           type: string
15405       - name: include
15406         in: query
15407         description: 'Select which associated resources you would like to fetch, see:
15408           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
15409         example: taxonomy,parent,children
15410         schema:
15411           type: string
15412       responses:
15413         '200':
15414           description: Record found
15415           content:
15416             application/vnd.api+json:
15417               examples:
15418                 Example:
15419                   value:
15420                     data:
15421                       id: '52'
15422                       type: taxon
15423                       attributes:
15424                         position: 0
15425                         name: taxon_18
15426                         permalink: taxonomy-29/taxon-18
15427                         lft: 4
15428                         rgt: 5
15429                         description:
15430                         created_at: '2022-11-08T19:35:50.654Z'
15431                         updated_at: '2022-11-08T19:35:50.657Z'
15432                         meta_title:
15433                         meta_description:
15434                         meta_keywords:
15435                         depth: 1
15436                         public_metadata: {}
15437                         private_metadata: {}
15438                         pretty_name: taxonomy_29 -> taxon_18
15439                         seo_title: taxon_18
15440                         is_root: false
15441                         is_child: true
15442                         is_leaf: true
15443                       relationships:
15444                         parent:
15445                           data:
15446                             id: '50'
15447                             type: taxon
15448                         taxonomy:
15449                           data:
15450                             id: '29'
15451                             type: taxonomy
15452                         children:
15453                           data: []
15454                         products:
15455                           data: []
15456                         image:
15457                           data:
15458                             id: '98'
15459                             type: taxon_image
15460               schema:
15461                 "$ref": "#/components/schemas/resource"
15462         '404':
15463           description: Record not found
15464           content:
15465             application/vnd.api+json:
15466               examples:
15467                 Example:
15468                   value:
15469                     error: The resource you were looking for could not be found.
15470               schema:
15471                 "$ref": "#/components/schemas/error"
15472         '401':
15473           description: Authentication Failed
15474           content:
15475             application/vnd.api+json:
15476               examples:
15477                 Example:
15478                   value:
15479                     error: The access token is invalid
15480               schema:
15481                 "$ref": "#/components/schemas/error"
15482     patch:
15483       summary: Update a Taxon
15484       tags:
15485       - Taxons
15486       security:
15487       - bearer_auth: []
15488       description: Updates a Taxon
15489       operationId: update-taxon
15490       parameters:
15491       - name: id
15492         in: path
15493         required: true
15494         schema:
15495           type: string
15496       - name: include
15497         in: query
15498         description: 'Select which associated resources you would like to fetch, see:
15499           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
15500         example: taxonomy,parent,children
15501         schema:
15502           type: string
15503       responses:
15504         '200':
15505           description: Record updated
15506           content:
15507             application/vnd.api+json:
15508               examples:
15509                 Example:
15510                   value:
15511                     data:
15512                       id: '60'
15513                       type: taxon
15514                       attributes:
15515                         position: 0
15516                         name: T-Shirts
15517                         permalink: taxonomy-32/taxon-20
15518                         lft: 4
15519                         rgt: 5
15520                         description:
15521                         created_at: '2022-11-08T19:35:51.420Z'
15522                         updated_at: '2022-11-08T19:35:51.665Z'
15523                         meta_title:
15524                         meta_description:
15525                         meta_keywords:
15526                         depth: 1
15527                         public_metadata:
15528                           profitability: 3
15529                         private_metadata: {}
15530                         pretty_name: taxonomy_32 -> T-Shirts
15531                         seo_title: T-Shirts
15532                         is_root: false
15533                         is_child: true
15534                         is_leaf: true
15535                       relationships:
15536                         parent:
15537                           data:
15538                             id: '58'
15539                             type: taxon
15540                         taxonomy:
15541                           data:
15542                             id: '32'
15543                             type: taxonomy
15544                         children:
15545                           data: []
15546                         image:
15547                           data:
15548                             id: '103'
15549                             type: taxon_image
15550               schema:
15551                 "$ref": "#/components/schemas/resource"
15552         '422':
15553           description: Invalid request
15554           content:
15555             application/vnd.api+json:
15556               examples:
15557                 Example:
15558                   value:
15559                     error: Name can't be blank
15560                     errors:
15561                       name:
15562                       - can't be blank
15563               schema:
15564                 "$ref": "#/components/schemas/validation_errors"
15565         '404':
15566           description: Record not found
15567           content:
15568             application/vnd.api+json:
15569               examples:
15570                 Example:
15571                   value:
15572                     error: The resource you were looking for could not be found.
15573               schema:
15574                 "$ref": "#/components/schemas/error"
15575         '401':
15576           description: Authentication Failed
15577           content:
15578             application/vnd.api+json:
15579               examples:
15580                 Example:
15581                   value:
15582                     error: The access token is invalid
15583               schema:
15584                 "$ref": "#/components/schemas/error"
15585       requestBody:
15586         content:
15587           application/json:
15588             schema:
15589               "$ref": "#/components/schemas/update_taxon_params"
15590     delete:
15591       summary: Delete a Taxon
15592       tags:
15593       - Taxons
15594       security:
15595       - bearer_auth: []
15596       description: Deletes a Taxon
15597       operationId: delete-taxon
15598       parameters:
15599       - name: id
15600         in: path
15601         required: true
15602         schema:
15603           type: string
15604       responses:
15605         '204':
15606           description: Record deleted
15607         '404':
15608           description: Record not found
15609           content:
15610             application/vnd.api+json:
15611               examples:
15612                 Example:
15613                   value:
15614                     error: The resource you were looking for could not be found.
15615               schema:
15616                 "$ref": "#/components/schemas/error"
15617         '401':
15618           description: Authentication Failed
15619           content:
15620             application/vnd.api+json:
15621               examples:
15622                 Example:
15623                   value:
15624                     error: The access token is invalid
15625               schema:
15626                 "$ref": "#/components/schemas/error"
15627   "/api/v2/platform/taxons/{id}/reposition":
15628     patch:
15629       summary: Reposition a Taxon
15630       tags:
15631       - Taxons
15632       security:
15633       - bearer_auth: []
15634       operationId: reposition-taxon
15635       description: Reposition a Taxon
15636       parameters:
15637       - name: id
15638         in: path
15639         required: true
15640         schema:
15641           type: string
15642       responses:
15643         '200':
15644           description: Record updated
15645           content:
15646             application/vnd.api+json:
15647               examples:
15648                 Example:
15649                   value:
15650                     data:
15651                       id: '79'
15652                       type: taxon
15653                       attributes:
15654                         position: 0
15655                         name: taxon_25
15656                         permalink: taxonomy-39/shorts/taxon-25
15657                         lft: 3
15658                         rgt: 4
15659                         description:
15660                         created_at: '2022-11-08T19:35:53.074Z'
15661                         updated_at: '2022-11-08T19:35:53.324Z'
15662                         meta_title:
15663                         meta_description:
15664                         meta_keywords:
15665                         depth: 2
15666                         public_metadata: {}
15667                         private_metadata: {}
15668                         pretty_name: taxonomy_39 -> Shorts -> taxon_25
15669                         seo_title: taxon_25
15670                         is_root: false
15671                         is_child: true
15672                         is_leaf: true
15673                       relationships:
15674                         parent:
15675                           data:
15676                             id: '78'
15677                             type: taxon
15678                         taxonomy:
15679                           data:
15680                             id: '39'
15681                             type: taxonomy
15682                         children:
15683                           data: []
15684                         image:
15685                           data:
15686                             id: '115'
15687                             type: taxon_image
15688               schema:
15689                 "$ref": "#/components/schemas/resource"
15690         '404':
15691           description: Record not found
15692           content:
15693             application/vnd.api+json:
15694               examples:
15695                 Example:
15696                   value:
15697                     error: The resource you were looking for could not be found.
15698               schema:
15699                 "$ref": "#/components/schemas/error"
15700         '401':
15701           description: Authentication Failed
15702           content:
15703             application/vnd.api+json:
15704               examples:
15705                 Example:
15706                   value:
15707                     error: The access token is invalid
15708               schema:
15709                 "$ref": "#/components/schemas/error"
15710       requestBody:
15711         content:
15712           application/json:
15713             schema:
15714               "$ref": "#/components/schemas/taxon_reposition"
15715   "/api/v2/platform/users":
15716     get:
15717       summary: Return a list of Users
15718       tags:
15719       - Users
15720       security:
15721       - bearer_auth: []
15722       description: Returns a list of Users
15723       operationId: users-list
15724       parameters:
15725       - name: page
15726         in: query
15727         example: 1
15728         schema:
15729           type: integer
15730       - name: per_page
15731         in: query
15732         example: 50
15733         schema:
15734           type: integer
15735       - name: include
15736         in: query
15737         description: 'Select which associated resources you would like to fetch, see:
15738           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
15739         example: ship_address,bill_address
15740         schema:
15741           type: string
15742       - name: filter[user_id_eq]
15743         in: query
15744         description: ''
15745         example: '1'
15746         schema:
15747           type: string
15748       - name: filter[email_cont]
15749         in: query
15750         description: ''
15751         example: spree@example.com
15752         schema:
15753           type: string
15754       responses:
15755         '200':
15756           description: Records returned
15757           content:
15758             application/vnd.api+json:
15759               examples:
15760                 Example:
15761                   value:
15762                     data:
15763                     - id: '129'
15764                       type: user
15765                       attributes:
15766                         email: ivonne.braun@smith.biz
15767                         first_name: Liberty
15768                         last_name: Becker
15769                         selected_locale: nil
15770                         created_at: '2022-11-08T19:35:53.726Z'
15771                         updated_at: '2022-11-08T19:35:53.726Z'
15772                         public_metadata: {}
15773                         private_metadata: {}
15774                         average_order_value: []
15775                         lifetime_value: []
15776                         store_credits: []
15777                       relationships:
15778                         bill_address:
15779                           data:
15780                         ship_address:
15781                           data:
15782                     - id: '130'
15783                       type: user
15784                       attributes:
15785                         email: lenita.mayer@kulas.us
15786                         first_name: Chasidy
15787                         last_name: Strosin
15788                         selected_locale: 'fr'
15789                         created_at: '2022-11-08T19:35:53.730Z'
15790                         updated_at: '2022-11-08T19:35:53.730Z'
15791                         public_metadata: {}
15792                         private_metadata: {}
15793                         average_order_value: []
15794                         lifetime_value: []
15795                         store_credits: []
15796                       relationships:
15797                         bill_address:
15798                           data:
15799                         ship_address:
15800                           data:
15801                     - id: '131'
15802                       type: user
15803                       attributes:
15804                         email: dewayne@terrybarton.info
15805                         first_name: Ruben
15806                         last_name: Schmidt
15807                         selected_locale: 'de'
15808                         created_at: '2022-11-08T19:35:53.732Z'
15809                         updated_at: '2022-11-08T19:35:53.732Z'
15810                         public_metadata: {}
15811                         private_metadata: {}
15812                         average_order_value: []
15813                         lifetime_value: []
15814                         store_credits: []
15815                       relationships:
15816                         bill_address:
15817                           data:
15818                         ship_address:
15819                           data:
15820                     meta:
15821                       count: 3
15822                       total_count: 3
15823                       total_pages: 1
15824                     links:
15825                       self: http://www.example.com/api/v2/platform/users?page=1&per_page=&include=&filter[user_id_eq]=&filter[email_cont]=
15826                       next: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
15827                       prev: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
15828                       last: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
15829                       first: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
15830               schema:
15831                 "$ref": "#/components/schemas/resources_list"
15832         '401':
15833           description: Authentication Failed
15834           content:
15835             application/vnd.api+json:
15836               examples:
15837                 Example:
15838                   value:
15839                     error: The access token is invalid
15840               schema:
15841                 "$ref": "#/components/schemas/error"
15842     post:
15843       summary: Create a User
15844       tags:
15845       - Users
15846       security:
15847       - bearer_auth: []
15848       description: Creates a User
15849       operationId: create-user
15850       parameters:
15851       - name: include
15852         in: query
15853         description: 'Select which associated resources you would like to fetch, see:
15854           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
15855         example: ship_address,bill_address
15856         schema:
15857           type: string
15858       responses:
15859         '201':
15860           description: Record created
15861           content:
15862             application/vnd.api+json:
15863               examples:
15864                 Example:
15865                   value:
15866                     data:
15867                       id: '136'
15868                       type: user
15869                       attributes:
15870                         email: rex_champlin@breitenberg.com
15871                         first_name: Zenia
15872                         last_name: King
15873                         selected_locale: 'pl'
15874                         created_at: '2022-11-08T19:35:54.351Z'
15875                         updated_at: '2022-11-08T19:35:54.351Z'
15876                         public_metadata: {}
15877                         private_metadata: {}
15878                         average_order_value: []
15879                         lifetime_value: []
15880                         store_credits: []
15881                       relationships:
15882                         bill_address:
15883                           data:
15884                         ship_address:
15885                           data:
15886               schema:
15887                 "$ref": "#/components/schemas/resource"
15888         '422':
15889           description: Invalid request
15890           content:
15891             application/vnd.api+json:
15892               examples:
15893                 Example:
15894                   value:
15895                     error: Bill address belongs to other user
15896                     errors:
15897                       bill_address_id:
15898                       - belongs to other user
15899               schema:
15900                 "$ref": "#/components/schemas/validation_errors"
15901       requestBody:
15902         content:
15903           application/json:
15904             schema:
15905               "$ref": "#/components/schemas/create_user_params"
15906   "/api/v2/platform/users/{id}":
15907     get:
15908       summary: Return a User
15909       tags:
15910       - Users
15911       security:
15912       - bearer_auth: []
15913       description: Returns a User
15914       operationId: show-user
15915       parameters:
15916       - name: id
15917         in: path
15918         required: true
15919         schema:
15920           type: string
15921       - name: include
15922         in: query
15923         description: 'Select which associated resources you would like to fetch, see:
15924           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
15925         example: ship_address,bill_address
15926         schema:
15927           type: string
15928       responses:
15929         '200':
15930           description: Record found
15931           content:
15932             application/vnd.api+json:
15933               examples:
15934                 Example:
15935                   value:
15936                     data:
15937                       id: '139'
15938                       type: user
15939                       attributes:
15940                         email: gaynell@parisian.biz
15941                         first_name: Irwin
15942                         last_name: DuBuque
15943                         selected_locale: 'en'
15944                         created_at: '2022-11-08T19:35:54.635Z'
15945                         updated_at: '2022-11-08T19:35:54.635Z'
15946                         public_metadata: {}
15947                         private_metadata: {}
15948                         average_order_value: []
15949                         lifetime_value: []
15950                         store_credits: []
15951                       relationships:
15952                         bill_address:
15953                           data:
15954                         ship_address:
15955                           data:
15956               schema:
15957                 "$ref": "#/components/schemas/resource"
15958         '404':
15959           description: Record not found
15960           content:
15961             application/vnd.api+json:
15962               examples:
15963                 Example:
15964                   value:
15965                     error: The resource you were looking for could not be found.
15966               schema:
15967                 "$ref": "#/components/schemas/error"
15968         '401':
15969           description: Authentication Failed
15970           content:
15971             application/vnd.api+json:
15972               examples:
15973                 Example:
15974                   value:
15975                     error: The access token is invalid
15976               schema:
15977                 "$ref": "#/components/schemas/error"
15978     patch:
15979       summary: Update a User
15980       tags:
15981       - Users
15982       security:
15983       - bearer_auth: []
15984       description: Updates a User
15985       operationId: update-user
15986       parameters:
15987       - name: id
15988         in: path
15989         required: true
15990         schema:
15991           type: string
15992       - name: include
15993         in: query
15994         description: 'Select which associated resources you would like to fetch, see:
15995           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
15996         example: ship_address,bill_address
15997         schema:
15998           type: string
15999       responses:
16000         '200':
16001           description: Record updated
16002           content:
16003             application/vnd.api+json:
16004               examples:
16005                 Example:
16006                   value:
16007                     data:
16008                       id: '144'
16009                       type: user
16010                       attributes:
16011                         email: john@example.com
16012                         first_name: Astrid
16013                         last_name: Kohler
16014                         selected_locale: 'fr'
16015                         created_at: '2022-11-08T19:35:55.180Z'
16016                         updated_at: '2022-11-08T19:35:55.414Z'
16017                         public_metadata: {}
16018                         private_metadata: {}
16019                         average_order_value: []
16020                         lifetime_value: []
16021                         store_credits: []
16022                       relationships:
16023                         bill_address:
16024                           data:
16025                         ship_address:
16026                           data:
16027               schema:
16028                 "$ref": "#/components/schemas/resource"
16029         '422':
16030           description: Invalid request
16031           content:
16032             application/vnd.api+json:
16033               examples:
16034                 Example:
16035                   value:
16036                     error: Bill address belongs to other user
16037                     errors:
16038                       bill_address_id:
16039                       - belongs to other user
16040               schema:
16041                 "$ref": "#/components/schemas/validation_errors"
16042         '404':
16043           description: Record not found
16044           content:
16045             application/vnd.api+json:
16046               examples:
16047                 Example:
16048                   value:
16049                     error: The resource you were looking for could not be found.
16050               schema:
16051                 "$ref": "#/components/schemas/error"
16052         '401':
16053           description: Authentication Failed
16054           content:
16055             application/vnd.api+json:
16056               examples:
16057                 Example:
16058                   value:
16059                     error: The access token is invalid
16060               schema:
16061                 "$ref": "#/components/schemas/error"
16062       requestBody:
16063         content:
16064           application/json:
16065             schema:
16066               "$ref": "#/components/schemas/update_user_params"
16067     delete:
16068       summary: Delete a User
16069       tags:
16070       - Users
16071       security:
16072       - bearer_auth: []
16073       description: Deletes a User
16074       operationId: delete-user
16075       parameters:
16076       - name: id
16077         in: path
16078         required: true
16079         schema:
16080           type: string
16081       responses:
16082         '204':
16083           description: Record deleted
16084         '404':
16085           description: Record not found
16086           content:
16087             application/vnd.api+json:
16088               examples:
16089                 Example:
16090                   value:
16091                     error: The resource you were looking for could not be found.
16092               schema:
16093                 "$ref": "#/components/schemas/error"
16094         '401':
16095           description: Authentication Failed
16096           content:
16097             application/vnd.api+json:
16098               examples:
16099                 Example:
16100                   value:
16101                     error: The access token is invalid
16102               schema:
16103                 "$ref": "#/components/schemas/error"
16104   "/api/v2/platform/variants":
16105     get:
16106       summary: Return a list of Variants
16107       tags:
16108       - Variants
16109       security:
16110       - bearer_auth: []
16111       description: Returns a list of Variants
16112       operationId: variants-list
16113       parameters:
16114       - name: page
16115         in: query
16116         example: 1
16117         schema:
16118           type: integer
16119       - name: per_page
16120         in: query
16121         example: 50
16122         schema:
16123           type: integer
16124       - name: include
16125         in: query
16126         description: 'Select which associated resources you would like to fetch, see:
16127           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16128         example: product,tax_category,images,digitals
16129         schema:
16130           type: string
16131       - name: filter[product_id_eq]
16132         in: query
16133         description: ''
16134         example: '1'
16135         schema:
16136           type: string
16137       - name: filter[sku_i_cont]
16138         in: query
16139         description: ''
16140         example: SKU123
16141         schema:
16142           type: string
16143       responses:
16144         '200':
16145           description: Records returned
16146           content:
16147             application/vnd.api+json:
16148               examples:
16149                 Example:
16150                   value:
16151                     data:
16152                     - id: '284'
16153                       type: variant
16154                       attributes:
16155                         sku: SKU-283
16156                         weight: '0.0'
16157                         height:
16158                         depth:
16159                         deleted_at:
16160                         is_master: true
16161                         cost_price: '17.0'
16162                         position: 1
16163                         cost_currency: USD
16164                         track_inventory: true
16165                         updated_at: '2022-11-08T19:35:56.573Z'
16166                         discontinue_on:
16167                         created_at: '2022-11-08T19:35:56.573Z'
16168                         public_metadata: {}
16169                         private_metadata: {}
16170                         barcode:
16171                         display_price: "$19.99"
16172                         display_compare_at_price:
16173                         name: Product 213286
16174                         options_text: ''
16175                         total_on_hand: 0
16176                         purchasable: true
16177                         in_stock: false
16178                         backorderable: true
16179                         available: true
16180                         currency: USD
16181                         price: '19.99'
16182                         compare_at_price:
16183                       relationships:
16184                         product:
16185                           data:
16186                             id: '214'
16187                             type: product
16188                         tax_category:
16189                           data:
16190                         digitals:
16191                           data: []
16192                         images:
16193                           data: []
16194                         option_values:
16195                           data: []
16196                         stock_items:
16197                           data:
16198                           - id: '300'
16199                             type: stock_item
16200                         stock_locations:
16201                           data:
16202                           - id: '187'
16203                             type: stock_location
16204                     - id: '285'
16205                       type: variant
16206                       attributes:
16207                         sku: SKU-284
16208                         weight: '23.12'
16209                         height: '92.8'
16210                         depth: '47.37'
16211                         deleted_at:
16212                         is_master: false
16213                         cost_price: '17.0'
16214                         position: 2
16215                         cost_currency: USD
16216                         track_inventory: true
16217                         updated_at: '2022-11-08T19:35:56.608Z'
16218                         discontinue_on:
16219                         created_at: '2022-11-08T19:35:56.605Z'
16220                         public_metadata: {}
16221                         private_metadata: {}
16222                         barcode:
16223                         display_price: "$19.99"
16224                         display_compare_at_price:
16225                         name: Product 213286
16226                         options_text: 'Size: S'
16227                         total_on_hand: 0
16228                         purchasable: true
16229                         in_stock: false
16230                         backorderable: true
16231                         available: true
16232                         currency: USD
16233                         price: '19.99'
16234                         compare_at_price:
16235                       relationships:
16236                         product:
16237                           data:
16238                             id: '214'
16239                             type: product
16240                         tax_category:
16241                           data:
16242                         digitals:
16243                           data: []
16244                         images:
16245                           data: []
16246                         option_values:
16247                           data:
16248                           - id: '83'
16249                             type: option_value
16250                         stock_items:
16251                           data:
16252                           - id: '301'
16253                             type: stock_item
16254                         stock_locations:
16255                           data:
16256                           - id: '187'
16257                             type: stock_location
16258                     - id: '286'
16259                       type: variant
16260                       attributes:
16261                         sku: SKU-285
16262                         weight: '90.94'
16263                         height: '108.64'
16264                         depth: '191.7'
16265                         deleted_at:
16266                         is_master: false
16267                         cost_price: '17.0'
16268                         position: 3
16269                         cost_currency: USD
16270                         track_inventory: true
16271                         updated_at: '2022-11-08T19:35:56.633Z'
16272                         discontinue_on:
16273                         created_at: '2022-11-08T19:35:56.629Z'
16274                         public_metadata: {}
16275                         private_metadata: {}
16276                         barcode:
16277                         display_price: "$19.99"
16278                         display_compare_at_price:
16279                         name: Product 213286
16280                         options_text: 'Size: S'
16281                         total_on_hand: 0
16282                         purchasable: true
16283                         in_stock: false
16284                         backorderable: true
16285                         available: true
16286                         currency: USD
16287                         price: '19.99'
16288                         compare_at_price:
16289                       relationships:
16290                         product:
16291                           data:
16292                             id: '214'
16293                             type: product
16294                         tax_category:
16295                           data:
16296                         digitals:
16297                           data: []
16298                         images:
16299                           data: []
16300                         option_values:
16301                           data:
16302                           - id: '84'
16303                             type: option_value
16304                         stock_items:
16305                           data:
16306                           - id: '302'
16307                             type: stock_item
16308                         stock_locations:
16309                           data:
16310                           - id: '187'
16311                             type: stock_location
16312                     meta:
16313                       count: 3
16314                       total_count: 3
16315                       total_pages: 1
16316                     links:
16317                       self: http://www.example.com/api/v2/platform/variants?page=1&per_page=&include=&filter[product_id_eq]=&filter[sku_i_cont]=
16318                       next: http://www.example.com/api/v2/platform/variants?filter%5Bproduct_id_eq%5D=&filter%5Bsku_i_cont%5D=&include=&page=1&per_page=
16319                       prev: http://www.example.com/api/v2/platform/variants?filter%5Bproduct_id_eq%5D=&filter%5Bsku_i_cont%5D=&include=&page=1&per_page=
16320                       last: http://www.example.com/api/v2/platform/variants?filter%5Bproduct_id_eq%5D=&filter%5Bsku_i_cont%5D=&include=&page=1&per_page=
16321                       first: http://www.example.com/api/v2/platform/variants?filter%5Bproduct_id_eq%5D=&filter%5Bsku_i_cont%5D=&include=&page=1&per_page=
16322               schema:
16323                 "$ref": "#/components/schemas/resources_list"
16324         '401':
16325           description: Authentication Failed
16326           content:
16327             application/vnd.api+json:
16328               examples:
16329                 Example:
16330                   value:
16331                     error: The access token is invalid
16332               schema:
16333                 "$ref": "#/components/schemas/error"
16334   "/api/v2/platform/variants/{id}":
16335     get:
16336       summary: Return a Variant
16337       tags:
16338       - Variants
16339       security:
16340       - bearer_auth: []
16341       description: Returns a Variant
16342       operationId: show-variant
16343       parameters:
16344       - name: id
16345         in: path
16346         required: true
16347         schema:
16348           type: string
16349       - name: include
16350         in: query
16351         description: 'Select which associated resources you would like to fetch, see:
16352           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16353         example: product,tax_category,images,digitals
16354         schema:
16355           type: string
16356       responses:
16357         '200':
16358           description: Record found
16359           content:
16360             application/vnd.api+json:
16361               examples:
16362                 Example:
16363                   value:
16364                     data:
16365                       id: '291'
16366                       type: variant
16367                       attributes:
16368                         sku: SKU-290
16369                         weight: '185.0'
16370                         height: '33.55'
16371                         depth: '3.78'
16372                         deleted_at:
16373                         is_master: false
16374                         cost_price: '17.0'
16375                         position: 2
16376                         cost_currency: USD
16377                         track_inventory: true
16378                         updated_at: '2022-11-08T19:35:57.221Z'
16379                         discontinue_on:
16380                         created_at: '2022-11-08T19:35:57.218Z'
16381                         public_metadata: {}
16382                         private_metadata: {}
16383                         barcode:
16384                         display_price: "$19.99"
16385                         display_compare_at_price:
16386                         name: Product 2153349
16387                         options_text: 'Size: S'
16388                         total_on_hand: 0
16389                         purchasable: true
16390                         in_stock: false
16391                         backorderable: true
16392                         available: true
16393                         currency: USD
16394                         price: '19.99'
16395                         compare_at_price:
16396                       relationships:
16397                         product:
16398                           data:
16399                             id: '216'
16400                             type: product
16401                         tax_category:
16402                           data:
16403                         digitals:
16404                           data: []
16405                         images:
16406                           data: []
16407                         option_values:
16408                           data:
16409                           - id: '87'
16410                             type: option_value
16411                         stock_items:
16412                           data:
16413                           - id: '307'
16414                             type: stock_item
16415                         stock_locations:
16416                           data:
16417                           - id: '189'
16418                             type: stock_location
16419               schema:
16420                 "$ref": "#/components/schemas/resource"
16421         '404':
16422           description: Record not found
16423           content:
16424             application/vnd.api+json:
16425               examples:
16426                 Example:
16427                   value:
16428                     error: The resource you were looking for could not be found.
16429               schema:
16430                 "$ref": "#/components/schemas/error"
16431         '401':
16432           description: Authentication Failed
16433           content:
16434             application/vnd.api+json:
16435               examples:
16436                 Example:
16437                   value:
16438                     error: The access token is invalid
16439               schema:
16440                 "$ref": "#/components/schemas/error"
16441     delete:
16442       summary: Delete a Variant
16443       tags:
16444       - Variants
16445       security:
16446       - bearer_auth: []
16447       description: Deletes a Variant
16448       operationId: delete-variant
16449       parameters:
16450       - name: id
16451         in: path
16452         required: true
16453         schema:
16454           type: string
16455       responses:
16456         '204':
16457           description: Record deleted
16458         '404':
16459           description: Record not found
16460           content:
16461             application/vnd.api+json:
16462               examples:
16463                 Example:
16464                   value:
16465                     error: The resource you were looking for could not be found.
16466               schema:
16467                 "$ref": "#/components/schemas/error"
16468         '401':
16469           description: Authentication Failed
16470           content:
16471             application/vnd.api+json:
16472               examples:
16473                 Example:
16474                   value:
16475                     error: The access token is invalid
16476               schema:
16477                 "$ref": "#/components/schemas/error"
16478   "/api/v2/platform/vendors":
16479     get:
16480       summary: Return a list of Vendors
16481       tags:
16482       - Vendors
16483       security:
16484       - bearer_auth: []
16485       description: Returns a list of Vendors. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16486       operationId: vendors-list
16487       parameters:
16488       - name: page
16489         in: query
16490         example: 1
16491         schema:
16492           type: integer
16493       - name: per_page
16494         in: query
16495         example: 50
16496         schema:
16497           type: integer
16498       - name: include
16499         in: query
16500         description: 'Select which associated resources you would like to fetch, see:
16501           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16502         example: members
16503         schema:
16504           type: string
16505       responses:
16506         '200':
16507           description: Records returned
16508         '401':
16509           description: Authentication Failed
16510     post:
16511       summary: Create a Vendor
16512       tags:
16513       - Vendors
16514       security:
16515       - bearer_auth: []
16516       description: Creates a Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16517       operationId: create-vendor
16518       parameters:
16519       - name: include
16520         in: query
16521         description: 'Select which associated resources you would like to fetch, see:
16522           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16523         example: members
16524         schema:
16525           type: string
16526       responses:
16527         '201':
16528           description: Record created
16529         '422':
16530           description: Invalid request
16531       requestBody:
16532         content:
16533           application/json:
16534             schema:
16535               "$ref": "#/components/schemas/create_vendor_params"
16536   "/api/v2/platform/vendors/{id}":
16537     get:
16538       summary: Return a Vendor
16539       tags:
16540       - Vendors
16541       security:
16542       - bearer_auth: []
16543       description: Returns a Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16544       operationId: show-vendor
16545       parameters:
16546       - name: id
16547         in: path
16548         required: true
16549         schema:
16550           type: string
16551       - name: include
16552         in: query
16553         description: 'Select which associated resources you would like to fetch, see:
16554           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16555         example: members
16556         schema:
16557           type: string
16558       responses:
16559         '200':
16560           description: Record found
16561         '404':
16562           description: Record not found
16563         '401':
16564           description: Authentication Failed
16565     patch:
16566       summary: Update a Vendor
16567       tags:
16568       - Vendors
16569       security:
16570       - bearer_auth: []
16571       description: Updates a Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16572       operationId: update-vendor
16573       parameters:
16574       - name: id
16575         in: path
16576         required: true
16577         schema:
16578           type: string
16579       - name: include
16580         in: query
16581         description: 'Select which associated resources you would like to fetch, see:
16582           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16583         example: members
16584         schema:
16585           type: string
16586       responses:
16587         '200':
16588           description: Record updated
16589         '422':
16590           description: Invalid request
16591         '404':
16592           description: Record not found
16593         '401':
16594           description: Authentication Failed
16595       requestBody:
16596         content:
16597           application/json:
16598             schema:
16599               "$ref": "#/components/schemas/update_vendor_params"
16600     delete:
16601       summary: Delete a Vendor
16602       tags:
16603       - Vendors
16604       security:
16605       - bearer_auth: []
16606       description: Deletes a Vendor. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16607       operationId: delete-vendor
16608       parameters:
16609       - name: id
16610         in: path
16611         required: true
16612         schema:
16613           type: string
16614       responses:
16615         '204':
16616           description: Record deleted
16617         '404':
16618           description: Record not found
16619         '401':
16620           description: Authentication Failed
16621   "/api/v2/platform/vendors/{id}/invite":
16622     patch:
16623       summary: Invites Vendor to the platform
16624       tags:
16625       - Vendors
16626       security:
16627       - bearer_auth: []
16628       description: Also triggers an invitation email send out to the vendor's contact person. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16629       operationId: invite-vendor
16630       parameters:
16631       - name: id
16632         in: path
16633         required: true
16634         schema:
16635           type: string
16636       - name: include
16637         in: query
16638         description: 'Select which associated resources you would like to fetch, see:
16639           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16640         example: members
16641         schema:
16642           type: string
16643       responses:
16644         '200':
16645           description: Record updated
16646         '404':
16647           description: Record not found
16648         '401':
16649           description: Authentication Failed
16650   "/api/v2/platform/vendors/{id}/start_onboarding":
16651     patch:
16652       summary: Start onboarding process
16653       tags:
16654       - Vendors
16655       security:
16656       - bearer_auth: []
16657       description: Marks Vendor as onboarding in progress. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16658       operationId: start-onboarding-vendor
16659       parameters:
16660       - name: id
16661         in: path
16662         required: true
16663         schema:
16664           type: string
16665       - name: include
16666         in: query
16667         description: 'Select which associated resources you would like to fetch, see:
16668           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16669         example: members
16670         schema:
16671           type: string
16672       responses:
16673         '200':
16674           description: Record updated
16675         '404':
16676           description: Record not found
16677         '401':
16678           description: Authentication Failed
16679   "/api/v2/platform/vendors/{id}/complete_onboarding":
16680     patch:
16681       summary: Completes onboarding process
16682       tags:
16683       - Vendors
16684       security:
16685       - bearer_auth: []
16686       description: Marks Vendor as onboarding complete. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16687       operationId: complete-onboarding-vendor
16688       parameters:
16689       - name: id
16690         in: path
16691         required: true
16692         schema:
16693           type: string
16694       - name: include
16695         in: query
16696         description: 'Select which associated resources you would like to fetch, see:
16697           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16698         example: members
16699         schema:
16700           type: string
16701       responses:
16702         '200':
16703           description: Record updated
16704         '404':
16705           description: Record not found
16706         '401':
16707           description: Authentication Failed
16708   "/api/v2/platform/vendors/{id}/approve":
16709     patch:
16710       summary: Approves Vendor
16711       tags:
16712       - Vendors
16713       security:
16714       - bearer_auth: []
16715       description: Marks Vendor as approved, and triggers an approval email send out
16716         to the vendor's contact person. Also activated Vendor products will become
16717         available for purchase. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16718       operationId: approve-vendor
16719       parameters:
16720       - name: id
16721         in: path
16722         required: true
16723         schema:
16724           type: string
16725       - name: include
16726         in: query
16727         description: 'Select which associated resources you would like to fetch, see:
16728           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16729         example: members
16730         schema:
16731           type: string
16732       responses:
16733         '200':
16734           description: Record updated
16735         '404':
16736           description: Record not found
16737         '401':
16738           description: Authentication Failed
16739   "/api/v2/platform/vendors/{id}/reject":
16740     patch:
16741       summary: Rejects Vendor
16742       tags:
16743       - Vendors
16744       security:
16745       - bearer_auth: []
16746       description: Marks Vendor as rejected, and triggers an approval email send out
16747         to the vendor's contact person. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16748       operationId: reject-vendor
16749       parameters:
16750       - name: id
16751         in: path
16752         required: true
16753         schema:
16754           type: string
16755       - name: include
16756         in: query
16757         description: 'Select which associated resources you would like to fetch, see:
16758           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16759         example: members
16760         schema:
16761           type: string
16762       responses:
16763         '200':
16764           description: Record updated
16765         '404':
16766           description: Record not found
16767         '401':
16768           description: Authentication Failed
16769   "/api/v2/platform/vendors/{id}/suspend":
16770     patch:
16771       summary: Suspends Vendor
16772       tags:
16773       - Vendors
16774       security:
16775       - bearer_auth: []
16776       description: Marks Vendor as suspended, and triggers an approval email send
16777         out to the vendor's contact person. Also the vendor's products will become
16778         unavailable for purchase and will be hidden from the storefront. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)
16779       operationId: suspend-vendor
16780       parameters:
16781       - name: id
16782         in: path
16783         required: true
16784         schema:
16785           type: string
16786       - name: include
16787         in: query
16788         description: 'Select which associated resources you would like to fetch, see:
16789           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16790         example: members
16791         schema:
16792           type: string
16793       responses:
16794         '200':
16795           description: Record updated
16796         '404':
16797           description: Record not found
16798         '401':
16799           description: Authentication Failed
16800   "/api/v2/platform/webhooks/events":
16801     get:
16802       summary: Return a list of Webhook Events
16803       tags:
16804       - Webhook Events
16805       security:
16806       - bearer_auth: []
16807       description: Returns a list of Webhook Events
16808       operationId: webhook-events-list
16809       parameters:
16810       - name: page
16811         in: query
16812         example: 1
16813         schema:
16814           type: integer
16815       - name: per_page
16816         in: query
16817         example: 50
16818         schema:
16819           type: integer
16820       - name: include
16821         in: query
16822         description: 'Select which associated resources you would like to fetch, see:
16823           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
16824         example: subscriber
16825         schema:
16826           type: string
16827       - name: filter[name_eq]
16828         in: query
16829         description: ''
16830         example: order.canceled
16831         schema:
16832           type: string
16833       - name: filter[request_errors_cont]
16834         in: query
16835         description: ''
16836         example: google
16837         schema:
16838           type: string
16839       - name: filter[response_code_eq]
16840         in: query
16841         description: ''
16842         example: '200'
16843         schema:
16844           type: string
16845       - name: filter[success_eq]
16846         in: query
16847         description: ''
16848         example: 'true'
16849         schema:
16850           type: string
16851       - name: filter[url_cont]
16852         in: query
16853         description: ''
16854         example: mysite
16855         schema:
16856           type: string
16857       responses:
16858         '200':
16859           description: Records returned
16860           content:
16861             application/vnd.api+json:
16862               examples:
16863                 Example:
16864                   value:
16865                     data:
16866                     - id: '1'
16867                       type: event
16868                       attributes:
16869                         execution_time: 14933
16870                         name: order.canceled
16871                         request_errors: ''
16872                         response_code: '200'
16873                         success: true
16874                         url: https://www.url1.com/
16875                         created_at: '2022-11-08T19:35:58.544Z'
16876                         updated_at: '2022-11-08T19:35:58.544Z'
16877                       relationships:
16878                         subscriber:
16879                           data:
16880                             id: '1'
16881                             type: subscriber
16882                     - id: '2'
16883                       type: event
16884                       attributes:
16885                         execution_time: 64917
16886                         name: order.canceled
16887                         request_errors: ''
16888                         response_code: '200'
16889                         success: true
16890                         url: https://www.url2.com/
16891                         created_at: '2022-11-08T19:35:58.547Z'
16892                         updated_at: '2022-11-08T19:35:58.547Z'
16893                       relationships:
16894                         subscriber:
16895                           data:
16896                             id: '2'
16897                             type: subscriber
16898                     meta:
16899                       count: 2
16900                       total_count: 2
16901                       total_pages: 1
16902                     links:
16903                       self: http://www.example.com/api/v2/platform/webhooks/events?page=1&per_page=&include=&filter[name_eq]=&filter[request_errors_cont]=&filter[response_code_eq]=&filter[success_eq]=&filter[url_cont]=
16904                       next: http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=
16905                       prev: http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=
16906                       last: http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=
16907                       first: http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=
16908               schema:
16909                 "$ref": "#/components/schemas/resources_list"
16910         '401':
16911           description: Authentication Failed
16912           content:
16913             application/vnd.api+json:
16914               examples:
16915                 Example:
16916                   value:
16917                     error: The access token is invalid
16918               schema:
16919                 "$ref": "#/components/schemas/error"
16920   "/api/v2/platform/webhooks/subscribers":
16921     get:
16922       summary: Return a list of Webhook Subscribers
16923       tags:
16924       - Webhook Subscribers
16925       security:
16926       - bearer_auth: []
16927       description: Returns a list of Webhook Subscribers
16928       operationId: webhook-subscribers-list
16929       parameters:
16930       - name: page
16931         in: query
16932         example: 1
16933         schema:
16934           type: integer
16935       - name: per_page
16936         in: query
16937         example: 50
16938         schema:
16939           type: integer
16940       - name: filter[active_eq]
16941         in: query
16942         description: ''
16943         example: 'true'
16944         schema:
16945           type: string
16946       - name: filter[url_cont]
16947         in: query
16948         description: ''
16949         example: mysite
16950         schema:
16951           type: string
16952       responses:
16953         '200':
16954           description: Records returned
16955           content:
16956             application/vnd.api+json:
16957               examples:
16958                 Example:
16959                   value:
16960                     data:
16961                     - id: '5'
16962                       type: subscriber
16963                       attributes:
16964                         url: https://www.url5.com/
16965                         active: true
16966                         subscriptions:
16967                         - "*"
16968                         created_at: '2022-11-08T19:35:58.830Z'
16969                         updated_at: '2022-11-08T19:35:58.830Z'
16970                     - id: '6'
16971                       type: subscriber
16972                       attributes:
16973                         url: https://www.url6.com/
16974                         active: true
16975                         subscriptions:
16976                         - "*"
16977                         created_at: '2022-11-08T19:35:58.831Z'
16978                         updated_at: '2022-11-08T19:35:58.831Z'
16979                     meta:
16980                       count: 2
16981                       total_count: 2
16982                       total_pages: 1
16983                     links:
16984                       self: http://www.example.com/api/v2/platform/webhooks/subscribers?page=1&per_page=&filter[active_eq]=&filter[url_cont]=
16985                       next: http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=
16986                       prev: http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=
16987                       last: http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=
16988                       first: http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=
16989               schema:
16990                 "$ref": "#/components/schemas/resources_list"
16991         '401':
16992           description: Authentication Failed
16993           content:
16994             application/vnd.api+json:
16995               examples:
16996                 Example:
16997                   value:
16998                     error: The access token is invalid
16999               schema:
17000                 "$ref": "#/components/schemas/error"
17001     post:
17002       summary: Create a Webhook Subscriber
17003       tags:
17004       - Webhook Subscribers
17005       security:
17006       - bearer_auth: []
17007       description: Creates a Webhook Subscriber
17008       operationId: create-webhook-subscriber
17009       parameters: []
17010       responses:
17011         '201':
17012           description: Record created
17013           content:
17014             application/vnd.api+json:
17015               examples:
17016                 Example:
17017                   value:
17018                     data:
17019                       id: '9'
17020                       type: subscriber
17021                       attributes:
17022                         url: https://www.url9.com/
17023                         active: true
17024                         subscriptions:
17025                         - "*"
17026                         created_at: '2022-11-08T19:35:59.334Z'
17027                         updated_at: '2022-11-08T19:35:59.334Z'
17028               schema:
17029                 "$ref": "#/components/schemas/resource"
17030         '422':
17031           description: Invalid request
17032           content:
17033             application/vnd.api+json:
17034               examples:
17035                 Example:
17036                   value:
17037                     error: Url must be a valid URL, Url can't be blank, and Url the
17038                       URL must have a path
17039                     errors:
17040                       url:
17041                       - must be a valid URL
17042                       - can't be blank
17043                       - the URL must have a path
17044               schema:
17045                 "$ref": "#/components/schemas/validation_errors"
17046       requestBody:
17047         content:
17048           application/json:
17049             schema:
17050               "$ref": "#/components/schemas/create_webhook_subscriber_params"
17051   "/api/v2/platform/webhooks/subscribers/{id}":
17052     get:
17053       summary: Return a Webhook Subscriber
17054       tags:
17055       - Webhook Subscribers
17056       security:
17057       - bearer_auth: []
17058       description: Returns a Webhook Subscriber
17059       operationId: show-webhook-subscriber
17060       parameters:
17061       - name: id
17062         in: path
17063         required: true
17064         schema:
17065           type: string
17066       responses:
17067         '200':
17068           description: Record found
17069           content:
17070             application/vnd.api+json:
17071               examples:
17072                 Example:
17073                   value:
17074                     data:
17075                       id: '10'
17076                       type: subscriber
17077                       attributes:
17078                         url: https://www.url10.com/
17079                         active: true
17080                         subscriptions:
17081                         - "*"
17082                         created_at: '2022-11-08T19:35:59.604Z'
17083                         updated_at: '2022-11-08T19:35:59.604Z'
17084               schema:
17085                 "$ref": "#/components/schemas/resource"
17086         '404':
17087           description: Record not found
17088           content:
17089             application/vnd.api+json:
17090               examples:
17091                 Example:
17092                   value:
17093                     error: The resource you were looking for could not be found.
17094               schema:
17095                 "$ref": "#/components/schemas/error"
17096         '401':
17097           description: Authentication Failed
17098           content:
17099             application/vnd.api+json:
17100               examples:
17101                 Example:
17102                   value:
17103                     error: The access token is invalid
17104               schema:
17105                 "$ref": "#/components/schemas/error"
17106     patch:
17107       summary: Update a Webhook Subscriber
17108       tags:
17109       - Webhook Subscribers
17110       security:
17111       - bearer_auth: []
17112       description: Updates a Webhook Subscriber
17113       operationId: update-webhook-subscriber
17114       parameters:
17115       - name: id
17116         in: path
17117         required: true
17118         schema:
17119           type: string
17120       responses:
17121         '200':
17122           description: Record updated
17123           content:
17124             application/vnd.api+json:
17125               examples:
17126                 Example:
17127                   value:
17128                     data:
17129                       id: '12'
17130                       type: subscriber
17131                       attributes:
17132                         url: https://www.url12.com/
17133                         active: true
17134                         subscriptions:
17135                         - "*"
17136                         created_at: '2022-11-08T19:36:00.130Z'
17137                         updated_at: '2022-11-08T19:36:00.130Z'
17138               schema:
17139                 "$ref": "#/components/schemas/resource"
17140         '422':
17141           description: Invalid request
17142           content:
17143             application/vnd.api+json:
17144               examples:
17145                 Example:
17146                   value:
17147                     error: Url must be a valid URL, Url can't be blank, and Url the
17148                       URL must have a path
17149                     errors:
17150                       url:
17151                       - must be a valid URL
17152                       - can't be blank
17153                       - the URL must have a path
17154               schema:
17155                 "$ref": "#/components/schemas/validation_errors"
17156         '404':
17157           description: Record not found
17158           content:
17159             application/vnd.api+json:
17160               examples:
17161                 Example:
17162                   value:
17163                     error: The resource you were looking for could not be found.
17164               schema:
17165                 "$ref": "#/components/schemas/error"
17166         '401':
17167           description: Authentication Failed
17168           content:
17169             application/vnd.api+json:
17170               examples:
17171                 Example:
17172                   value:
17173                     error: The access token is invalid
17174               schema:
17175                 "$ref": "#/components/schemas/error"
17176       requestBody:
17177         content:
17178           application/json:
17179             schema:
17180               "$ref": "#/components/schemas/update_webhook_subscriber_params"
17181     delete:
17182       summary: Delete a Webhook Subscriber
17183       tags:
17184       - Webhook Subscribers
17185       security:
17186       - bearer_auth: []
17187       description: Deletes a Webhook Subscriber
17188       operationId: delete-webhook-subscriber
17189       parameters:
17190       - name: id
17191         in: path
17192         required: true
17193         schema:
17194           type: string
17195       responses:
17196         '204':
17197           description: Record deleted
17198         '404':
17199           description: Record not found
17200           content:
17201             application/vnd.api+json:
17202               examples:
17203                 Example:
17204                   value:
17205                     error: The resource you were looking for could not be found.
17206               schema:
17207                 "$ref": "#/components/schemas/error"
17208         '401':
17209           description: Authentication Failed
17210           content:
17211             application/vnd.api+json:
17212               examples:
17213                 Example:
17214                   value:
17215                     error: The access token is invalid
17216               schema:
17217                 "$ref": "#/components/schemas/error"
17218   "/api/v2/platform/wished_items":
17219     get:
17220       summary: Return a list of Wished Items
17221       tags:
17222       - Wished Items
17223       security:
17224       - bearer_auth: []
17225       description: Returns a list of Wished Items
17226       operationId: wished-items-list
17227       parameters:
17228       - name: page
17229         in: query
17230         example: 1
17231         schema:
17232           type: integer
17233       - name: per_page
17234         in: query
17235         example: 50
17236         schema:
17237           type: integer
17238       - name: include
17239         in: query
17240         description: 'Select which associated resources you would like to fetch, see:
17241           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
17242         example: variant
17243         schema:
17244           type: string
17245       responses:
17246         '200':
17247           description: Records returned
17248           content:
17249             application/vnd.api+json:
17250               examples:
17251                 Example:
17252                   value:
17253                     data:
17254                     - id: '1'
17255                       type: wished_item
17256                       attributes:
17257                         quantity: 1
17258                         created_at: '2022-11-08T19:36:01.546Z'
17259                         updated_at: '2022-11-08T19:36:01.546Z'
17260                         display_total: "$19.99"
17261                         display_price: "$19.99"
17262                         price: '19.99'
17263                         total: '19.99'
17264                       relationships:
17265                         variant:
17266                           data:
17267                             id: '301'
17268                             type: variant
17269                     - id: '2'
17270                       type: wished_item
17271                       attributes:
17272                         quantity: 1
17273                         created_at: '2022-11-08T19:36:01.616Z'
17274                         updated_at: '2022-11-08T19:36:01.616Z'
17275                         display_total: "$19.99"
17276                         display_price: "$19.99"
17277                         price: '19.99'
17278                         total: '19.99'
17279                       relationships:
17280                         variant:
17281                           data:
17282                             id: '303'
17283                             type: variant
17284                     - id: '3'
17285                       type: wished_item
17286                       attributes:
17287                         quantity: 1
17288                         created_at: '2022-11-08T19:36:01.685Z'
17289                         updated_at: '2022-11-08T19:36:01.685Z'
17290                         display_total: "$19.99"
17291                         display_price: "$19.99"
17292                         price: '19.99'
17293                         total: '19.99'
17294                       relationships:
17295                         variant:
17296                           data:
17297                             id: '305'
17298                             type: variant
17299                     - id: '4'
17300                       type: wished_item
17301                       attributes:
17302                         quantity: 1
17303                         created_at: '2022-11-08T19:36:01.752Z'
17304                         updated_at: '2022-11-08T19:36:01.752Z'
17305                         display_total: "$19.99"
17306                         display_price: "$19.99"
17307                         price: '19.99'
17308                         total: '19.99'
17309                       relationships:
17310                         variant:
17311                           data:
17312                             id: '307'
17313                             type: variant
17314                     meta:
17315                       count: 4
17316                       total_count: 4
17317                       total_pages: 1
17318                     links:
17319                       self: http://www.example.com/api/v2/platform/wished_items?page=1&per_page=&include=
17320                       next: http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=
17321                       prev: http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=
17322                       last: http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=
17323                       first: http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=
17324               schema:
17325                 "$ref": "#/components/schemas/resources_list"
17326         '401':
17327           description: Authentication Failed
17328           content:
17329             application/vnd.api+json:
17330               examples:
17331                 Example:
17332                   value:
17333                     error: The access token is invalid
17334               schema:
17335                 "$ref": "#/components/schemas/error"
17336     post:
17337       summary: Create a Wished Item
17338       tags:
17339       - Wished Items
17340       security:
17341       - bearer_auth: []
17342       description: Creates a Wished Item
17343       operationId: create-wished-item
17344       parameters:
17345       - name: include
17346         in: query
17347         description: 'Select which associated resources you would like to fetch, see:
17348           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
17349         example: variant
17350         schema:
17351           type: string
17352       responses:
17353         '201':
17354           description: Record created
17355           content:
17356             application/vnd.api+json:
17357               examples:
17358                 Example:
17359                   value:
17360                     data:
17361                       id: '9'
17362                       type: wished_item
17363                       attributes:
17364                         quantity: 1
17365                         created_at: '2022-11-08T19:36:02.710Z'
17366                         updated_at: '2022-11-08T19:36:02.710Z'
17367                         display_total: "$19.99"
17368                         display_price: "$19.99"
17369                         price: '19.99'
17370                         total: '19.99'
17371                       relationships:
17372                         variant:
17373                           data:
17374                             id: '319'
17375                             type: variant
17376               schema:
17377                 "$ref": "#/components/schemas/resource"
17378         '422':
17379           description: Invalid request
17380           content:
17381             application/vnd.api+json:
17382               examples:
17383                 Example:
17384                   value:
17385                     error: Variant can't be blank, Wishlist can't be blank, and Quantity
17386                       is not a number
17387                     errors:
17388                       variant:
17389                       - can't be blank
17390                       wishlist:
17391                       - can't be blank
17392                       quantity:
17393                       - is not a number
17394               schema:
17395                 "$ref": "#/components/schemas/validation_errors"
17396       requestBody:
17397         content:
17398           application/json:
17399             schema:
17400               "$ref": "#/components/schemas/create_wished_item_params"
17401   "/api/v2/platform/wished_items/{id}":
17402     get:
17403       summary: Return a Wished Item
17404       tags:
17405       - Wished Items
17406       security:
17407       - bearer_auth: []
17408       description: Returns a Wished Item
17409       operationId: show-wished-item
17410       parameters:
17411       - name: id
17412         in: path
17413         required: true
17414         schema:
17415           type: string
17416       - name: include
17417         in: query
17418         description: 'Select which associated resources you would like to fetch, see:
17419           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
17420         example: variant
17421         schema:
17422           type: string
17423       responses:
17424         '200':
17425           description: Record found
17426           content:
17427             application/vnd.api+json:
17428               examples:
17429                 Example:
17430                   value:
17431                     data:
17432                       id: '10'
17433                       type: wished_item
17434                       attributes:
17435                         quantity: 1
17436                         created_at: '2022-11-08T19:36:03.208Z'
17437                         updated_at: '2022-11-08T19:36:03.208Z'
17438                         display_total: "$19.99"
17439                         display_price: "$19.99"
17440                         price: '19.99'
17441                         total: '19.99'
17442                       relationships:
17443                         variant:
17444                           data:
17445                             id: '325'
17446                             type: variant
17447               schema:
17448                 "$ref": "#/components/schemas/resource"
17449         '404':
17450           description: Record not found
17451           content:
17452             application/vnd.api+json:
17453               examples:
17454                 Example:
17455                   value:
17456                     error: The resource you were looking for could not be found.
17457               schema:
17458                 "$ref": "#/components/schemas/error"
17459         '401':
17460           description: Authentication Failed
17461           content:
17462             application/vnd.api+json:
17463               examples:
17464                 Example:
17465                   value:
17466                     error: The access token is invalid
17467               schema:
17468                 "$ref": "#/components/schemas/error"
17469     patch:
17470       summary: Update a Wished Item
17471       tags:
17472       - Wished Items
17473       security:
17474       - bearer_auth: []
17475       description: Updates a Wished Item
17476       operationId: update-wished-item
17477       parameters:
17478       - name: id
17479         in: path
17480         required: true
17481         schema:
17482           type: string
17483       - name: include
17484         in: query
17485         description: 'Select which associated resources you would like to fetch, see:
17486           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
17487         example: variant
17488         schema:
17489           type: string
17490       responses:
17491         '200':
17492           description: Record updated
17493           content:
17494             application/vnd.api+json:
17495               examples:
17496                 Example:
17497                   value:
17498                     data:
17499                       id: '12'
17500                       type: wished_item
17501                       attributes:
17502                         quantity: 3
17503                         created_at: '2022-11-08T19:36:04.166Z'
17504                         updated_at: '2022-11-08T19:36:04.397Z'
17505                         display_total: "$59.97"
17506                         display_price: "$19.99"
17507                         price: '19.99'
17508                         total: '59.97'
17509                       relationships:
17510                         variant:
17511                           data:
17512                             id: '335'
17513                             type: variant
17514               schema:
17515                 "$ref": "#/components/schemas/resource"
17516         '422':
17517           description: Invalid request
17518           content:
17519             application/vnd.api+json:
17520               examples:
17521                 Example:
17522                   value:
17523                     error: Quantity is not a number
17524                     errors:
17525                       quantity:
17526                       - is not a number
17527               schema:
17528                 "$ref": "#/components/schemas/validation_errors"
17529         '404':
17530           description: Record not found
17531           content:
17532             application/vnd.api+json:
17533               examples:
17534                 Example:
17535                   value:
17536                     error: The resource you were looking for could not be found.
17537               schema:
17538                 "$ref": "#/components/schemas/error"
17539         '401':
17540           description: Authentication Failed
17541           content:
17542             application/vnd.api+json:
17543               examples:
17544                 Example:
17545                   value:
17546                     error: The access token is invalid
17547               schema:
17548                 "$ref": "#/components/schemas/error"
17549       requestBody:
17550         content:
17551           application/json:
17552             schema:
17553               "$ref": "#/components/schemas/update_wished_item_params"
17554     delete:
17555       summary: Delete a Wished Item
17556       tags:
17557       - Wished Items
17558       security:
17559       - bearer_auth: []
17560       description: Deletes a Wished Item
17561       operationId: delete-wished-item
17562       parameters:
17563       - name: id
17564         in: path
17565         required: true
17566         schema:
17567           type: string
17568       responses:
17569         '204':
17570           description: Record deleted
17571         '404':
17572           description: Record not found
17573           content:
17574             application/vnd.api+json:
17575               examples:
17576                 Example:
17577                   value:
17578                     error: The resource you were looking for could not be found.
17579               schema:
17580                 "$ref": "#/components/schemas/error"
17581         '401':
17582           description: Authentication Failed
17583           content:
17584             application/vnd.api+json:
17585               examples:
17586                 Example:
17587                   value:
17588                     error: The access token is invalid
17589               schema:
17590                 "$ref": "#/components/schemas/error"
17591   "/api/v2/platform/wishlists":
17592     get:
17593       summary: Return a list of Wishlists
17594       tags:
17595       - Wishlists
17596       security:
17597       - bearer_auth: []
17598       description: Returns a list of Wishlists
17599       operationId: wishlists-list
17600       parameters:
17601       - name: page
17602         in: query
17603         example: 1
17604         schema:
17605           type: integer
17606       - name: per_page
17607         in: query
17608         example: 50
17609         schema:
17610           type: integer
17611       - name: include
17612         in: query
17613         description: 'Select which associated resources you would like to fetch, see:
17614           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
17615         example: wished_items
17616         schema:
17617           type: string
17618       - name: filter[name_cont]
17619         in: query
17620         description: ''
17621         example: Birthday
17622         schema:
17623           type: string
17624       responses:
17625         '200':
17626           description: Records returned
17627           content:
17628             application/vnd.api+json:
17629               examples:
17630                 Example:
17631                   value:
17632                     data:
17633                     - id: '22'
17634                       type: wishlist
17635                       attributes:
17636                         name: Black Friday
17637                         is_private: true
17638                         is_default: false
17639                         created_at: '2022-11-08T19:36:06.256Z'
17640                         updated_at: '2022-11-08T19:36:06.256Z'
17641                         token: PunEhftsfcoHddCoVyqQLTYq
17642                         variant_included: false
17643                       relationships:
17644                         wished_items:
17645                           data:
17646                           - id: '17'
17647                             type: wished_item
17648                           - id: '18'
17649                             type: wished_item
17650                     - id: '23'
17651                       type: wishlist
17652                       attributes:
17653                         name: Birthday
17654                         is_private: true
17655                         is_default: false
17656                         created_at: '2022-11-08T19:36:06.257Z'
17657                         updated_at: '2022-11-08T19:36:06.257Z'
17658                         token: FYKHQXSsnSwAVEaci7RgbPXq
17659                         variant_included: false
17660                       relationships:
17661                         wished_items:
17662                           data:
17663                           - id: '19'
17664                             type: wished_item
17665                           - id: '20'
17666                             type: wished_item
17667                     meta:
17668                       count: 2
17669                       total_count: 2
17670                       total_pages: 1
17671                     links:
17672                       self: http://www.example.com/api/v2/platform/wishlists?page=1&per_page=&include=&filter[name_cont]=
17673                       next: http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=
17674                       prev: http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=
17675                       last: http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=
17676                       first: http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=
17677               schema:
17678                 "$ref": "#/components/schemas/resources_list"
17679         '401':
17680           description: Authentication Failed
17681           content:
17682             application/vnd.api+json:
17683               examples:
17684                 Example:
17685                   value:
17686                     error: The access token is invalid
17687               schema:
17688                 "$ref": "#/components/schemas/error"
17689     post:
17690       summary: Create a Wishlist
17691       tags:
17692       - Wishlists
17693       security:
17694       - bearer_auth: []
17695       description: Creates a Wishlist
17696       operationId: create-wishlist
17697       parameters:
17698       - name: include
17699         in: query
17700         description: 'Select which associated resources you would like to fetch, see:
17701           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
17702         example: wished_items
17703         schema:
17704           type: string
17705       responses:
17706         '201':
17707           description: Record created
17708           content:
17709             application/vnd.api+json:
17710               examples:
17711                 Example:
17712                   value:
17713                     data:
17714                       id: '26'
17715                       type: wishlist
17716                       attributes:
17717                         name: Wishlist_26
17718                         is_private: true
17719                         is_default: false
17720                         created_at: '2022-11-08T19:36:07.290Z'
17721                         updated_at: '2022-11-08T19:36:07.290Z'
17722                         token: w7zjAVs9QJd9MLdPXDQcxrqi
17723                         variant_included: false
17724                       relationships:
17725                         wished_items:
17726                           data: []
17727               schema:
17728                 "$ref": "#/components/schemas/resource"
17729         '422':
17730           description: Invalid request
17731           content:
17732             application/vnd.api+json:
17733               examples:
17734                 Example:
17735                   value:
17736                     error: Name can't be blank and User can't be blank
17737                     errors:
17738                       name:
17739                       - can't be blank
17740                       user:
17741                       - can't be blank
17742               schema:
17743                 "$ref": "#/components/schemas/validation_errors"
17744       requestBody:
17745         content:
17746           application/json:
17747             schema:
17748               "$ref": "#/components/schemas/create_wishlist_params"
17749   "/api/v2/platform/wishlists/{id}":
17750     get:
17751       summary: Return a Wishlist
17752       tags:
17753       - Wishlists
17754       security:
17755       - bearer_auth: []
17756       description: Returns a Wishlist
17757       operationId: show-wishlist
17758       parameters:
17759       - name: id
17760         in: path
17761         required: true
17762         schema:
17763           type: string
17764       - name: include
17765         in: query
17766         description: 'Select which associated resources you would like to fetch, see:
17767           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
17768         example: wished_items
17769         schema:
17770           type: string
17771       responses:
17772         '200':
17773           description: Record found
17774           content:
17775             application/vnd.api+json:
17776               examples:
17777                 Example:
17778                   value:
17779                     data:
17780                       id: '27'
17781                       type: wishlist
17782                       attributes:
17783                         name: My Wishlist
17784                         is_private: true
17785                         is_default: false
17786                         created_at: '2022-11-08T19:36:07.570Z'
17787                         updated_at: '2022-11-08T19:36:07.570Z'
17788                         token: mTKMs2ZP2PQc1Gu64XMvPrtk
17789                         variant_included: false
17790                       relationships:
17791                         wished_items:
17792                           data: []
17793               schema:
17794                 "$ref": "#/components/schemas/resource"
17795         '404':
17796           description: Record not found
17797           content:
17798             application/vnd.api+json:
17799               examples:
17800                 Example:
17801                   value:
17802                     error: The resource you were looking for could not be found.
17803               schema:
17804                 "$ref": "#/components/schemas/error"
17805         '401':
17806           description: Authentication Failed
17807           content:
17808             application/vnd.api+json:
17809               examples:
17810                 Example:
17811                   value:
17812                     error: The access token is invalid
17813               schema:
17814                 "$ref": "#/components/schemas/error"
17815     patch:
17816       summary: Update a Wishlist
17817       tags:
17818       - Wishlists
17819       security:
17820       - bearer_auth: []
17821       description: Updates a Wishlist
17822       operationId: update-wishlist
17823       parameters:
17824       - name: id
17825         in: path
17826         required: true
17827         schema:
17828           type: string
17829       - name: include
17830         in: query
17831         description: 'Select which associated resources you would like to fetch, see:
17832           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
17833         example: wished_items
17834         schema:
17835           type: string
17836       responses:
17837         '200':
17838           description: Record updated
17839           content:
17840             application/vnd.api+json:
17841               examples:
17842                 Example:
17843                   value:
17844                     data:
17845                       id: '29'
17846                       type: wishlist
17847                       attributes:
17848                         name: My Super Wishlist
17849                         is_private: true
17850                         is_default: false
17851                         created_at: '2022-11-08T19:36:08.103Z'
17852                         updated_at: '2022-11-08T19:36:08.334Z'
17853                         token: W4TY5oxqYi2kvpYs26XUPH3p
17854                         variant_included: false
17855                       relationships:
17856                         wished_items:
17857                           data: []
17858               schema:
17859                 "$ref": "#/components/schemas/resource"
17860         '422':
17861           description: Invalid request
17862           content:
17863             application/vnd.api+json:
17864               examples:
17865                 Example:
17866                   value:
17867                     error: Name can't be blank
17868                     errors:
17869                       name:
17870                       - can't be blank
17871               schema:
17872                 "$ref": "#/components/schemas/validation_errors"
17873         '404':
17874           description: Record not found
17875           content:
17876             application/vnd.api+json:
17877               examples:
17878                 Example:
17879                   value:
17880                     error: The resource you were looking for could not be found.
17881               schema:
17882                 "$ref": "#/components/schemas/error"
17883         '401':
17884           description: Authentication Failed
17885           content:
17886             application/vnd.api+json:
17887               examples:
17888                 Example:
17889                   value:
17890                     error: The access token is invalid
17891               schema:
17892                 "$ref": "#/components/schemas/error"
17893       requestBody:
17894         content:
17895           application/json:
17896             schema:
17897               "$ref": "#/components/schemas/update_wishlist_params"
17898     delete:
17899       summary: Delete a Wishlist
17900       tags:
17901       - Wishlists
17902       security:
17903       - bearer_auth: []
17904       description: Deletes a Wishlist
17905       operationId: delete-wishlist
17906       parameters:
17907       - name: id
17908         in: path
17909         required: true
17910         schema:
17911           type: string
17912       responses:
17913         '204':
17914           description: Record deleted
17915         '404':
17916           description: Record not found
17917           content:
17918             application/vnd.api+json:
17919               examples:
17920                 Example:
17921                   value:
17922                     error: The resource you were looking for could not be found.
17923               schema:
17924                 "$ref": "#/components/schemas/error"
17925         '401':
17926           description: Authentication Failed
17927           content:
17928             application/vnd.api+json:
17929               examples:
17930                 Example:
17931                   value:
17932                     error: The access token is invalid
17933               schema:
17934                 "$ref": "#/components/schemas/error"
17935   "/api/v2/platform/zones":
17936     get:
17937       summary: Return a list of Zones
17938       tags:
17939       - Zones
17940       security:
17941       - bearer_auth: []
17942       description: Returns a list of Zones
17943       operationId: zones-list
17944       parameters:
17945       - name: page
17946         in: query
17947         example: 1
17948         schema:
17949           type: integer
17950       - name: per_page
17951         in: query
17952         example: 50
17953         schema:
17954           type: integer
17955       - name: include
17956         in: query
17957         description: 'Select which associated resources you would like to fetch, see:
17958           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
17959         example: zone_members
17960         schema:
17961           type: string
17962       - name: filter[description_eq]
17963         in: query
17964         description: ''
17965         example: The zone containing all EU countries
17966         schema:
17967           type: string
17968       responses:
17969         '200':
17970           description: Records returned
17971           content:
17972             application/vnd.api+json:
17973               examples:
17974                 Example:
17975                   value:
17976                     data:
17977                     - id: '113'
17978                       type: zone
17979                       attributes:
17980                         name: Laudantium itaque ab suscipit quo fugit delectus perferendis.
17981                         description: Cum nisi esse veniam explicabo praesentium quod
17982                           reprehenderit.
17983                         default_tax: false
17984                         zone_members_count: 0
17985                         created_at: '2022-11-08T19:36:09.411Z'
17986                         updated_at: '2022-11-08T19:36:09.411Z'
17987                         kind: state
17988                       relationships:
17989                         zone_members:
17990                           data: []
17991                     - id: '114'
17992                       type: zone
17993                       attributes:
17994                         name: Enim perferendis consectetur in assumenda dolor deserunt.
17995                         description: Incidunt iusto vitae architecto nulla voluptate.
17996                         default_tax: false
17997                         zone_members_count: 0
17998                         created_at: '2022-11-08T19:36:09.412Z'
17999                         updated_at: '2022-11-08T19:36:09.412Z'
18000                         kind: state
18001                       relationships:
18002                         zone_members:
18003                           data: []
18004                     meta:
18005                       count: 2
18006                       total_count: 2
18007                       total_pages: 1
18008                     links:
18009                       self: http://www.example.com/api/v2/platform/zones?page=1&per_page=&include=&filter[description_eq]=
18010                       next: http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=
18011                       prev: http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=
18012                       last: http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=
18013                       first: http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=
18014               schema:
18015                 "$ref": "#/components/schemas/resources_list"
18016         '401':
18017           description: Authentication Failed
18018           content:
18019             application/vnd.api+json:
18020               examples:
18021                 Example:
18022                   value:
18023                     error: The access token is invalid
18024               schema:
18025                 "$ref": "#/components/schemas/error"
18026     post:
18027       summary: Create a Zone
18028       tags:
18029       - Zones
18030       security:
18031       - bearer_auth: []
18032       description: Creates a Zone
18033       operationId: create-zone
18034       parameters:
18035       - name: include
18036         in: query
18037         description: 'Select which associated resources you would like to fetch, see:
18038           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
18039         example: zone_members
18040         schema:
18041           type: string
18042       responses:
18043         '201':
18044           description: Record created
18045           content:
18046             application/vnd.api+json:
18047               examples:
18048                 Example:
18049                   value:
18050                     data:
18051                       id: '117'
18052                       type: zone
18053                       attributes:
18054                         name: Repellat corrupti laudantium soluta dolorum animi quidem
18055                           reiciendis.
18056                         description: Laudantium tenetur accusamus blanditiis fuga
18057                           totam.
18058                         default_tax: false
18059                         zone_members_count: 0
18060                         created_at: '2022-11-08T19:36:09.930Z'
18061                         updated_at: '2022-11-08T19:36:09.930Z'
18062                         kind: state
18063                       relationships:
18064                         zone_members:
18065                           data: []
18066               schema:
18067                 "$ref": "#/components/schemas/resource"
18068         '422':
18069           description: Invalid request
18070           content:
18071             application/vnd.api+json:
18072               examples:
18073                 Example:
18074                   value:
18075                     error: Name can't be blank
18076                     errors:
18077                       name:
18078                       - can't be blank
18079               schema:
18080                 "$ref": "#/components/schemas/validation_errors"
18081       requestBody:
18082         content:
18083           application/json:
18084             schema:
18085               "$ref": "#/components/schemas/create_zone_params"
18086   "/api/v2/platform/zones/{id}":
18087     get:
18088       summary: Return a Zone
18089       tags:
18090       - Zones
18091       security:
18092       - bearer_auth: []
18093       description: Returns a Zone
18094       operationId: show-zone
18095       parameters:
18096       - name: id
18097         in: path
18098         required: true
18099         schema:
18100           type: string
18101       - name: include
18102         in: query
18103         description: 'Select which associated resources you would like to fetch, see:
18104           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
18105         example: zone_members
18106         schema:
18107           type: string
18108       responses:
18109         '200':
18110           description: Record found
18111           content:
18112             application/vnd.api+json:
18113               examples:
18114                 Example:
18115                   value:
18116                     data:
18117                       id: '118'
18118                       type: zone
18119                       attributes:
18120                         name: Molestiae esse ab labore ratione nemo.
18121                         description: Impedit vitae in modi quaerat qui quod quia.
18122                         default_tax: false
18123                         zone_members_count: 0
18124                         created_at: '2022-11-08T19:36:10.198Z'
18125                         updated_at: '2022-11-08T19:36:10.198Z'
18126                         kind: state
18127                       relationships:
18128                         zone_members:
18129                           data: []
18130               schema:
18131                 "$ref": "#/components/schemas/resource"
18132         '404':
18133           description: Record not found
18134           content:
18135             application/vnd.api+json:
18136               examples:
18137                 Example:
18138                   value:
18139                     error: The resource you were looking for could not be found.
18140               schema:
18141                 "$ref": "#/components/schemas/error"
18142         '401':
18143           description: Authentication Failed
18144           content:
18145             application/vnd.api+json:
18146               examples:
18147                 Example:
18148                   value:
18149                     error: The access token is invalid
18150               schema:
18151                 "$ref": "#/components/schemas/error"
18152     patch:
18153       summary: Update a Zone
18154       tags:
18155       - Zones
18156       security:
18157       - bearer_auth: []
18158       description: Updates a Zone
18159       operationId: update-zone
18160       parameters:
18161       - name: id
18162         in: path
18163         required: true
18164         schema:
18165           type: string
18166       - name: include
18167         in: query
18168         description: 'Select which associated resources you would like to fetch, see:
18169           <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
18170         example: zone_members
18171         schema:
18172           type: string
18173       responses:
18174         '200':
18175           description: Record updated
18176           content:
18177             application/vnd.api+json:
18178               examples:
18179                 Example:
18180                   value:
18181                     data:
18182                       id: '120'
18183                       type: zone
18184                       attributes:
18185                         name: EU
18186                         description: The zone containing all EU countries
18187                         default_tax: false
18188                         zone_members_count: 0
18189                         created_at: '2022-11-08T19:36:10.716Z'
18190                         updated_at: '2022-11-08T19:36:10.945Z'
18191                         kind: state
18192                       relationships:
18193                         zone_members:
18194                           data: []
18195               schema:
18196                 "$ref": "#/components/schemas/resource"
18197         '422':
18198           description: Invalid request
18199           content:
18200             application/vnd.api+json:
18201               examples:
18202                 Example:
18203                   value:
18204                     error: Name can't be blank
18205                     errors:
18206                       name:
18207                       - can't be blank
18208               schema:
18209                 "$ref": "#/components/schemas/validation_errors"
18210         '404':
18211           description: Record not found
18212           content:
18213             application/vnd.api+json:
18214               examples:
18215                 Example:
18216                   value:
18217                     error: The resource you were looking for could not be found.
18218               schema:
18219                 "$ref": "#/components/schemas/error"
18220         '401':
18221           description: Authentication Failed
18222           content:
18223             application/vnd.api+json:
18224               examples:
18225                 Example:
18226                   value:
18227                     error: The access token is invalid
18228               schema:
18229                 "$ref": "#/components/schemas/error"
18230       requestBody:
18231         content:
18232           application/json:
18233             schema:
18234               "$ref": "#/components/schemas/update_zone_params"
18235     delete:
18236       summary: Delete a Zone
18237       tags:
18238       - Zones
18239       security:
18240       - bearer_auth: []
18241       description: Deletes a Zone
18242       operationId: delete-zone
18243       parameters:
18244       - name: id
18245         in: path
18246         required: true
18247         schema:
18248           type: string
18249       responses:
18250         '204':
18251           description: Record deleted
18252         '404':
18253           description: Record not found
18254           content:
18255             application/vnd.api+json:
18256               examples:
18257                 Example:
18258                   value:
18259                     error: The resource you were looking for could not be found.
18260               schema:
18261                 "$ref": "#/components/schemas/error"
18262         '401':
18263           description: Authentication Failed
18264           content:
18265             application/vnd.api+json:
18266               examples:
18267                 Example:
18268                   value:
18269                     error: The access token is invalid
18270               schema:
18271                 "$ref": "#/components/schemas/error"
18272 servers:
18273 - url: http://{defaultHost}
18274   variables:
18275     defaultHost:
18276       default: localhost:3000
18277 tags:
18278 - name: Addresses
18279 - name: Adjustments
18280 - name: Classifications
18281 - name: Countries
18282 - name: CMS Pages
18283 - name: CMS Sections
18284 - name: Digital Assets
18285 - name: Digital Links
18286 - name: Line Items
18287 - name: Menus
18288 - name: Menu Items
18289 - name: Option Types
18290 - name: Option Values
18291 - name: Orders
18292 - name: Payments
18293 - name: Payment Methods
18294 - name: Products
18295 - name: Promotions
18296 - name: Promotion Actions
18297 - name: Promotion Categories
18298 - name: Promotion Rules
18299 - name: Roles
18300 - name: Shipments
18301 - name: Shipping Categories
18302 - name: Shipping Methods
18303 - name: States
18304 - name: Stock Items
18305 - name: Stock Locations
18306 - name: Store Credit Categories
18307 - name: Store Credit Types
18308 - name: Store Credits
18309 - name: Tax Categories
18310 - name: Tax Rates
18311 - name: Taxons
18312 - name: Taxonomies
18313 - name: Users
18314 - name: Variants
18315 - name: Vendors
18316 - name: Webhook Events
18317 - name: Webhook Subscribers
18318 - name: Wishlists
18319 - name: Wished Items
18320 - name: Zones
18321 components:
18322   securitySchemes:
18323     bearer_auth:
18324       type: http
18325       scheme: bearer
18326   schemas:
18327     create_address_params:
18328       type: object
18329       properties:
18330         address:
18331           type: object
18332           required:
18333           - country_id
18334           - address1
18335           - city
18336           - zipcode
18337           - phone
18338           - firstname
18339           - lastname
18340           properties:
18341             country_id:
18342               type: string
18343               example: '224'
18344             state_id:
18345               type: string
18346               example: '516'
18347             state_name:
18348               type: string
18349               example: New York
18350             address1:
18351               type: string
18352               example: 5th ave
18353             address2:
18354               type: string
18355               example: 1st suite
18356             city:
18357               type: string
18358               example: NY
18359             zipcode:
18360               type: string
18361               example: '10001'
18362             phone:
18363               type: string
18364               example: "+1 123 456 789"
18365             alternative_phone:
18366               type: string
18367             firstname:
18368               type: string
18369               example: John
18370             lastname:
18371               type: string
18372               example: Snow
18373             label:
18374               type: string
18375               example: My home address
18376             company:
18377               type: string
18378               example: Vendo Connect Inc
18379             user_id:
18380               type: string
18381             public_metadata:
18382               type: object
18383               example:
18384                 distance_from_nearest_city_in_km: 10
18385                 location_type: building
18386             private_metadata:
18387               type: object
18388               example:
18389                 close_to_shop: true
18390       required:
18391       - address
18392       x-internal: false
18393     update_address_params:
18394       type: object
18395       properties:
18396         address:
18397           type: object
18398           properties:
18399             country_id:
18400               type: string
18401               example: '224'
18402             state_id:
18403               type: string
18404               example: '516'
18405             state_name:
18406               type: string
18407               example: New York
18408             address1:
18409               type: string
18410               example: 5th ave
18411             address2:
18412               type: string
18413               example: 1st suite
18414             city:
18415               type: string
18416               example: NY
18417             zipcode:
18418               type: string
18419               example: '10001'
18420             phone:
18421               type: string
18422               example: "+1 123 456 789"
18423             alternative_phone:
18424               type: string
18425             firstname:
18426               type: string
18427               example: John
18428             lastname:
18429               type: string
18430               example: Snow
18431             label:
18432               type: string
18433               example: My home address
18434             company:
18435               type: string
18436               example: Vendo Connect Inc
18437             user_id:
18438               type: string
18439             public_metadata:
18440               type: object
18441               example:
18442                 distance_from_city_in_km: 10
18443                 location_type: building
18444             private_metadata:
18445               type: object
18446               example:
18447                 close_to_shop: true
18448       required:
18449       - address
18450       x-internal: false
18451     create_adjustment_params:
18452       type: object
18453       properties:
18454         adjustment:
18455           type: object
18456           required:
18457           - order_id
18458           - label
18459           - adjustable_id
18460           - adjustable_type
18461           properties:
18462             order_id:
18463               type: string
18464             label:
18465               type: string
18466               example: Shipping costs
18467             adjustable_id:
18468               type: string
18469             adjustable_type:
18470               type: string
18471               example: Spree::LineItem
18472             source_id:
18473               type: string
18474             source_type:
18475               type: string
18476               example: Spree::TaxRate
18477             amount:
18478               type: number
18479               example: 10.9
18480             mandatory:
18481               type: boolean
18482             eligible:
18483               type: boolean
18484             state:
18485               type: string
18486               example: closed
18487               default: open
18488               enum:
18489               - closed
18490               - open
18491             included:
18492               type: boolean
18493               example: true
18494               default: false
18495       required:
18496       - adjustment
18497       x-internal: false
18498     update_adjustment_params:
18499       type: object
18500       properties:
18501         adjustment:
18502           type: object
18503           properties:
18504             order_id:
18505               type: string
18506             label:
18507               type: string
18508               example: Shipping costs
18509             adjustable_id:
18510               type: string
18511             adjustable_type:
18512               type: string
18513               example: Spree::LineItem
18514             source_id:
18515               type: string
18516             source_type:
18517               type: string
18518               example: Spree::TaxRate
18519             amount:
18520               type: number
18521               example: 10.9
18522             mandatory:
18523               type: boolean
18524             eligible:
18525               type: boolean
18526             state:
18527               type: string
18528               example: closed
18529               default: open
18530               enum:
18531               - closed
18532               - open
18533             included:
18534               type: boolean
18535               example: true
18536               default: false
18537       required:
18538       - adjustment
18539       x-internal: false
18540     create_classification_params:
18541       type: object
18542       properties:
18543         classification:
18544           type: object
18545           required:
18546           - product_id
18547           - taxon_id
18548           - position
18549           properties:
18550             product_id:
18551               type: string
18552               example: '1'
18553             taxon_id:
18554               type: string
18555               example: '1'
18556             position:
18557               type: integer
18558               example: 1
18559       required:
18560       - classification
18561       x-internal: false
18562     update_classification_params:
18563       type: object
18564       properties:
18565         classification:
18566           type: object
18567           properties:
18568             product_id:
18569               type: string
18570               example: '1'
18571             taxon_id:
18572               type: string
18573               example: '1'
18574             position:
18575               type: integer
18576               example: 1
18577       required:
18578       - classification
18579       x-internal: false
18580     create_standard_cms_page_params:
18581       type: object
18582       properties:
18583         cms_page:
18584           type: object
18585           required:
18586           - title
18587           - locale
18588           - type
18589           properties:
18590             title:
18591               type: string
18592               example: About Us
18593               description: Give your page a title.
18594             type:
18595               type: string
18596               enum:
18597               - Spree::Cms::Pages::StandardPage
18598               description: Set the type of page.
18599             meta_title:
18600               type: string
18601               nullable: true
18602               example: Learn More About Super-Shop
18603               description: Set the meta title for this page, this appears in the title
18604                 bar of the browser.
18605             content:
18606               type: string
18607               nullable: true
18608               example: Lot's of text..
18609               description: The text content of a standard page, this can be HTML from
18610                 a rich text editor.
18611             meta_description:
18612               type: string
18613               nullable: true
18614               example: Learn more about us on this page here...
18615               description: Set a meta description, used for SEO and displayed in search
18616                 results.
18617             visible:
18618               type: boolean
18619               enum:
18620               - true
18621               - false
18622               description: This page is publicly visible when set to `true`.
18623             slug:
18624               type: string
18625               nullable: true
18626               example: about-us
18627               description: Set a slug for this page.
18628             locale:
18629               type: string
18630               example: en-US
18631               description: The language this page is written in.
18632       required:
18633       - cms_page
18634       title: Create a Standard Page
18635       x-internal: false
18636     create_homepage_cms_page_params:
18637       type: object
18638       properties:
18639         cms_page:
18640           type: object
18641           required:
18642           - title
18643           - locale
18644           - type
18645           properties:
18646             title:
18647               type: string
18648               example: Our Flash Homepage
18649               description: Give your page a title.
18650             type:
18651               type: string
18652               enum:
18653               - Spree::Cms::Pages::Homepage
18654               description: Set the type of page.
18655             meta_title:
18656               type: string
18657               nullable: true
18658               example: Visit Our Store - Great Deals
18659               description: Set the meta title for this page, this appears in the title
18660                 bar of the browser.
18661             meta_description:
18662               type: string
18663               nullable: true
18664               example: Discover great new products that we sell in this store...
18665               description: Set a meta description, used for SEO and displayed in search
18666                 results.
18667             visible:
18668               type: boolean
18669               enum:
18670               - true
18671               - false
18672               description: This page is publicly visible when set to `true`.
18673             locale:
18674               type: string
18675               example: en-US
18676               description: The language this page is written in.
18677       required:
18678       - cms_page
18679       title: Create a Homepage
18680       x-internal: false
18681     create_feature_cms_page_params:
18682       type: object
18683       properties:
18684         cms_page:
18685           type: object
18686           required:
18687           - title
18688           - locale
18689           - type
18690           properties:
18691             title:
18692               type: string
18693               example: Featured Product
18694               description: Give your page a title.
18695             type:
18696               type: string
18697               enum:
18698               - Spree::Cms::Pages::FeaturePage
18699               description: Set the type of page.
18700             meta_title:
18701               type: string
18702               nullable: true
18703               example: Learn More About This Featured Product
18704               description: Set the meta title for this page, this appears in the title
18705                 bar of the browser.
18706             meta_description:
18707               type: string
18708               nullable: true
18709               example: Learn more about us this amazing product that we sell right
18710                 here...
18711               description: Set a meta description, used for SEO and displayed in search
18712                 results.
18713             visible:
18714               type: boolean
18715               enum:
18716               - true
18717               - false
18718               description: This page is publicly visible when set to `true`.
18719             slug:
18720               type: string
18721               nullable: true
18722               example: about-us
18723               description: Set a slug for this page.
18724             locale:
18725               type: string
18726               example: en-US
18727               description: The language this page is written in.
18728       required:
18729       - cms_page
18730       title: Create a Feature Page
18731       x-internal: false
18732     update_standard_cms_page_params:
18733       type: object
18734       properties:
18735         cms_page:
18736           type: object
18737           properties:
18738             title:
18739               type: string
18740               example: About Us
18741               description: Update the page title.
18742             type:
18743               type: string
18744               enum:
18745               - Spree::Cms::Pages::StandardPage
18746               - Spree::Cms::Pages::Homepage
18747               - Spree::Cms::Pages::FeaturePage
18748               description: Change the type of page.
18749             meta_title:
18750               type: string
18751               nullable: true
18752               example: Learn More About Super-Shop
18753               description: Update the meta title for this page, this appears in the
18754                 title bar of the browser.
18755             content:
18756               type: string
18757               nullable: true
18758               example: Lot's of text..
18759               description: Update the text content of a standard page, this can be
18760                 HTML from a rich text editor.
18761             meta_description:
18762               type: string
18763               nullable: true
18764               example: Learn more about us on this page here...
18765               description: Update the meta description, used for SEO and displayed
18766                 in search results.
18767             visible:
18768               type: boolean
18769               enum:
18770               - true
18771               - false
18772               description: This page is publicly visible when set to `true`.
18773             slug:
18774               type: string
18775               nullable: true
18776               example: about-us
18777               description: Update the slug for this page.
18778             locale:
18779               type: string
18780               example: en-US
18781               description: Update the language of this page.
18782       required:
18783       - cms_page
18784       title: Update a Standard Page
18785       x-internal: false
18786     update_homepage_cms_page_params:
18787       type: object
18788       properties:
18789         cms_page:
18790           type: object
18791           properties:
18792             title:
18793               type: string
18794               example: Our Flash Homepage
18795               description: Update the page title.
18796             type:
18797               type: string
18798               enum:
18799               - Spree::Cms::Pages::StandardPage
18800               - Spree::Cms::Pages::Homepage
18801               - Spree::Cms::Pages::FeaturePage
18802               description: Change the type of page.
18803             meta_title:
18804               type: string
18805               nullable: true
18806               example: Visit Our Store - Great Deals
18807               description: Update the meta title for this page, this appears in the
18808                 title bar of the browser.
18809             meta_description:
18810               type: string
18811               nullable: true
18812               example: Discover great new products that we sell in this store...
18813               description: Update the meta description, used for SEO and displayed
18814                 in search results.
18815             visible:
18816               type: boolean
18817               enum:
18818               - true
18819               - false
18820               description: This page is publicly visible when set to `true`.
18821             locale:
18822               type: string
18823               example: en-US
18824               description: Update the language of this page.
18825       required:
18826       - cms_page
18827       title: Update a Homepage
18828       x-internal: false
18829     update_feature_cms_page_params:
18830       type: object
18831       properties:
18832         cms_page:
18833           type: object
18834           properties:
18835             title:
18836               type: string
18837               example: Featured Product
18838               description: Update the page title.
18839             type:
18840               type: string
18841               enum:
18842               - Spree::Cms::Pages::StandardPage
18843               - Spree::Cms::Pages::Homepage
18844               - Spree::Cms::Pages::FeaturePage
18845               description: Change the type of page.
18846             meta_title:
18847               type: string
18848               nullable: true
18849               example: Learn More About This Featured Product
18850               description: Update the meta title for this page, this appears in the
18851                 title bar of the browser.
18852             meta_description:
18853               type: string
18854               nullable: true
18855               example: Learn more about us this amazing product that we sell right
18856                 here...
18857               description: Update the meta description, used for SEO and displayed
18858                 in search results.
18859             visible:
18860               type: boolean
18861               enum:
18862               - true
18863               - false
18864               description: This page is publicly visible when set to `true`.
18865             slug:
18866               type: string
18867               nullable: true
18868               example: about-us
18869               description: Update the slug for this page.
18870             locale:
18871               type: string
18872               example: en-US
18873               description: Update the language of this page.
18874       required:
18875       - cms_page
18876       title: Update a Feature Page
18877       x-internal: false
18878     create_hero_image_cms_section_params:
18879       type: object
18880       properties:
18881         cms_section:
18882           type: object
18883           required:
18884           - name
18885           - cms_page_id
18886           - type
18887           properties:
18888             name:
18889               type: string
18890               description: Give this section a name.
18891             cms_page_id:
18892               type: string
18893               description: Set the `cms_page` ID that this section belongs to.
18894             type:
18895               type: string
18896               enum:
18897               - Spree::Cms::Sections::HeroImage
18898               example: Spree::Cms::Sections::HeroImage
18899               description: Set the section type.
18900             linked_resource_type:
18901               type: string
18902               example: Spree::Taxon
18903               nullable: true
18904               enum:
18905               - Spree::Taxon
18906               - Spree::Product
18907               - Spree::CmsPage
18908               description: Set the resource type that this section links to.
18909             linked_resource_id:
18910               type: string
18911               example: '1'
18912               nullable: true
18913               description: Set the ID of the resource that you would like this section
18914                 to link to.
18915             fit:
18916               type: string
18917               example: Screen
18918               enum:
18919               - Screen
18920               - Container
18921               description: This value is used by front end developers to set CSS classes
18922                 for content that fits the screen edge-to-edge, or stays within the
18923                 boundaries of the central container.
18924             position:
18925               type: integer
18926               example: 2
18927               description: 'Pass the position that you want this section to appear
18928                 in. (The list is not zero indexed, so the first item is position:
18929                 `1`)'
18930             gutters:
18931               type: string
18932               example: No Gutters
18933               enum:
18934               - Gutters
18935               - No Gutters
18936               description: This value is used by front end developers for styling
18937                 the section padding.
18938             button_text:
18939               type: string
18940               example: Click Here
18941               description: Set the text value of the button used in this section.
18942             title:
18943               type: string
18944               example: Shop Today
18945               description: Create a title for the Hero Section.
18946             cms_section[image_one]:
18947               type: string
18948               format: binary
18949               description: Use a `multipart/form-data` request to upload assets.
18950       required:
18951       - cms_section
18952       title: Create a Hero Image Section
18953       x-internal: false
18954     create_product_carousel_cms_section_params:
18955       type: object
18956       properties:
18957         cms_section:
18958           type: object
18959           required:
18960           - name
18961           - cms_page_id
18962           - type
18963           properties:
18964             name:
18965               type: string
18966               description: Give this section a name.
18967             cms_page_id:
18968               type: string
18969               description: Set the `cms_page` ID that this section belongs to.
18970             type:
18971               type: string
18972               enum:
18973               - Spree::Cms::Sections::ProductCarousel
18974               example: Spree::Cms::Sections::ProductCarousel
18975               description: Set the section type.
18976             position:
18977               type: integer
18978               example: 2
18979               description: 'Pass the position that you want this section to appear
18980                 in. (The list is not zero indexed, so the first item is position:
18981                 `1`)'
18982             linked_resource_id:
18983               type: string
18984               example: '1'
18985               nullable: true
18986               description: Set the ID of the Taxon that you would like displayed as
18987                 a Product Carousel.
18988       required:
18989       - cms_section
18990       title: Create a Product Carousel Section
18991       x-internal: false
18992     create_side_by_side_images_cms_section_params:
18993       type: object
18994       properties:
18995         cms_section:
18996           type: object
18997           required:
18998           - name
18999           - cms_page_id
19000           - type
19001           properties:
19002             name:
19003               type: string
19004               description: Give this section a name.
19005             cms_page_id:
19006               type: string
19007               description: Set the `cms_page` ID that this section belongs to.
19008             type:
19009               type: string
19010               enum:
19011               - Spree::Cms::Sections::SideBySideImages
19012               example: Spree::Cms::Sections::SideBySideImages
19013               description: Set the section type.
19014             position:
19015               type: integer
19016               example: 2
19017               description: 'Pass the position that you want this section to appear
19018                 in. (The list is not zero indexed, so the first item is position:
19019                 `1`)'
19020             link_type_one:
19021               type: string
19022               example: Spree::Taxon
19023               enum:
19024               - Spree::Taxon
19025               - Spree::Product
19026               description: Set the resource type that image one links to.
19027             link_type_two:
19028               type: string
19029               example: Spree::Taxon
19030               enum:
19031               - Spree::Taxon
19032               - Spree::Product
19033               description: Set the resource type that image two links to.
19034             link_one:
19035               type: string
19036               example: men/shirts
19037               nullable: true
19038               description: Set the slug or path that image two links to.
19039             link_two:
19040               type: string
19041               example: white-shirt
19042               nullable: true
19043               description: Set the slug or path that image two links to.
19044             title_one:
19045               type: string
19046               example: Shop Men's Shirts
19047               nullable: true
19048               description: Set the title used in image one.
19049             title_two:
19050               type: string
19051               example: Buy This Men's Shirt
19052               nullable: true
19053               description: Set the title used in image two.
19054             fit:
19055               type: string
19056               example: Screen
19057               enum:
19058               - Screen
19059               - Container
19060               description: This value is used by front end developers to set CSS classes
19061                 for content that fits the screen edge-to-edge, or stays within the
19062                 boundaries of the central container.
19063             subtitle_one:
19064               type: string
19065               example: Save 50% today
19066               nullable: true
19067               description: Set the subtitle used in image one.
19068             subtitle_two:
19069               type: string
19070               example: Save 50% today
19071               nullable: true
19072               description: Set the subtitle used in image two.
19073             gutters:
19074               type: string
19075               example: No Gutters
19076               enum:
19077               - Gutters
19078               - No Gutters
19079               description: This value is used by front end developers for styling
19080                 the section padding.
19081             cms_section[image_one]:
19082               type: string
19083               format: binary
19084               description: Use a `multipart/form-data` request to upload assets.
19085             cms_section[image_two]:
19086               type: string
19087               format: binary
19088               description: Use a `multipart/form-data` request to upload assets.
19089       required:
19090       - cms_section
19091       title: Create a Side-by-Side Image Section
19092       x-internal: false
19093     create_image_gallery_cms_section_params:
19094       type: object
19095       properties:
19096         cms_section:
19097           type: object
19098           required:
19099           - name
19100           - cms_page_id
19101           - type
19102           properties:
19103             name:
19104               type: string
19105               description: Give this section a name.
19106             cms_page_id:
19107               type: string
19108               description: Set the `cms_page` ID that this section belongs to.
19109             type:
19110               type: string
19111               enum:
19112               - Spree::Cms::Sections::ImageGallery
19113               example: Spree::Cms::Sections::ImageGallery
19114               description: Set the section type.
19115             position:
19116               type: integer
19117               example: 2
19118               description: 'Pass the position that you want this section to appear
19119                 in. (The list is not zero indexed, so the first item is position:
19120                 `1`)'
19121             link_type_one:
19122               type: string
19123               example: Spree::Taxon
19124               enum:
19125               - Spree::Taxon
19126               - Spree::Product
19127               description: Set the resource type that image one links to.
19128             link_type_two:
19129               type: string
19130               example: Spree::Taxon
19131               enum:
19132               - Spree::Taxon
19133               - Spree::Product
19134               description: Set the resource type that image two links to.
19135             link_type_three:
19136               type: string
19137               example: Spree::Taxon
19138               enum:
19139               - Spree::Taxon
19140               - Spree::Product
19141               description: Set the resource type that image three links to.
19142             link_one:
19143               type: string
19144               example: men/shirts
19145               nullable: true
19146               description: Set the slug or path that image two links to.
19147             link_two:
19148               type: string
19149               example: white-shirt
19150               nullable: true
19151               description: Set the slug or path that image two links to.
19152             link_three:
19153               type: string
19154               example: red-shirt
19155               nullable: true
19156               description: Set the slug or path that image three links to.
19157             title_one:
19158               type: string
19159               example: Shop Men's Shirts
19160               nullable: true
19161               description: Set the title used in image one.
19162             title_two:
19163               type: string
19164               example: Buy This Men's Shirt
19165               nullable: true
19166               description: Set the title used in image two.
19167             title_three:
19168               type: string
19169               example: Buy This Women's Skirt
19170               nullable: true
19171               description: Set the title used in image three.
19172             fit:
19173               type: string
19174               example: Screen
19175               enum:
19176               - Screen
19177               - Container
19178               description: This value is used by front end developers to set CSS classes
19179                 for content that fits the screen edge-to-edge, or stays within the
19180                 boundaries of the central container.
19181             layout_style:
19182               type: string
19183               example: Default
19184               enum:
19185               - Default
19186               - Reversed
19187               description: This value is used by front end developers for styling
19188                 the order the images appear.
19189             display_labels:
19190               type: string
19191               example: Show
19192               enum:
19193               - Show
19194               - Hide
19195               description: This value is used by front end developers for showing
19196                 and hiding the label on the images.
19197             cms_section[image_one]:
19198               type: string
19199               format: binary
19200               description: Use a `multipart/form-data` request to upload assets.
19201             cms_section[image_two]:
19202               type: string
19203               format: binary
19204               description: Use a `multipart/form-data` request to upload assets.
19205             cms_section[image_three]:
19206               type: string
19207               format: binary
19208               description: Use a `multipart/form-data` request to upload assets.
19209       required:
19210       - cms_section
19211       title: Create an Image Gallery Section
19212       x-internal: false
19213     create_featured_article_cms_section_params:
19214       type: object
19215       properties:
19216         cms_section:
19217           type: object
19218           required:
19219           - name
19220           - cms_page_id
19221           - type
19222           properties:
19223             name:
19224               type: string
19225               description: Give this section a name.
19226             cms_page_id:
19227               type: string
19228               description: Set the `cms_page` ID that this section belongs to.
19229             type:
19230               type: string
19231               enum:
19232               - Spree::Cms::Sections::FeaturedArticle
19233               example: Spree::Cms::Sections::FeaturedArticle
19234               description: Set the section type.
19235             position:
19236               type: integer
19237               example: 2
19238               description: 'Pass the position that you want this section to appear
19239                 in. (The list is not zero indexed, so the first item is position:
19240                 `1`)'
19241             linked_resource_type:
19242               type: string
19243               example: Spree::Taxon
19244               nullable: true
19245               enum:
19246               - Spree::Taxon
19247               - Spree::Product
19248               - Spree::CmsPage
19249               description: Set the resource type that this section links to.
19250             linked_resource_id:
19251               type: string
19252               example: '1'
19253               nullable: true
19254               description: Set the ID of the resource that you would like this section
19255                 to link to.
19256             fit:
19257               type: string
19258               example: Screen
19259               enum:
19260               - Screen
19261               - Container
19262               description: This value is used by front end developers to set CSS classes
19263                 for content that fits the screen edge-to-edge, or stays within the
19264                 boundaries of the central container.
19265             gutters:
19266               type: string
19267               example: No Gutters
19268               enum:
19269               - Gutters
19270               - No Gutters
19271               description: This value is used by front end developers for styling
19272                 the section padding.
19273             button_text:
19274               type: string
19275               example: Click Here
19276               description: Set the text value of the button used in this section.
19277             title:
19278               type: string
19279               example: Shop Today
19280               description: Create a title for the Section.
19281             subtitle:
19282               type: string
19283               example: Save Big!
19284               description: Create a subtitle for the Section.
19285             rte_content:
19286               type: string
19287               example: Lots of text and content goes here.
19288               description: Set the content, here, this can be rich text editor content.
19289       required:
19290       - cms_section
19291       title: Create a Featured Article Section
19292       x-internal: false
19293     create_rich_text_cms_section_params:
19294       type: object
19295       properties:
19296         cms_section:
19297           type: object
19298           required:
19299           - name
19300           - cms_page_id
19301           - type
19302           properties:
19303             name:
19304               type: string
19305               description: Give this section a name.
19306             cms_page_id:
19307               type: string
19308               description: Set the `cms_page` ID that this section belongs to.
19309             type:
19310               type: string
19311               enum:
19312               - Spree::Cms::Sections::RichTextContent
19313               example: Spree::Cms::Sections::RichTextContent
19314               description: Set the section type.
19315             position:
19316               type: integer
19317               example: 2
19318               description: 'Pass the position that you want this section to appear
19319                 in. (The list is not zero indexed, so the first item is position:
19320                 `1`)'
19321             fit:
19322               type: string
19323               example: Screen
19324               enum:
19325               - Screen
19326               - Container
19327               description: This value is used by front end developers to set CSS classes
19328                 for content that fits the screen edge-to-edge, or stays within the
19329                 boundaries of the central container.
19330             rte_content:
19331               type: string
19332               example: Lots of text and content goes here.
19333               description: Set the content, here, this can be rich text editor content.
19334       required:
19335       - cms_section
19336       title: Create a Rich Text Section
19337       x-internal: false
19338     update_hero_image_cms_section_params:
19339       type: object
19340       properties:
19341         cms_section:
19342           type: object
19343           properties:
19344             name:
19345               type: string
19346               description: Update this section name.
19347             type:
19348               type: string
19349               enum:
19350               - Spree::Cms::Sections::HeroImage
19351               - Spree::Cms::Sections::FeaturedArticle
19352               - Spree::Cms::Sections::ProductCarousel
19353               - Spree::Cms::Sections::ImageGallery
19354               - Spree::Cms::Sections::SideBySideImages
19355               - Spree::Cms::Sections::RichTextContent
19356               example: Spree::Cms::Sections::ProductCarousel
19357               description: Change the section type.
19358             linked_resource_type:
19359               type: string
19360               example: Spree::Taxon
19361               nullable: true
19362               enum:
19363               - Spree::Taxon
19364               - Spree::Product
19365               - Spree::CmsPage
19366               description: Update the resource type that this section links to.
19367             linked_resource_id:
19368               type: string
19369               example: '1'
19370               nullable: true
19371               description: Set the ID of the resource that you would like this section
19372                 to link to.
19373             fit:
19374               type: string
19375               example: Screen
19376               enum:
19377               - Screen
19378               - Container
19379               description: This value is used by front end developers to set CSS classes
19380                 for content that fits the screen edge-to-edge, or stays within the
19381                 boundaries of the central container.
19382             position:
19383               type: integer
19384               example: 2
19385               description: 'Pass the position that you want this section to appear
19386                 in. (The list is not zero indexed, so the first item is position:
19387                 `1`)'
19388             gutters:
19389               type: string
19390               example: No Gutters
19391               enum:
19392               - Gutters
19393               - No Gutters
19394               description: This value is used by front end developers for styling
19395                 the section padding.
19396             button_text:
19397               type: string
19398               example: Click Here
19399               description: Update the text value of the button used in this section.
19400             title:
19401               type: string
19402               example: Shop Today
19403               description: Update the title for this section.
19404             cms_section[image_one]:
19405               type: string
19406               format: binary
19407               description: Use a `multipart/form-data` request to upload assets.
19408       required:
19409       - cms_section
19410       title: Update a Hero Image Section
19411       x-internal: false
19412     update_product_carousel_cms_section_params:
19413       type: object
19414       properties:
19415         cms_section:
19416           type: object
19417           properties:
19418             name:
19419               type: string
19420               description: Change this section name.
19421             type:
19422               type: string
19423               enum:
19424               - Spree::Cms::Sections::HeroImage
19425               - Spree::Cms::Sections::FeaturedArticle
19426               - Spree::Cms::Sections::ProductCarousel
19427               - Spree::Cms::Sections::ImageGallery
19428               - Spree::Cms::Sections::SideBySideImages
19429               - Spree::Cms::Sections::RichTextContent
19430               example: Spree::Cms::Sections::ProductCarousel
19431               description: Change the section type.
19432             position:
19433               type: integer
19434               example: 2
19435               description: 'Pass the position that you want this section to appear
19436                 in. (The list is not zero indexed, so the first item is position:
19437                 `1`)'
19438             linked_resource_id:
19439               type: string
19440               example: '1'
19441               nullable: true
19442               description: Update the ID of the Taxon that you would like displayed
19443                 as a Product Carousel.
19444       required:
19445       - cms_section
19446       title: Update a Product Carousel Section
19447       x-internal: false
19448     update_side_by_side_images_cms_section_params:
19449       type: object
19450       properties:
19451         cms_section:
19452           type: object
19453           properties:
19454             name:
19455               type: string
19456               description: Update this section name.
19457             type:
19458               type: string
19459               enum:
19460               - Spree::Cms::Sections::HeroImage
19461               - Spree::Cms::Sections::FeaturedArticle
19462               - Spree::Cms::Sections::ProductCarousel
19463               - Spree::Cms::Sections::ImageGallery
19464               - Spree::Cms::Sections::SideBySideImages
19465               - Spree::Cms::Sections::RichTextContent
19466               example: Spree::Cms::Sections::ProductCarousel
19467               description: Change the section type.
19468             position:
19469               type: integer
19470               example: 2
19471               description: 'Pass the position that you want this section to appear
19472                 in. (The list is not zero indexed, so the first item is position:
19473                 `1`)'
19474             link_type_one:
19475               type: string
19476               example: Spree::Taxon
19477               enum:
19478               - Spree::Taxon
19479               - Spree::Product
19480               description: Update the resource type that image one links to.
19481             link_type_two:
19482               type: string
19483               example: Spree::Taxon
19484               enum:
19485               - Spree::Taxon
19486               - Spree::Product
19487               description: Update the resource type that image two links to.
19488             link_one:
19489               type: string
19490               example: men/shirts
19491               nullable: true
19492               description: Update the slug or path that image two links to.
19493             link_two:
19494               type: string
19495               example: white-shirt
19496               nullable: true
19497               description: Update the slug or path that image two links to.
19498             title_one:
19499               type: string
19500               example: Shop Men's Shirts
19501               nullable: true
19502               description: Update the title used in image one.
19503             title_two:
19504               type: string
19505               example: Buy This Men's Shirt
19506               nullable: true
19507               description: Update the title used in image two.
19508             fit:
19509               type: string
19510               example: Screen
19511               enum:
19512               - Screen
19513               - Container
19514               description: This value is used by front end developers to set CSS classes
19515                 for content that fits the screen edge-to-edge, or stays within the
19516                 boundaries of the central container.
19517             subtitle_one:
19518               type: string
19519               example: Save 50% today
19520               nullable: true
19521               description: Update the subtitle used in image one.
19522             subtitle_two:
19523               type: string
19524               example: Save 50% today
19525               nullable: true
19526               description: Update the subtitle used in image two.
19527             gutters:
19528               type: string
19529               example: No Gutters
19530               enum:
19531               - Gutters
19532               - No Gutters
19533               description: This value is used by front end developers for styling
19534                 the section padding.
19535             cms_section[image_one]:
19536               type: string
19537               format: binary
19538               description: Use a `multipart/form-data` request to upload assets.
19539             cms_section[image_two]:
19540               type: string
19541               format: binary
19542               description: Use a `multipart/form-data` request to upload assets.
19543       required:
19544       - cms_section
19545       title: Update a Side-by-Side Image Section
19546       x-internal: false
19547     update_image_gallery_cms_section_params:
19548       type: object
19549       properties:
19550         cms_section:
19551           type: object
19552           properties:
19553             name:
19554               type: string
19555               description: Update this section name.
19556             type:
19557               type: string
19558               enum:
19559               - Spree::Cms::Sections::HeroImage
19560               - Spree::Cms::Sections::FeaturedArticle
19561               - Spree::Cms::Sections::ProductCarousel
19562               - Spree::Cms::Sections::ImageGallery
19563               - Spree::Cms::Sections::SideBySideImages
19564               - Spree::Cms::Sections::RichTextContent
19565               example: Spree::Cms::Sections::ProductCarousel
19566               description: Change the section type.
19567             position:
19568               type: integer
19569               example: 2
19570               description: 'Pass the position that you want this section to appear
19571                 in. (The list is not zero indexed, so the first item is position:
19572                 `1`)'
19573             link_type_one:
19574               type: string
19575               example: Spree::Taxon
19576               enum:
19577               - Spree::Taxon
19578               - Spree::Product
19579               description: Update the resource type that image one links to.
19580             link_type_two:
19581               type: string
19582               example: Spree::Taxon
19583               enum:
19584               - Spree::Taxon
19585               - Spree::Product
19586               description: Update the resource type that image two links to.
19587             link_type_three:
19588               type: string
19589               example: Spree::Taxon
19590               enum:
19591               - Spree::Taxon
19592               - Spree::Product
19593               description: Update the resource type that image three links to.
19594             link_one:
19595               type: string
19596               example: men/shirts
19597               nullable: true
19598               description: Update the slug or path that image two links to.
19599             link_two:
19600               type: string
19601               example: white-shirt
19602               nullable: true
19603               description: Update the slug or path that image two links to.
19604             link_three:
19605               type: string
19606               example: red-shirt
19607               nullable: true
19608               description: Update the slug or path that image three links to.
19609             title_one:
19610               type: string
19611               example: Shop Men's Shirts
19612               nullable: true
19613               description: Update the title used in image one.
19614             title_two:
19615               type: string
19616               example: Buy This Men's Shirt
19617               nullable: true
19618               description: Update the title used in image two.
19619             title_three:
19620               type: string
19621               example: Buy This Women's Skirt
19622               nullable: true
19623               description: Update the title used in image three.
19624             fit:
19625               type: string
19626               example: Screen
19627               enum:
19628               - Screen
19629               - Container
19630               description: This value is used by front end developers to set CSS classes
19631                 for content that fits the screen edge-to-edge, or stays within the
19632                 boundaries of the central container.
19633             layout_style:
19634               type: string
19635               example: Default
19636               enum:
19637               - Default
19638               - Reversed
19639               description: This value is used by front end developers for styling
19640                 the order the images appear.
19641             display_labels:
19642               type: string
19643               example: Show
19644               enum:
19645               - Show
19646               - Hide
19647               description: This value is used by front end developers for showing
19648                 and hiding the label on the images.
19649             cms_section[image_one]:
19650               type: string
19651               format: binary
19652               description: Use a `multipart/form-data` request to upload assets.
19653             cms_section[image_two]:
19654               type: string
19655               format: binary
19656               description: Use a `multipart/form-data` request to upload assets.
19657             cms_section[image_three]:
19658               type: string
19659               format: binary
19660               description: Use a `multipart/form-data` request to upload assets.
19661       required:
19662       - cms_section
19663       title: Update an Image Gallery Section
19664       x-internal: false
19665     update_featured_article_cms_section_params:
19666       type: object
19667       properties:
19668         cms_section:
19669           type: object
19670           properties:
19671             name:
19672               type: string
19673               description: Update this section name.
19674             type:
19675               type: string
19676               enum:
19677               - Spree::Cms::Sections::HeroImage
19678               - Spree::Cms::Sections::FeaturedArticle
19679               - Spree::Cms::Sections::ProductCarousel
19680               - Spree::Cms::Sections::ImageGallery
19681               - Spree::Cms::Sections::SideBySideImages
19682               - Spree::Cms::Sections::RichTextContent
19683               example: Spree::Cms::Sections::ProductCarousel
19684               description: Change the section type.
19685             position:
19686               type: integer
19687               example: 2
19688               description: 'Pass the position that you want this section to appear
19689                 in. (The list is not zero indexed, so the first item is position:
19690                 `1`)'
19691             linked_resource_type:
19692               type: string
19693               example: Spree::Taxon
19694               nullable: true
19695               enum:
19696               - Spree::Taxon
19697               - Spree::Product
19698               - Spree::CmsPage
19699               description: Set the resource type that this section links to.
19700             linked_resource_id:
19701               type: string
19702               example: '1'
19703               nullable: true
19704               description: Change the ID of the resource that you would like this
19705                 section to link to.
19706             fit:
19707               type: string
19708               example: Screen
19709               enum:
19710               - Screen
19711               - Container
19712               description: This value is used by front end developers to set CSS classes
19713                 for content that fits the screen edge-to-edge, or stays within the
19714                 boundaries of the central container.
19715             gutters:
19716               type: string
19717               example: No Gutters
19718               enum:
19719               - Gutters
19720               - No Gutters
19721               description: This value is used by front end developers for styling
19722                 the section padding.
19723             button_text:
19724               type: string
19725               example: Click Here
19726               description: Update the text value of the button used in this section.
19727             title:
19728               type: string
19729               example: Shop Today
19730               description: Update the title for the Section.
19731             subtitle:
19732               type: string
19733               example: Save Big!
19734               description: Update the subtitle for the Section.
19735             rte_content:
19736               type: string
19737               example: Lots of text and content goes here.
19738               description: Update the content here, this can be rich text editor content.
19739       required:
19740       - cms_section
19741       title: Update a Featured Article Section
19742       x-internal: false
19743     update_rich_text_cms_section_params:
19744       type: object
19745       properties:
19746         cms_section:
19747           type: object
19748           properties:
19749             name:
19750               type: string
19751               description: Update this section name.
19752             type:
19753               type: string
19754               enum:
19755               - Spree::Cms::Sections::HeroImage
19756               - Spree::Cms::Sections::FeaturedArticle
19757               - Spree::Cms::Sections::ProductCarousel
19758               - Spree::Cms::Sections::ImageGallery
19759               - Spree::Cms::Sections::SideBySideImages
19760               - Spree::Cms::Sections::RichTextContent
19761               example: Spree::Cms::Sections::ProductCarousel
19762               description: Change the section type.
19763             position:
19764               type: integer
19765               example: 2
19766               description: 'Pass the position that you want this section to appear
19767                 in. (The list is not zero indexed, so the first item is position:
19768                 `1`)'
19769             fit:
19770               type: string
19771               example: Screen
19772               enum:
19773               - Screen
19774               - Container
19775               description: This value is used by front end developers to set CSS classes
19776                 for content that fits the screen edge-to-edge, or stays within the
19777                 boundaries of the central container.
19778             rte_content:
19779               type: string
19780               example: Lots of text and content goes here.
19781               description: Update the content, here, this can be rich text editor
19782                 content.
19783       required:
19784       - cms_section
19785       title: Update a Rich Text Section
19786       x-internal: false
19787     create_data_feed_params:
19788       type: object
19789       properties:
19790         data_feed:
19791           type: object
19792           required:
19793           - name
19794           - type
19795           properties:
19796             name:
19797               type: string
19798               example: 'First data feed'
19799             slug:
19800               type: string
19801               example: 'first-data-feed'
19802             type:
19803               type: string
19804               example: 'Spree::DataFeed::Google'
19805             active:
19806               type: boolean
19807       x-internal: false
19808     update_data_feed_params:
19809       type: object
19810       properties:
19811         data_feed:
19812           type: object
19813           required:
19814             - name
19815             - type
19816           properties:
19817             name:
19818               type: string
19819               example: 'First data feed'
19820             slug:
19821               type: string
19822               example: 'first-data-feed'
19823             type:
19824               type: string
19825               example: 'Spree::DataFeed::Google'
19826             active:
19827               type: boolean
19828       x-internal: false
19829     create_digital_params:
19830       type: object
19831       properties:
19832         digital[attachment]:
19833           type: string
19834           format: binary
19835         digital[variant_id]:
19836           type: string
19837           example: '123'
19838       required:
19839       - digital[attachment]
19840       - digital[variant_id]
19841       x-internal: false
19842     update_digital_params:
19843       type: object
19844       properties:
19845         digital[attachment]:
19846           type: string
19847           format: binary
19848         digital[variant_id]:
19849           type: string
19850           example: '123'
19851       required:
19852       - digital[attachment]
19853       - digital[variant_id]
19854       x-internal: false
19855     create_digital_link_params:
19856       type: object
19857       properties:
19858         digital_link:
19859           type: object
19860           required:
19861           - line_item_id
19862           - digital_id
19863           properties:
19864             access_counter:
19865               type: integer
19866               example: 0
19867             line_item_id:
19868               type: string
19869               example: '1'
19870             digital_id:
19871               type: string
19872               example: '1'
19873       required:
19874       - digital_link
19875       x-internal: false
19876     update_digital_link_params:
19877       type: object
19878       properties:
19879         digital_link:
19880           type: object
19881           properties:
19882             access_counter:
19883               type: integer
19884               example: 0
19885             line_item_id:
19886               type: string
19887               example: '1'
19888             digital_id:
19889               type: string
19890               example: '1'
19891       required:
19892       - digital_link
19893       x-internal: false
19894     create_line_item_params:
19895       type: object
19896       properties:
19897         line_item:
19898           type: object
19899           required:
19900           - order_id
19901           - variant_id
19902           - quantity
19903           properties:
19904             order_id:
19905               type: string
19906               example: '1'
19907             variant_id:
19908               type: string
19909               example: '1'
19910             quantity:
19911               type: integer
19912               example: 2
19913             public_metadata:
19914               type: object
19915             private_metadata:
19916               type: object
19917       required:
19918       - line_item
19919       x-internal: false
19920     update_line_item_params:
19921       type: object
19922       properties:
19923         line_item:
19924           type: object
19925           properties:
19926             variant_id:
19927               type: string
19928               example: '1'
19929             quantity:
19930               type: integer
19931               example: 2
19932       required:
19933       - line_item
19934       x-internal: false
19935     create_menu_params:
19936       type: object
19937       properties:
19938         menu:
19939           type: object
19940           required:
19941           - name
19942           - location
19943           - locale
19944           properties:
19945             name:
19946               type: string
19947               example: Main Menu
19948               description: Give this Menu a name.
19949             location:
19950               type: string
19951               enum:
19952               - header
19953               - footer
19954               description: Set the location this menu appears in the website.
19955             locale:
19956               type: string
19957               example: en-US
19958               description: Set the language of this menu.
19959       required:
19960       - menu
19961       x-internal: false
19962     update_menu_params:
19963       type: object
19964       properties:
19965         menu:
19966           type: object
19967           properties:
19968             name:
19969               type: string
19970               example: Main Menu
19971               description: Update this Menu name.
19972             location:
19973               type: string
19974               enum:
19975               - header
19976               - footer
19977               description: Update the location this menu appears in the website.
19978             locale:
19979               type: string
19980               example: en-US
19981               description: Change the language of this menu.
19982       required:
19983       - menu
19984       x-internal: false
19985     create_menu_item_params:
19986       type: object
19987       properties:
19988         menu_item:
19989           type: object
19990           required:
19991           - name
19992           - menu_id
19993           properties:
19994             name:
19995               type: string
19996               example: T-Shirts
19997               description: The name of this Menu Item
19998             code:
19999               type: string
20000               nullable: true
20001               example: MEN-TS
20002               description: Give this Menu Item a code to identify this Menu Item from
20003                 others. This is especially useful when using Container type Menu Items
20004                 to group items.
20005             subtitle:
20006               type: string
20007               nullable: true
20008               example: Shop men's T-Shirts
20009               description: Set an optional subtitle for the Menu Item, this is useful
20010                 if your menu has promotional links that require more than just a link
20011                 name.
20012             destination:
20013               type: string
20014               nullable: true
20015               example: https://getvendo.com
20016               description: 'Used when the linked_resource_type is set to: URL'
20017             menu_id:
20018               type: integer
20019               example: 1
20020               description: Specify the ID of the Menu this item belongs to.
20021             new_window:
20022               type: boolean
20023               description: When set to `true` the link will be opened in a new tab
20024                 or window.
20025             item_type:
20026               type: string
20027               enum:
20028               - Link
20029               - Container
20030               description: Links are standard links, where as Containers are used
20031                 to group links.
20032             linked_resource_type:
20033               type: string
20034               enum:
20035               - URL
20036               - Spree::Taxon
20037               - Spree::Product
20038               - Spree::CmsPage
20039               description: 'Set the type of resource you want to link to, or set to:
20040                 URL to use the destination field for an external link.'
20041             linked_resource_id:
20042               type: integer
20043               example: 1
20044               nullable: true
20045               description: The ID of the resource you are linking to.
20046       required:
20047       - menu_item
20048       title: Create a Menu Item
20049       x-internal: false
20050     update_menu_item_params:
20051       type: object
20052       properties:
20053         menu_item:
20054           type: object
20055           properties:
20056             name:
20057               type: string
20058               example: T-Shirts
20059               description: Update the name of this Menu Item
20060             code:
20061               type: string
20062               nullable: true
20063               example: MEN-TS
20064               description: The Menu Item a code to identifies this Menu Item from
20065                 others. This is especially useful when using Container type Menu Items
20066                 to group items.
20067             subtitle:
20068               type: string
20069               nullable: true
20070               example: Shop men's T-Shirts
20071               description: Set an optional subtitle for the Menu Item, this is useful
20072                 if your menu has promotional links that require more than just a link
20073                 name.
20074             destination:
20075               type: string
20076               nullable: true
20077               example: https://getvendo.com
20078               description: 'Used when the linked_resource_type is set to: URL'
20079             menu_id:
20080               type: integer
20081               example: 1
20082               description: Specify the ID of the Menu this item belongs to.
20083             new_window:
20084               type: boolean
20085               description: When set to `true` the link will be opened in a new tab
20086                 or window.
20087             item_type:
20088               type: string
20089               enum:
20090               - Link
20091               - Container
20092               description: Links are standard links, where as Containers are used
20093                 to group links.
20094             linked_resource_type:
20095               type: string
20096               enum:
20097               - URL
20098               - Spree::Taxon
20099               - Spree::Product
20100               - Spree::CmsPage
20101               description: 'Change the type of resource you want to link to, or set
20102                 to: URL to use the destination field for an external link.'
20103             linked_resource_id:
20104               type: integer
20105               example: 1
20106               nullable: true
20107               description: The ID of the resource you are linking to.
20108       required:
20109       - menu_item
20110       title: Update a Menu Item
20111       x-internal: false
20112     menu_item_reposition:
20113       type: object
20114       properties:
20115         menu_item:
20116           type: object
20117           required:
20118           - new_parent_id
20119           - new_position_idx
20120           properties:
20121             new_parent_id:
20122               type: integer
20123               example: 1
20124               description: The ID of the new target parent Menu Item.
20125             new_position_idx:
20126               type: integer
20127               example: 1
20128               description: The new index position of the Menu Item within its parent
20129       required:
20130       - menu_item
20131       title: Reposition a Menu Item
20132       x-internal: false
20133     create_option_type_params:
20134       type: object
20135       properties:
20136         option_type:
20137           type: object
20138           required:
20139           - name
20140           - presentation
20141           properties:
20142             name:
20143               type: string
20144               example: color
20145             presentation:
20146               type: string
20147               example: Color
20148             public_metadata:
20149               type: object
20150             private_metadata:
20151               type: object
20152       required:
20153       - option_type
20154       x-internal: false
20155     update_option_type_params:
20156       type: object
20157       properties:
20158         option_type:
20159           type: object
20160           properties:
20161             name:
20162               type: string
20163               example: color
20164             presentation:
20165               type: string
20166               example: Color
20167             public_metadata:
20168               type: object
20169             private_metadata:
20170               type: object
20171       required:
20172       - option_type
20173       x-internal: false
20174     create_option_value_params:
20175       type: object
20176       properties:
20177         option_value:
20178           type: object
20179           required:
20180           - name
20181           - presentation
20182           properties:
20183             name:
20184               type: string
20185               example: red
20186             presentation:
20187               type: string
20188               example: Red
20189             public_metadata:
20190               type: object
20191             private_metadata:
20192               type: object
20193       required:
20194       - option_value
20195       x-internal: false
20196     update_option_value_params:
20197       type: object
20198       properties:
20199         option_value:
20200           type: object
20201           properties:
20202             name:
20203               type: string
20204               example: red
20205             presentation:
20206               type: string
20207               example: Red
20208             public_metadata:
20209               type: object
20210             private_metadata:
20211               type: object
20212       required:
20213       - option_value
20214       x-internal: false
20215     create_order_params:
20216       type: object
20217       properties:
20218         order:
20219           type: object
20220           properties:
20221             item_total:
20222               type: number
20223               example: 170.9
20224             total:
20225               type: number
20226               example: 190.9
20227             state:
20228               type: string
20229               example: complete
20230               enum:
20231               - cart
20232               - address
20233               - delivery
20234               - payment
20235               - confirm
20236               - complete
20237               - canceled
20238             adjustment_total:
20239               type: number
20240               example: 20.0
20241             user_id:
20242               type: string
20243               example: '1'
20244             completed_at:
20245               type: string
20246               format: date_time
20247               example: 2022-11-08 19:33:50 UTC
20248             bill_address_id:
20249               type: string
20250               example: '1'
20251             ship_address_id:
20252               type: string
20253               example: '1'
20254             payment_total:
20255               type: number
20256               example: 190.9
20257             shipment_state:
20258               type: string
20259               example: shipped
20260               enum:
20261               - backorder
20262               - canceled
20263               - partial
20264               - pending
20265               - ready
20266               - shipped
20267             payment_state:
20268               type: string
20269               example: paid
20270               enum:
20271               - balance_due
20272               - credit_owed
20273               - failed
20274               - paid
20275               - void
20276             email:
20277               type: string
20278               format: email
20279               example: hi@getvendo.com
20280             special_instructions:
20281               type: string
20282               example: I need it ASAP!
20283             currency:
20284               type: string
20285               example: USD
20286             last_ip_address:
20287               type: string
20288               example: 127.0.0.1
20289             created_by_id:
20290               type: string
20291               example: '1'
20292             shipment_total:
20293               type: number
20294               example: 10.0
20295             additional_tax_total:
20296               type: number
20297               example: 10.0
20298             promo_total:
20299               type: number
20300               example: 0.0
20301             channel:
20302               type: string
20303               example: online
20304             included_tax_total:
20305               type: number
20306               example: 0.0
20307             item_count:
20308               type: integer
20309               example: 2
20310             approver_id:
20311               type: string
20312             approved_at:
20313               type: string
20314               format: date_time
20315               example: 2022-11-08 19:33:50 UTC
20316             confirmation_delivered:
20317               type: boolean
20318               example: true
20319               default: false
20320             considered_risky:
20321               type: boolean
20322               example: true
20323               default: false
20324             canceled_at:
20325               type: string
20326               format: date_time
20327             canceler_id:
20328               type: string
20329             taxable_adjustment_total:
20330               type: number
20331               example: 170.9
20332             non_taxable_adjustment_total:
20333               type: number
20334               example: 10.0
20335             store_owner_notification_delivered:
20336               type: boolean
20337               example: true
20338               default: false
20339             bill_address_attributes:
20340               "$ref": "#/components/schemas/update_address_params"
20341             ship_address_attributes:
20342               "$ref": "#/components/schemas/update_address_params"
20343             line_items_attributes:
20344               type: array
20345               items:
20346                 "$ref": "#/components/schemas/update_line_item_params"
20347             public_metadata:
20348               type: object
20349             private_metadata:
20350               type: object
20351       required:
20352       - order
20353       x-internal: false
20354     update_order_params:
20355       type: object
20356       properties:
20357         order:
20358           type: object
20359           properties:
20360             item_total:
20361               type: number
20362               example: 170.9
20363             total:
20364               type: number
20365               example: 190.9
20366             state:
20367               type: string
20368               example: complete
20369               enum:
20370               - cart
20371               - address
20372               - delivery
20373               - payment
20374               - confirm
20375               - complete
20376               - canceled
20377             adjustment_total:
20378               type: number
20379               example: 20.0
20380             user_id:
20381               type: string
20382               example: '1'
20383             completed_at:
20384               type: string
20385               format: date_time
20386               example: 2022-11-08 19:33:50 UTC
20387             bill_address_id:
20388               type: string
20389               example: '1'
20390             ship_address_id:
20391               type: string
20392               example: '1'
20393             payment_total:
20394               type: number
20395               example: 190.9
20396             shipment_state:
20397               type: string
20398               example: shipped
20399               enum:
20400               - backorder
20401               - canceled
20402               - partial
20403               - pending
20404               - ready
20405               - shipped
20406             payment_state:
20407               type: string
20408               example: paid
20409               enum:
20410               - balance_due
20411               - credit_owed
20412               - failed
20413               - paid
20414               - void
20415             email:
20416               type: string
20417               format: email
20418               example: hi@getvendo.com
20419             special_instructions:
20420               type: string
20421               example: I need it ASAP!
20422             currency:
20423               type: string
20424               example: USD
20425             last_ip_address:
20426               type: string
20427               example: 127.0.0.1
20428             created_by_id:
20429               type: string
20430               example: '1'
20431             shipment_total:
20432               type: number
20433               example: 10.0
20434             additional_tax_total:
20435               type: number
20436               example: 10.0
20437             promo_total:
20438               type: number
20439               example: 0.0
20440             channel:
20441               type: string
20442               example: online
20443             included_tax_total:
20444               type: number
20445               example: 0.0
20446             item_count:
20447               type: integer
20448               example: 2
20449             approver_id:
20450               type: string
20451             approved_at:
20452               type: string
20453               format: date_time
20454               example: 2022-11-08 19:33:50 UTC
20455             confirmation_delivered:
20456               type: boolean
20457               example: true
20458               default: false
20459             considered_risky:
20460               type: boolean
20461               example: true
20462               default: false
20463             canceled_at:
20464               type: string
20465               format: date_time
20466             canceler_id:
20467               type: string
20468             taxable_adjustment_total:
20469               type: number
20470               example: 170.9
20471             non_taxable_adjustment_total:
20472               type: number
20473               example: 10.0
20474             store_owner_notification_delivered:
20475               type: boolean
20476               example: true
20477               default: false
20478             bill_address_attributes:
20479               "$ref": "#/components/schemas/update_address_params"
20480             ship_address_attributes:
20481               "$ref": "#/components/schemas/update_address_params"
20482             line_items_attributes:
20483               type: array
20484               items:
20485                 "$ref": "#/components/schemas/update_line_item_params"
20486             public_metadata:
20487               type: object
20488             private_metadata:
20489               type: object
20490       required:
20491       - order
20492       x-internal: false
20493     create_payment_method_params:
20494       type: object
20495       properties:
20496         payment_method:
20497           type: object
20498           required:
20499           - name
20500           properties:
20501             name:
20502               type: string
20503               example: Test Payment Method
20504             active:
20505               type: boolean
20506             auto_capture:
20507               type: boolean
20508             description:
20509               type: string
20510               example: This is a test payment method
20511             type:
20512               type: string
20513               example: Spree::Gateway::Bogus
20514               enum:
20515               - Spree::Gateway::Bogus
20516               - Spree::PaymentMethod::Check
20517             display_on:
20518               type: string
20519               example: both
20520               enum:
20521               - both
20522               - back_end
20523               - front_end
20524             store_ids:
20525               type: array
20526               items:
20527                 allOf:
20528                 - type: string
20529                   example: '2'
20530             public_metadata:
20531               type: object
20532             private_metadata:
20533               type: object
20534       required:
20535       - payment_method
20536       x-internal: false
20537     update_payment_method_params:
20538       type: object
20539       properties:
20540         payment_method:
20541           type: object
20542           properties:
20543             name:
20544               type: string
20545               example: Test Payment Method
20546             active:
20547               type: boolean
20548             auto_capture:
20549               type: boolean
20550             description:
20551               type: string
20552               example: This is a test payment method
20553             type:
20554               type: string
20555               example: Spree::Gateway::Bogus
20556               enum:
20557               - Spree::Gateway::Bogus
20558               - Spree::PaymentMethod::Check
20559             display_on:
20560               type: string
20561               example: both
20562               enum:
20563               - both
20564               - back_end
20565               - front_end
20566             store_ids:
20567               type: array
20568               items:
20569                 allOf:
20570                 - type: string
20571                   example: '2'
20572             public_metadata:
20573               type: object
20574             private_metadata:
20575               type: object
20576       required:
20577       - payment_method
20578       x-internal: false
20579       title: Update Payment Method
20580     update_payment_method_params_bogus_gateway:
20581       type: object
20582       properties:
20583         payment_method:
20584           type: object
20585           properties:
20586             preferred_dummy_key:
20587               type: string
20588               example: UPDATED-DUMMY-KEY-123
20589             preferred_server:
20590               type: string
20591               example: production
20592             preferred_test_mode:
20593               type: boolean
20594       required:
20595       - payment_method
20596       x-internal: false
20597       title: Update Bogus Gateway
20598     create_product_params:
20599       type: object
20600       properties:
20601         product:
20602           type: object
20603           required:
20604           - name
20605           - price
20606           - shipping_category_id
20607           properties:
20608             name:
20609               type: string
20610             description:
20611               type: string
20612             available_on:
20613               type: string
20614             discontinue_on:
20615               type: string
20616             permalink:
20617               type: string
20618             meta_description:
20619               type: string
20620             meta_keywords:
20621               type: string
20622             price:
20623               type: string
20624             sku:
20625               type: string
20626             deleted_at:
20627               type: string
20628             prototype_id:
20629               type: string
20630             option_values_hash:
20631               type: string
20632             weight:
20633               type: string
20634             height:
20635               type: string
20636             width:
20637               type: string
20638             depth:
20639               type: string
20640             shipping_category_id:
20641               type: string
20642             tax_category_id:
20643               type: string
20644             cost_currency:
20645               type: string
20646             cost_price:
20647               type: string
20648             compare_at_price:
20649               type: string
20650             option_type_ids:
20651               type: string
20652             taxon_ids:
20653               type: string
20654             public_metadata:
20655               type: object
20656             private_metadata:
20657               type: object
20658       required:
20659       - product
20660       x-internal: false
20661     update_product_params:
20662       type: object
20663       properties:
20664         product:
20665           type: object
20666           properties:
20667             name:
20668               type: string
20669             description:
20670               type: string
20671             available_on:
20672               type: string
20673             discontinue_on:
20674               type: string
20675             permalink:
20676               type: string
20677             meta_description:
20678               type: string
20679             meta_keywords:
20680               type: string
20681             price:
20682               type: string
20683             sku:
20684               type: string
20685             deleted_at:
20686               type: string
20687             prototype_id:
20688               type: string
20689             option_values_hash:
20690               type: string
20691             weight:
20692               type: string
20693             height:
20694               type: string
20695             width:
20696               type: string
20697             depth:
20698               type: string
20699             shipping_category_id:
20700               type: string
20701             tax_category_id:
20702               type: string
20703             cost_currency:
20704               type: string
20705             cost_price:
20706               type: string
20707             compare_at_price:
20708               type: string
20709             option_type_ids:
20710               type: string
20711             taxon_ids:
20712               type: string
20713             public_metadata:
20714               type: object
20715             private_metadata:
20716               type: object
20717       required:
20718       - product
20719       x-internal: false
20720     create_promotion_params:
20721       type: object
20722       properties:
20723         promotion:
20724           type: object
20725           required:
20726           - name
20727           properties:
20728             name:
20729               type: string
20730               example: Promotions Used in 2021
20731               description: Give the promotion a name.
20732             code:
20733               type: string
20734               example: BLK-FRI
20735               nullable: true
20736               description: Set the promotion code. Promotions without a code are automatically
20737                 applied if the order meets the Promotion Rule requirements.
20738             description:
20739               type: string
20740               example: Save today with discount code XYZ at checkout.
20741               nullable: true
20742               description: Give the promotion a description.
20743             usage_limit:
20744               type: integer
20745               example: 100
20746               nullable: true
20747               description: If you wish you can set a usage limit for this promotion.
20748             advertise:
20749               type: boolean
20750             starts_at:
20751               type: string
20752               format: date_time
20753               nullable: true
20754               description: Set a date and time that this promotion begins.
20755             ends_at:
20756               type: string
20757               format: date_time
20758               nullable: true
20759               description: Set a date and time that this promotion ends.
20760             store_ids:
20761               type: array
20762               items:
20763                 allOf:
20764                 - type: string
20765                   example: '2'
20766       required:
20767       - promotion
20768       title: Create a Promotion
20769       x-internal: false
20770     update_promotion_params:
20771       type: object
20772       properties:
20773         promotion:
20774           type: object
20775           properties:
20776             name:
20777               type: string
20778               example: Promotions Used in 2021
20779               description: Change the promotion a name.
20780             code:
20781               type: string
20782               example: CYB-MON
20783               nullable: true
20784               description: Change or remove the promotion code. Promotions without
20785                 a code are automatically applied if the order meets the Promotion
20786                 Rule requirements.
20787             description:
20788               type: string
20789               example: Save today with discount code XYZ at checkout.
20790               nullable: true
20791               description: Update the promotion a description.
20792             usage_limit:
20793               type: integer
20794               example: 100
20795               nullable: true
20796               description: If you wish you can set a usage limit for this promotion.
20797             advertise:
20798               type: boolean
20799             starts_at:
20800               type: string
20801               format: date_time
20802               nullable: true
20803               description: Set a date and time that this promotion begins.
20804             ends_at:
20805               type: string
20806               format: date_time
20807               nullable: true
20808               description: Set a date and time that this promotion ends.
20809             store_ids:
20810               type: array
20811               items:
20812                 allOf:
20813                 - type: string
20814                   example: '2'
20815       required:
20816       - promotion
20817       title: Update a Promotion
20818       x-internal: false
20819     update_promotion_add_rule_params:
20820       type: object
20821       properties:
20822         promotion:
20823           type: object
20824           properties:
20825             promotion_rules_attributes:
20826               type: array
20827               items:
20828                 allOf:
20829                 - properties:
20830                     type:
20831                       type: string
20832                       example: Spree::Promotion::Rules::Country
20833                       enum:
20834                       - Spree::Promotion::Rules::Country
20835                       - Spree::Promotion::Rules::ItemTotal
20836                       - Spree::Promotion::Rules::Product
20837                       - Spree::Promotion::Rules::User
20838                       - Spree::Promotion::Rules::FirstOrder
20839                       - Spree::Promotion::Rules::UserLoggedIn
20840                       - Spree::Promotion::Rules::OneUsePerUser
20841                       - Spree::Promotion::Rules::Taxon
20842                       - Spree::Promotion::Rules::OptionValue
20843                       description: Set the Promotion Rule type.
20844                     preferred_country_id:
20845                       type: integer
20846                       example: 122
20847                       description: 'Each rule type has its own preferred attributes.
20848                         In this example we are setting the ID of the Country this
20849                         rule applies to. To learn more about Spree preferences visit
20850                         TODO: [LINK].'
20851       required:
20852       - promotion
20853       title: Add a Rule to a Promotion
20854       x-internal: false
20855     update_promotion_update_rule_params:
20856       type: object
20857       properties:
20858         promotion:
20859           type: object
20860           properties:
20861             promotion_rules_attributes:
20862               type: array
20863               items:
20864                 allOf:
20865                 - properties:
20866                     id:
20867                       type: string
20868                       example: '22'
20869                       description: To update an existing Promotion Rule, you are required
20870                         to pass the ID of the rule you are updating.
20871                     type:
20872                       type: string
20873                       example: Spree::Promotion::Rules::Country
20874                       enum:
20875                       - Spree::Promotion::Rules::Country
20876                       - Spree::Promotion::Rules::ItemTotal
20877                       - Spree::Promotion::Rules::Product
20878                       - Spree::Promotion::Rules::User
20879                       - Spree::Promotion::Rules::FirstOrder
20880                       - Spree::Promotion::Rules::UserLoggedIn
20881                       - Spree::Promotion::Rules::OneUsePerUser
20882                       - Spree::Promotion::Rules::Taxon
20883                       - Spree::Promotion::Rules::OptionValue
20884                       description: Set the Promotion Rule type.
20885                     preferred_country_id:
20886                       type: integer
20887                       example: 143
20888                       description: 'Each rule type has its own preferred attributes.
20889                         In this example we are changing the ID of the Country this
20890                         rule applies to. To learn more about Spree preferences visit
20891                         TODO: [LINK].'
20892       required:
20893       - promotion
20894       title: Update an existing Rule
20895       x-internal: false
20896     update_promotion_add_action_params:
20897       type: object
20898       properties:
20899         promotion:
20900           type: object
20901           properties:
20902             promotion_actions_attributes:
20903               type: array
20904               items:
20905                 allOf:
20906                 - properties:
20907                     type:
20908                       type: string
20909                       example: Spree::Promotion::Actions::CreateAdjustment
20910                       enum:
20911                       - Spree::Promotion::Actions::CreateAdjustment
20912                       - Spree::Promotion::Actions::CreateItemAdjustments
20913                       - Spree::Promotion::Actions::FreeShipping
20914                       - Spree::Promotion::Actions::CreateLineItems
20915                       description: Set the Promotion Action Type.
20916       required:
20917       - promotion
20918       title: Add an Action to a Promotion
20919       x-internal: false
20920     update_promotion_action_calculator_params:
20921       type: object
20922       properties:
20923         promotion:
20924           type: object
20925           properties:
20926             promotion_actions_attributes:
20927               type: array
20928               items:
20929                 allOf:
20930                 - properties:
20931                     id:
20932                       type: string
20933                       example: '22'
20934                       description: To update an existing Promotion Action, you are
20935                         required to pass the ID of the action you wish to update.
20936                     calculator_attributes:
20937                       properties:
20938                         id:
20939                           type: string
20940                           example: '19'
20941                           description: To update an existing Action Calculator, you
20942                             are required to pass the ID of the calculator.
20943                         type:
20944                           type: string
20945                           example: Spree::Promotion::Actions::CreateAdjustment
20946                           enum:
20947                           - Spree::Promotion::Actions::CreateAdjustment
20948                           - Spree::Promotion::Actions::CreateItemAdjustments
20949                           - Spree::Promotion::Actions::CreateLineItems
20950                           - Spree::Promotion::Actions::FreeShipping
20951                           description: Set the Type of Promotion Action you wish to
20952                             use.
20953                         preferred_flat_percent:
20954                           type: integer
20955                           example: 10
20956                           description: In this example we are setting the preferred
20957                             flat percentage to `10`.
20958       required:
20959       - promotion
20960       title: Update an Action Calculator
20961       x-internal: false
20962     update_promotion_change_calculator_params:
20963       type: object
20964       properties:
20965         promotion:
20966           type: object
20967           properties:
20968             promotion_actions_attributes:
20969               type: array
20970               items:
20971                 allOf:
20972                 - properties:
20973                     id:
20974                       type: string
20975                       example: '22'
20976                       description: To update an existing Promotion Action, you are
20977                         required to pass the ID of the Promotion Action.
20978                     calculator_attributes:
20979                       properties:
20980                         type:
20981                           type: string
20982                           example: Spree::Calculator::FlatPercentItemTotal
20983                           enum:
20984                           - Spree::Calculator::FlatPercentItemTotal
20985                           - Spree::Calculator::FlatRate
20986                           - Spree::Calculator::FlexiRate
20987                           - Spree::Calculator::TieredPercent
20988                           - Spree::Calculator::TieredFlatRate
20989                           - Spree::Calculator::PercentOnLineItem
20990                           description: 'To set the Promotion Action Calculator pass
20991                             the calculator type. Each Promotion action has certain
20992                             Calculators available, to learn more visit TODO: [LINK]'
20993       required:
20994       - promotion
20995       title: Change an Action Calculator
20996       x-internal: false
20997     update_promotion_change_action_params:
20998       type: object
20999       properties:
21000         promotion:
21001           type: object
21002           properties:
21003             promotion_actions_attributes:
21004               type: array
21005               items:
21006                 allOf:
21007                 - properties:
21008                     id:
21009                       type: string
21010                       example: '22'
21011                       description: To update an existing Promotion Action, you are
21012                         required to pass the ID of the Promotion Action.
21013                     type:
21014                       type: string
21015                       example: Spree::Promotion::Actions::CreateAdjustment
21016                       enum:
21017                       - Spree::Promotion::Actions::CreateAdjustment
21018                       - Spree::Promotion::Actions::CreateItemAdjustments
21019                       - Spree::Promotion::Actions::CreateLineItems
21020                       - Spree::Promotion::Actions::FreeShipping
21021                       description: Set the Type of Promotion Action you wish to use.
21022       required:
21023       - promotion
21024       title: Change an Action Type
21025       x-internal: false
21026     create_promotion_action_params:
21027       type: object
21028       properties:
21029         promotion_action:
21030           type: object
21031           required:
21032           - type
21033           - promotion_id
21034           properties:
21035             type:
21036               type: string
21037               example: Spree::Promotion::Actions::CreateAdjustment
21038               enum:
21039               - Spree::Promotion::Actions::CreateAdjustment
21040               - Spree::Promotion::Actions::CreateItemAdjustments
21041               - Spree::Promotion::Actions::CreateLineItems
21042               - Spree::Promotion::Actions::FreeShipping
21043               description: Set the Type of Promotion Action you wish to use.
21044             promotion_id:
21045               type: string
21046               example: '22'
21047               description: Set the ID of the promotion this action belongs to.
21048       required:
21049       - promotion_action
21050       title: Create a Promotion Action
21051       x-internal: false
21052     update_promotion_action_params:
21053       type: object
21054       properties:
21055         promotion_action:
21056           type: object
21057           properties:
21058             type:
21059               type: string
21060               example: Spree::Promotion::Actions::CreateAdjustment
21061               enum:
21062               - Spree::Promotion::Actions::CreateAdjustment
21063               - Spree::Promotion::Actions::CreateItemAdjustments
21064               - Spree::Promotion::Actions::CreateLineItems
21065               - Spree::Promotion::Actions::FreeShipping
21066               description: Set the Type of Promotion Action you wish to use.
21067       required:
21068       - promotion_action
21069       title: Create a Promotion Action
21070       x-internal: false
21071     create_promotion_category_params:
21072       type: object
21073       properties:
21074         promotion_category:
21075           type: object
21076           required:
21077           - name
21078           properties:
21079             name:
21080               type: string
21081               example: Promotions Used in 2021
21082               description: Give this Promotion Category a name.
21083             code:
21084               type: string
21085               example: 2021-PROMOS
21086               nullable: true
21087               description: Give this promotion category a code.
21088       required:
21089       - promotion_category
21090       x-internal: false
21091     update_promotion_category_params:
21092       type: object
21093       properties:
21094         promotion_category:
21095           type: object
21096           required:
21097           - name
21098           properties:
21099             name:
21100               type: string
21101               example: Promotions Used in 2021
21102               description: Update the name of this Promotion Category.
21103             code:
21104               type: string
21105               example: 2021-PROMOS
21106               nullable: true
21107               description: Change or remove the code for this Promotion Category.
21108       required:
21109       - promotion_category
21110       x-internal: false
21111     create_promotion_rule_params:
21112       type: object
21113       properties:
21114         promotion_rule:
21115           type: object
21116           required:
21117           - type
21118           - promotion_id
21119           properties:
21120             promotion_id:
21121               type: string
21122               example: '22'
21123               description: Set the ID of the promotion this Promotion Rule belongs
21124                 to.
21125             type:
21126               type: string
21127               example: Spree::Promotion::Rules::Country
21128               enum:
21129               - Spree::Promotion::Rules::Country
21130               - Spree::Promotion::Rules::ItemTotal
21131               - Spree::Promotion::Rules::Product
21132               - Spree::Promotion::Rules::User
21133               - Spree::Promotion::Rules::FirstOrder
21134               - Spree::Promotion::Rules::UserLoggedIn
21135               - Spree::Promotion::Rules::OneUsePerUser
21136               - Spree::Promotion::Rules::Taxon
21137               - Spree::Promotion::Rules::OptionValue
21138               description: Set the Promotion Rule type.
21139       required:
21140       - promotion_rule
21141       title: Create a Promotion Rule
21142       x-internal: false
21143     update_promotion_rule_params:
21144       type: object
21145       properties:
21146         promotion_rule:
21147           type: object
21148           properties:
21149             type:
21150               type: string
21151               example: Spree::Promotion::Rules::Country
21152               enum:
21153               - Spree::Promotion::Rules::Country
21154               - Spree::Promotion::Rules::ItemTotal
21155               - Spree::Promotion::Rules::Product
21156               - Spree::Promotion::Rules::User
21157               - Spree::Promotion::Rules::FirstOrder
21158               - Spree::Promotion::Rules::UserLoggedIn
21159               - Spree::Promotion::Rules::OneUsePerUser
21160               - Spree::Promotion::Rules::Taxon
21161               - Spree::Promotion::Rules::OptionValue
21162               description: Set the Promotion Rule type.
21163       required:
21164       - promotion_rule
21165       title: Create a Promotion Rule
21166       x-internal: false
21167     create_role_params:
21168       type: object
21169       properties:
21170         role:
21171           type: object
21172           required:
21173           - name
21174           properties:
21175             name:
21176               type: string
21177               example: vendor
21178       required:
21179       - zone
21180       x-internal: false
21181     update_role_params:
21182       type: object
21183       properties:
21184         role:
21185           type: object
21186           properties:
21187             name:
21188               type: string
21189               example: vendor
21190       required:
21191       - zone
21192       x-internal: false
21193     create_shipment_params:
21194       type: object
21195       properties:
21196         shipment:
21197           type: object
21198           required:
21199           - stock_location_id
21200           - order_id
21201           - variant_id
21202           properties:
21203             stock_location_id:
21204               type: string
21205               example: '101'
21206             order_id:
21207               type: string
21208               example: '101'
21209             variant_id:
21210               type: string
21211               example: '101'
21212             quantity:
21213               type: integer
21214               example: 2
21215       required:
21216       - shipping_category
21217       x-internal: false
21218     update_shipment_params:
21219       type: object
21220       properties:
21221         shipment:
21222           type: object
21223           properties:
21224             tracking:
21225               type: string
21226               example: MY-TRACKING-REF-12324
21227       required:
21228       - shipping_category
21229       x-internal: false
21230     add_item_shipment_params:
21231       type: object
21232       properties:
21233         shipment:
21234           type: object
21235           required:
21236           - variant_id
21237           properties:
21238             variant_id:
21239               type: string
21240               example: '101'
21241             quantity:
21242               type: integer
21243               example: 2
21244       required:
21245       - shipping_category
21246       x-internal: false
21247     remove_item_shipment_params:
21248       type: object
21249       properties:
21250         shipment:
21251           type: object
21252           required:
21253           - variant_id
21254           properties:
21255             variant_id:
21256               type: string
21257               example: '101'
21258             quantity:
21259               type: integer
21260               example: 2
21261       required:
21262       - shipping_category
21263       x-internal: false
21264     create_shipping_category_params:
21265       type: object
21266       properties:
21267         shipping_category:
21268           type: object
21269           required:
21270           - name
21271           properties:
21272             name:
21273               type: string
21274               example: Another Category
21275       required:
21276       - shipping_category
21277       x-internal: false
21278     update_shipping_category_params:
21279       type: object
21280       properties:
21281         shipping_category:
21282           type: object
21283           required:
21284           - name
21285           properties:
21286             name:
21287               type: string
21288               example: Another Category
21289       required:
21290       - shipping_category
21291       x-internal: false
21292     create_shipping_method_params:
21293       type: object
21294       properties:
21295         shipping_method:
21296           type: object
21297           required:
21298           - name
21299           - display_on
21300           - shipping_category_ids
21301           properties:
21302             name:
21303               type: string
21304               example: DHL Express
21305             admin_name:
21306               type: string
21307               example: DHL Area Code D
21308             code:
21309               type: string
21310               example: DHL-A-D
21311             tracking_url:
21312               type: string
21313               example: dhlexpress.com?tracking=
21314             display_on:
21315               type: string
21316               example: both
21317               enum:
21318               - both
21319               - back_end
21320               - front_end
21321             tax_category_id:
21322               type: string
21323               example: '1'
21324             shipping_category_ids:
21325               type: array
21326               items:
21327                 allOf:
21328                 - type: string
21329                   example: '2'
21330             calculator_attributes:
21331               "$ref": "#/components/schemas/shipping_calculator_params"
21332             public_metadata:
21333               type: object
21334             private_metadata:
21335               type: object
21336       required:
21337       - shipping_method
21338       x-internal: false
21339     update_shipping_method_params:
21340       type: object
21341       properties:
21342         shipping_method:
21343           type: object
21344           properties:
21345             name:
21346               type: string
21347               example: DHL Express
21348             admin_name:
21349               type: string
21350               example: DHL Area Code D
21351             code:
21352               type: string
21353               example: DHL-A-D
21354             tracking_url:
21355               type: string
21356               example: dhlexpress.com?tracking=
21357             display_on:
21358               type: string
21359               example: both
21360               enum:
21361               - both
21362               - back_end
21363               - front_end
21364             tax_category_id:
21365               type: string
21366               example: '1'
21367             shipping_category_ids:
21368               type: array
21369               items:
21370                 allOf:
21371                 - type: string
21372                   example: '2'
21373             calculator_attributes:
21374               "$ref": "#/components/schemas/shipping_calculator_params"
21375             public_metadata:
21376               type: object
21377             private_metadata:
21378               type: object
21379       required:
21380       - shipping_method
21381       x-internal: false
21382     shipping_calculator_params:
21383       type: object
21384       properties:
21385         type:
21386           type: string
21387           example: Spree::Calculator::Shipping::FlatPercentItemTotal
21388           enum:
21389           - Spree::Calculator::Shipping::DigitalDelivery
21390           - Spree::Calculator::Shipping::FlatPercentItemTotal
21391           - Spree::Calculator::Shipping::FlatRate
21392           - Spree::Calculator::Shipping::FlexiRate
21393           - Spree::Calculator::Shipping::PerItem
21394           - Spree::Calculator::Shipping::PriceSack
21395       required:
21396       - type
21397       x-internal: false
21398     create_stock_item_params:
21399       type: object
21400       properties:
21401         stock_item:
21402           type: object
21403           required:
21404           - variant_id
21405           - stock_location_id
21406           - count_on_hand
21407           properties:
21408             variant_id:
21409               type: string
21410               example: '2'
21411             stock_location_id:
21412               type: string
21413               example: '2'
21414             count_on_hand:
21415               type: number
21416               example: 200
21417             backorderable:
21418               type: boolean
21419               example: true
21420               default: false
21421       required:
21422       - stock_item
21423       x-internal: false
21424     update_stock_item_params:
21425       type: object
21426       properties:
21427         stock_item:
21428           type: object
21429           required:
21430           - variant_id
21431           - stock_location_id
21432           - count_on_hand
21433           properties:
21434             variant_id:
21435               type: string
21436               example: '2'
21437             stock_location_id:
21438               type: string
21439               example: '2'
21440             count_on_hand:
21441               type: number
21442               example: 200
21443             backorderable:
21444               type: boolean
21445               example: true
21446               default: false
21447       required:
21448       - stock_item
21449       x-internal: false
21450     create_stock_location_params:
21451       type: object
21452       properties:
21453         stock_location:
21454           type: object
21455           required:
21456           - name
21457           properties:
21458             name:
21459               type: string
21460               example: Warehouse 3
21461             default:
21462               type: boolean
21463             address1:
21464               type: string
21465               example: South St. 8
21466             address2:
21467               type: string
21468               example: South St. 109
21469             country_id:
21470               type: string
21471               example: '2'
21472             state_id:
21473               type: string
21474               example: '4'
21475             city:
21476               type: string
21477               example: Los Angeles
21478             state_name:
21479               type: string
21480               example: California
21481             zipcode:
21482               type: string
21483               example: '90005'
21484             phone:
21485               type: string
21486               example: '23333456'
21487             active:
21488               type: boolean
21489             backorderable_default:
21490               type: boolean
21491             propagate_all_variants:
21492               type: boolean
21493             admin_name:
21494               type: string
21495       required:
21496       - stock_location
21497       x-internal: false
21498     update_stock_location_params:
21499       type: object
21500       properties:
21501         stock_location:
21502           type: object
21503           required:
21504           - name
21505           properties:
21506             name:
21507               type: string
21508               example: Warehouse 3
21509             default:
21510               type: boolean
21511             address1:
21512               type: string
21513               example: South St. 8
21514             address2:
21515               type: string
21516               example: South St. 109
21517             country_id:
21518               type: string
21519               example: '2'
21520             state_id:
21521               type: string
21522               example: '4'
21523             city:
21524               type: string
21525               example: Los Angeles
21526             state_name:
21527               type: string
21528               example: California
21529             zipcode:
21530               type: string
21531               example: '90005'
21532             phone:
21533               type: string
21534               example: '23333456'
21535             active:
21536               type: boolean
21537             backorderable_default:
21538               type: boolean
21539             propagate_all_variants:
21540               type: boolean
21541             admin_name:
21542               type: string
21543       required:
21544       - stock_location
21545       x-internal: false
21546     create_store_credit_category_params:
21547       type: object
21548       properties:
21549         store_credit_category:
21550           type: object
21551           required:
21552           - name
21553           properties:
21554             name:
21555               type: string
21556               example: refunded
21557       required:
21558       - store_credit_category
21559       x-internal: false
21560     update_store_credit_category_params:
21561       type: object
21562       properties:
21563         store_credit_category:
21564           type: object
21565           required:
21566           - name
21567           properties:
21568             name:
21569               type: string
21570               example: refunded
21571       required:
21572       - store_credit_category
21573       x-internal: false
21574     create_store_credit_type_params:
21575       type: object
21576       properties:
21577         store_credit_type:
21578           type: object
21579           required:
21580           - name
21581           properties:
21582             name:
21583               type: string
21584               example: refunded
21585             priority:
21586               type: integer
21587               example: 1
21588       required:
21589       - store_credit_type
21590       x-internal: false
21591     update_store_credit_type_params:
21592       type: object
21593       properties:
21594         store_credit_type:
21595           type: object
21596           properties:
21597             name:
21598               type: string
21599               example: refunded
21600             priority:
21601               type: integer
21602               example: 1
21603       required:
21604       - store_credit_type
21605       x-internal: false
21606     create_store_credit_params:
21607       type: object
21608       properties:
21609         store_credit:
21610           type: object
21611           required:
21612           - user_id
21613           - category_id
21614           - type_id
21615           - created_by_id
21616           - currency
21617           - store_id
21618           - amount
21619           properties:
21620             user_id:
21621               type: string
21622               example: '2'
21623             category_id:
21624               type: string
21625               example: '4'
21626             created_by_id:
21627               type: string
21628               example: '5'
21629             amount:
21630               type: number
21631               example: 25.0
21632             amount_used:
21633               type: number
21634               example: 10.0
21635             memo:
21636               type: string
21637               example: This credit was given as a refund
21638             currency:
21639               type: string
21640               example: USD
21641             amount_authorized:
21642               type: number
21643               example: 15.5
21644             originator_id:
21645               type: string
21646               example: '3'
21647             originator_type:
21648               type: string
21649               example: Refund
21650             type_id:
21651               type: string
21652               example: '1'
21653             store_id:
21654               type: string
21655               example: '2'
21656             public_metadata:
21657               type: object
21658             private_metadata:
21659               type: object
21660       required:
21661       - store_credit
21662       x-internal: false
21663     update_store_credit_params:
21664       type: object
21665       properties:
21666         store_credit:
21667           type: object
21668           required:
21669           - user_id
21670           - category_id
21671           - type_id
21672           - created_by_id
21673           - currency
21674           - store_id
21675           - amount
21676           properties:
21677             user_id:
21678               type: string
21679               example: '2'
21680             category_id:
21681               type: string
21682               example: '4'
21683             created_by_id:
21684               type: string
21685               example: '5'
21686             amount:
21687               type: number
21688               example: 25.0
21689             amount_used:
21690               type: number
21691               example: 10.0
21692             memo:
21693               type: string
21694               example: This credit was given as a refund
21695             currency:
21696               type: string
21697               example: USD
21698             amount_authorized:
21699               type: number
21700               example: 15.5
21701             originator_id:
21702               type: string
21703               example: '3'
21704             originator_type:
21705               type: string
21706               example: Refund
21707             type_id:
21708               type: string
21709               example: '1'
21710             store_id:
21711               type: string
21712               example: '2'
21713             public_metadata:
21714               type: object
21715             private_metadata:
21716               type: object
21717       required:
21718       - store_credit
21719       x-internal: false
21720     create_tax_category_params:
21721       type: object
21722       properties:
21723         tax_category:
21724           type: object
21725           required:
21726           - name
21727           properties:
21728             name:
21729               type: string
21730               example: Clothing
21731             is_default:
21732               type: boolean
21733               example: true
21734             tax_code:
21735               type: string
21736               example: 1257L
21737             description:
21738               type: string
21739               example: Men's, women's and children's branded clothing
21740       required:
21741       - tax_category
21742       x-internal: false
21743     update_tax_category_params:
21744       type: object
21745       properties:
21746         tax_category:
21747           type: object
21748           required:
21749           - name
21750           properties:
21751             name:
21752               type: string
21753               example: Clothing
21754             is_default:
21755               type: boolean
21756               example: true
21757             tax_code:
21758               type: string
21759               example: 1257L
21760             description:
21761               type: string
21762               example: Men's, women's and children's branded clothing
21763       required:
21764       - tax_category
21765       x-internal: false
21766     create_tax_rate_params:
21767       type: object
21768       properties:
21769         tax_rate:
21770           type: object
21771           required:
21772           - amount
21773           - calculator_attributes
21774           - tax_category_id
21775           properties:
21776             amount:
21777               type: number
21778               example: 0.05
21779             zone_id:
21780               type: string
21781               example: '2'
21782             tax_category_id:
21783               type: string
21784               example: '1'
21785             included_in_price:
21786               type: boolean
21787               example: true
21788             name:
21789               type: string
21790               example: California
21791             show_rate_in_label:
21792               type: boolean
21793               example: false
21794             calculator_attributes:
21795               type: object
21796               properties:
21797                 type:
21798                   type: string
21799                   example: Spree::Calculator::FlatRate
21800                 preferences:
21801                   type: object
21802                   example:
21803                     amount: 0
21804                     currency: USD
21805       required:
21806       - tax_rate
21807       x-internal: false
21808     update_tax_rate_params:
21809       type: object
21810       properties:
21811         tax_rate:
21812           type: object
21813           required:
21814           - amount
21815           - calculator_attributes
21816           - tax_category_id
21817           properties:
21818             amount:
21819               type: number
21820               example: 0.05
21821             zone_id:
21822               type: string
21823               example: '2'
21824             tax_category_id:
21825               type: string
21826               example: '1'
21827             included_in_price:
21828               type: boolean
21829               example: true
21830             name:
21831               type: string
21832               example: California
21833             show_rate_in_label:
21834               type: boolean
21835               example: false
21836             calculator_attributes:
21837               type: object
21838               properties:
21839                 type:
21840                   type: string
21841                   example: Spree::Calculator::FlatRate
21842                 preferences:
21843                   type: object
21844                   example:
21845                     amount: 0
21846                     currency: USD
21847       required:
21848       - tax_rate
21849       x-internal: false
21850     create_taxon_params:
21851       type: object
21852       properties:
21853         taxon:
21854           type: object
21855           required:
21856           - name
21857           - taxonomy_id
21858           properties:
21859             taxonomy_id:
21860               type: string
21861             parent_id:
21862               type: string
21863             name:
21864               type: string
21865             public_metadata:
21866               type: object
21867               example:
21868                 ability_to_recycle: 90%
21869             private_metadata:
21870               type: object
21871               example:
21872                 profitability: 2
21873       required:
21874       - taxon
21875       x-internal: false
21876     update_taxon_params:
21877       type: object
21878       properties:
21879         taxon:
21880           type: object
21881           properties:
21882             taxonomy_id:
21883               type: string
21884             parent_id:
21885               type: string
21886             name:
21887               type: string
21888             public_metadata:
21889               type: object
21890             private_metadata:
21891               type: object
21892       required:
21893       - taxon
21894       x-internal: false
21895     taxon_reposition:
21896       type: object
21897       properties:
21898         taxon:
21899           type: object
21900           required:
21901           - new_parent_id
21902           - new_position_idx
21903           properties:
21904             new_parent_id:
21905               type: integer
21906               example: 1
21907               description: The ID of the new target parent Taxon.
21908             new_position_idx:
21909               type: integer
21910               example: 1
21911               description: The new index position of the Taxon within the parent Taxon.
21912       required:
21913       - taxon
21914       title: Reposition a Taxon
21915       x-internal: false
21916     create_taxonomy_params:
21917       type: object
21918       properties:
21919         taxonomy:
21920           type: object
21921           required:
21922           - name
21923           properties:
21924             name:
21925               type: string
21926             position:
21927               type: integer
21928               example: 2
21929               description: 'Pass the position that you want this Taxonomy to appear
21930                 in. (The list is not zero indexed, so the first item is position:
21931                 `1`)'
21932             public_metadata:
21933               type: object
21934               example:
21935                 ability_to_recycle: 90%
21936             private_metadata:
21937               type: object
21938               example:
21939                 profitability: 2
21940       required:
21941       - taxonomy
21942       x-internal: false
21943     update_taxonomy_params:
21944       type: object
21945       properties:
21946         taxonomy:
21947           type: object
21948           properties:
21949             name:
21950               type: string
21951             position:
21952               type: integer
21953               example: 2
21954               description: 'Pass the position that you want this Taxonomy to appear
21955                 in. (The list is not zero indexed, so the first item is position:
21956                 `1`)'
21957             public_metadata:
21958               type: object
21959               example:
21960                 ability_to_recycle: 90%
21961             private_metadata:
21962               type: object
21963               example:
21964                 profitability: 2
21965       required:
21966       - taxonomy
21967       x-internal: false
21968     create_user_params:
21969       type: object
21970       properties:
21971         user:
21972           type: object
21973           required:
21974           - email
21975           - password
21976           - password_confirmation
21977           properties:
21978             email:
21979               type: string
21980             first_name:
21981               type: string
21982             last_name:
21983               type: string
21984             password:
21985               type: string
21986             password_confirmation:
21987               type: string
21988             selected_locale:
21989               type: string
21990             ship_address_id:
21991               type: string
21992             bill_address_id:
21993               type: string
21994             public_metadata:
21995               type: object
21996             private_metadata:
21997               type: object
21998       required:
21999       - user
22000       x-internal: false
22001     update_user_params:
22002       type: object
22003       properties:
22004         user:
22005           type: object
22006           properties:
22007             email:
22008               type: string
22009             first_name:
22010               type: string
22011             last_name:
22012               type: string
22013             password:
22014               type: string
22015             password_confirmation:
22016               type: string
22017             selected_locale:
22018               type: string
22019             ship_address_id:
22020               type: string
22021             bill_address_id:
22022               type: string
22023             public_metadata:
22024               type: object
22025             private_metadata:
22026               type: object
22027       required:
22028       - user
22029       x-internal: false
22030     create_webhook_subscriber_params:
22031       type: object
22032       properties:
22033         subscriber:
22034           type: object
22035           required:
22036           - url
22037           properties:
22038             active:
22039               type: boolean
22040               example: true
22041               default: false
22042             subscriptions:
22043               type: array
22044               items:
22045                 allOf:
22046                 - type: string
22047                   example: order.completed
22048               example:
22049               - order.created
22050               - order.completed
22051               - product.updated
22052               default: []
22053             url:
22054               type: string
22055               example: https://www.url.com/
22056       required:
22057       - subscriber
22058       x-internal: false
22059     update_webhook_subscriber_params:
22060       type: object
22061       properties:
22062         subscriber:
22063           type: object
22064           required:
22065           - url
22066           properties:
22067             active:
22068               type: boolean
22069               example: true
22070               default: false
22071             subscriptions:
22072               type: array
22073               items:
22074                 allOf:
22075                 - type: string
22076                   example: order.completed
22077               example:
22078               - order.created
22079               - order.completed
22080               - product.updated
22081               default: []
22082             url:
22083               type: string
22084               example: https://www.url.com/
22085       required:
22086       - subscriber
22087       x-internal: false
22088     create_wishlist_params:
22089       type: object
22090       properties:
22091         wishlist:
22092           type: object
22093           required:
22094           - name
22095           - user_id
22096           properties:
22097             name:
22098               type: string
22099             user_id:
22100               type: string
22101             is_default:
22102               type: boolean
22103             is_private:
22104               type: boolean
22105       required:
22106       - wishlist
22107       x-internal: false
22108     update_wishlist_params:
22109       type: object
22110       properties:
22111         wishlist:
22112           type: object
22113           properties:
22114             name:
22115               type: string
22116             user_id:
22117               type: string
22118             is_default:
22119               type: boolean
22120             is_private:
22121               type: boolean
22122       required:
22123       - wishlist
22124       x-internal: false
22125     create_wished_item_params:
22126       type: object
22127       properties:
22128         wished_item:
22129           type: object
22130           required:
22131           - wishlist_id
22132           - variant_id
22133           - quantity
22134           properties:
22135             wishlist_id:
22136               type: string
22137             variant_id:
22138               type: string
22139             quantity:
22140               type: integer
22141               description: Must be an integer greater than 0
22142       required:
22143       - wished_item
22144       x-internal: false
22145     update_wished_item_params:
22146       type: object
22147       properties:
22148         wished_item:
22149           type: object
22150           required:
22151           - wishlist_id
22152           - variant_id
22153           - quantity
22154           properties:
22155             wishlist_id:
22156               type: string
22157             variant_id:
22158               type: string
22159             quantity:
22160               type: integer
22161               description: Must be an integer greater than 0
22162       required:
22163       - wished_item
22164       x-internal: false
22165     create_vendor_params:
22166       type: object
22167       properties:
22168         name:
22169           type: string
22170         invitation_message:
22171           type: string
22172         public_metadata:
22173           type: object
22174         private_metadata:
22175           type: object
22176         platform_fee:
22177           type: number
22178           default: 5
22179         state:
22180           type: string
22181           default: pending
22182         contact_person_email:
22183           type: string
22184         contact_person_name:
22185           type: string
22186         contact_person_phone:
22187           type: string
22188       required:
22189       - integration
22190       - kind
22191       - contact_person_email
22192       - name
22193       x-internal: true
22194     update_vendor_params:
22195       "$ref": "#/components/schemas/create_vendor_params"
22196       x-internal: true
22197     create_zone_params:
22198       type: object
22199       properties:
22200         zone:
22201           type: object
22202           required:
22203           - name
22204           properties:
22205             name:
22206               type: string
22207               example: EU
22208             description:
22209               type: string
22210               example: All countries in the EU
22211             default_tax:
22212               type: boolean
22213             kind:
22214               type: string
22215               example: state
22216               enum:
22217               - state
22218               - country
22219       required:
22220       - zone
22221       x-internal: false
22222     update_zone_params:
22223       type: object
22224       properties:
22225         address:
22226           type: object
22227           properties:
22228             name:
22229               type: string
22230               example: EU
22231             description:
22232               type: string
22233               example: All countries in the EU
22234             default_tax:
22235               type: boolean
22236             kind:
22237               type: string
22238               example: state
22239               enum:
22240               - state
22241               - country
22242       required:
22243       - zone
22244       x-internal: false
22245     amount_param:
22246       type: object
22247       properties:
22248         amount:
22249           type: number
22250       x-internal: false
22251     coupon_code_param:
22252       type: object
22253       properties:
22254         coupon_code:
22255           type: string
22256       x-internal: false
22257     resources_list:
22258       type: object
22259       properties:
22260         data:
22261           type: array
22262           items:
22263             allOf:
22264             - "$ref": "#/components/schemas/resource_properties"
22265         meta:
22266           type: object
22267           properties:
22268             count:
22269               type: integer
22270             total_count:
22271               type: integer
22272             total_pages:
22273               type: integer
22274           required:
22275           - count
22276           - total_count
22277           - total_pages
22278         links:
22279           type: object
22280           properties:
22281             self:
22282               type: string
22283             next:
22284               type: string
22285             prev:
22286               type: string
22287             last:
22288               type: string
22289             first:
22290               type: string
22291           required:
22292           - self
22293           - next
22294           - prev
22295           - last
22296           - first
22297       required:
22298       - data
22299       - meta
22300       - links
22301       x-internal: false
22302     resource_properties:
22303       type: object
22304       properties:
22305         id:
22306           type: string
22307         type:
22308           type: string
22309         attributes:
22310           type: object
22311         relationships:
22312           type: object
22313       required:
22314       - id
22315       - type
22316       - attributes
22317       x-internal: false
22318     resource:
22319       type: object
22320       properties:
22321         data:
22322           "$ref": "#/components/schemas/resource_properties"
22323       required:
22324       - data
22325       x-internal: false
22326     error:
22327       type: object
22328       properties:
22329         error:
22330           type: string
22331       required:
22332       - error
22333       x-internal: false
22334     validation_errors:
22335       type: object
22336       properties:
22337         error:
22338           type: string
22339         errors:
22340           type: object
22341       required:
22342       - error
22343       - errors
22344       x-internal: false