-
Notifications
You must be signed in to change notification settings - Fork 48
/
catalog_api.py
842 lines (741 loc) · 36 KB
/
catalog_api.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
# -*- coding: utf-8 -*-
from square.api_helper import APIHelper
from square.http.api_response import ApiResponse
from square.utilities.file_wrapper import FileWrapper
from square.api.base_api import BaseApi
from apimatic_core.request_builder import RequestBuilder
from apimatic_core.response_handler import ResponseHandler
from apimatic_core.types.parameter import Parameter
from square.http.http_method_enum import HttpMethodEnum
from apimatic_core.authentication.multiple.single_auth import Single
from apimatic_core.authentication.multiple.and_auth_group import And
from apimatic_core.authentication.multiple.or_auth_group import Or
class CatalogApi(BaseApi):
"""A Controller to access Endpoints in the square API."""
def __init__(self, config):
super(CatalogApi, self).__init__(config)
def batch_delete_catalog_objects(self,
body):
"""Does a POST request to /v2/catalog/batch-delete.
Deletes a set of [CatalogItem]($m/CatalogItem)s based on the
provided list of target IDs and returns a set of successfully deleted
IDs in
the response. Deletion is a cascading event such that all children of
the
targeted object are also deleted. For example, deleting a CatalogItem
will
also delete all of its
[CatalogItemVariation]($m/CatalogItemVariation)
children.
`BatchDeleteCatalogObjects` succeeds even if only a portion of the
targeted
IDs can be deleted. The response will only include IDs that were
actually deleted.
To ensure consistency, only one delete request is processed at a time
per seller account.
While one (batch or non-batch) delete request is being processed,
other (batched and non-batched)
delete requests are rejected with the `429` error code.
Args:
body (BatchDeleteCatalogObjectsRequest): An object containing the
fields to POST for the request. See the corresponding object
definition for field details.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/batch-delete')
.http_method(HttpMethodEnum.POST)
.header_param(Parameter()
.key('Content-Type')
.value('application/json'))
.body_param(Parameter()
.value(body))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.body_serializer(APIHelper.json_serialize)
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def batch_retrieve_catalog_objects(self,
body):
"""Does a POST request to /v2/catalog/batch-retrieve.
Returns a set of objects based on the provided ID.
Each [CatalogItem]($m/CatalogItem) returned in the set includes all of
its
child information including: all of its
[CatalogItemVariation]($m/CatalogItemVariation) objects, references
to
its [CatalogModifierList]($m/CatalogModifierList) objects, and the ids
of
any [CatalogTax]($m/CatalogTax) objects that apply to it.
Args:
body (BatchRetrieveCatalogObjectsRequest): An object containing
the fields to POST for the request. See the corresponding
object definition for field details.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/batch-retrieve')
.http_method(HttpMethodEnum.POST)
.header_param(Parameter()
.key('Content-Type')
.value('application/json'))
.body_param(Parameter()
.value(body))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.body_serializer(APIHelper.json_serialize)
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def batch_upsert_catalog_objects(self,
body):
"""Does a POST request to /v2/catalog/batch-upsert.
Creates or updates up to 10,000 target objects based on the provided
list of objects. The target objects are grouped into batches and each
batch is
inserted/updated in an all-or-nothing manner. If an object within a
batch is
malformed in some way, or violates a database constraint, the entire
batch
containing that item will be disregarded. However, other batches in
the same
request may still succeed. Each batch may contain up to 1,000 objects,
and
batches will be processed in order as long as the total object count
for the
request (items, variations, modifier lists, discounts, and taxes) is
no more
than 10,000.
To ensure consistency, only one update request is processed at a time
per seller account.
While one (batch or non-batch) update request is being processed,
other (batched and non-batched)
update requests are rejected with the `429` error code.
Args:
body (BatchUpsertCatalogObjectsRequest): An object containing the
fields to POST for the request. See the corresponding object
definition for field details.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/batch-upsert')
.http_method(HttpMethodEnum.POST)
.header_param(Parameter()
.key('Content-Type')
.value('application/json'))
.body_param(Parameter()
.value(body))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.body_serializer(APIHelper.json_serialize)
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def create_catalog_image(self,
request=None,
image_file=None):
"""Does a POST request to /v2/catalog/images.
Uploads an image file to be represented by a
[CatalogImage]($m/CatalogImage) object that can be linked to an
existing
[CatalogObject]($m/CatalogObject) instance. The resulting
`CatalogImage` is unattached to any `CatalogObject` if the
`object_id`
is not specified.
This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data
requests with a JSON part and an image file part in
JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.
Args:
request (CreateCatalogImageRequest, optional): TODO: type
description here.
image_file (typing.BinaryIO, optional): TODO: type description
here.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/images')
.http_method(HttpMethodEnum.POST)
.multipart_param(Parameter()
.key('request')
.value(APIHelper.json_serialize(request))
.default_content_type('application/json; charset=utf-8'))
.multipart_param(Parameter()
.key('image_file')
.value(image_file)
.default_content_type('image/jpeg'))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def update_catalog_image(self,
image_id,
request=None,
image_file=None):
"""Does a PUT request to /v2/catalog/images/{image_id}.
Uploads a new image file to replace the existing one in the specified
[CatalogImage]($m/CatalogImage) object.
This `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data
requests with a JSON part and an image file part in
JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.
Args:
image_id (str): The ID of the `CatalogImage` object to update the
encapsulated image file.
request (UpdateCatalogImageRequest, optional): TODO: type
description here.
image_file (typing.BinaryIO, optional): TODO: type description
here.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/images/{image_id}')
.http_method(HttpMethodEnum.PUT)
.template_param(Parameter()
.key('image_id')
.value(image_id)
.should_encode(True))
.multipart_param(Parameter()
.key('request')
.value(APIHelper.json_serialize(request))
.default_content_type('application/json; charset=utf-8'))
.multipart_param(Parameter()
.key('image_file')
.value(image_file)
.default_content_type('image/jpeg'))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def catalog_info(self):
"""Does a GET request to /v2/catalog/info.
Retrieves information about the Square Catalog API, such as batch
size
limits that can be used by the `BatchUpsertCatalogObjects` endpoint.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/info')
.http_method(HttpMethodEnum.GET)
.header_param(Parameter()
.key('accept')
.value('application/json'))
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def list_catalog(self,
cursor=None,
types=None,
catalog_version=None):
"""Does a GET request to /v2/catalog/list.
Returns a list of all [CatalogObject]($m/CatalogObject)s of the
specified types in the catalog.
The `types` parameter is specified as a comma-separated list of the
[CatalogObjectType]($m/CatalogObjectType) values,
for example, "`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`,
`CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`".
__Important:__ ListCatalog does not return deleted catalog items. To
retrieve
deleted catalog items, use
[SearchCatalogObjects]($e/Catalog/SearchCatalogObjects)
and set the `include_deleted_objects` attribute value to `true`.
Args:
cursor (str, optional): The pagination cursor returned in the
previous response. Leave unset for an initial request. The
page size is currently set to be 100. See
[Pagination](https://developer.squareup.com/docs/build-basics/c
ommon-api-patterns/pagination) for more information.
types (str, optional): An optional case-insensitive,
comma-separated list of object types to retrieve. The valid
values are defined in the
[CatalogObjectType](entity:CatalogObjectType) enum, for
example, `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`,
`TAX`, `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc. If this is
unspecified, the operation returns objects of all the top
level types at the version of the Square API used to make the
request. Object types that are nested onto other object types
are not included in the defaults. At the current API version
the default object types are: ITEM, CATEGORY, TAX, DISCOUNT,
MODIFIER_LIST, PRICING_RULE, PRODUCT_SET, TIME_PERIOD,
MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION,
CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
catalog_version (long|int, optional): The specific version of the
catalog objects to be included in the response. This allows
you to retrieve historical versions of objects. The specified
version value is matched against the
[CatalogObject]($m/CatalogObject)s' `version` attribute. If
not included, results will be from the current version of the
catalog.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/list')
.http_method(HttpMethodEnum.GET)
.query_param(Parameter()
.key('cursor')
.value(cursor))
.query_param(Parameter()
.key('types')
.value(types))
.query_param(Parameter()
.key('catalog_version')
.value(catalog_version))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def upsert_catalog_object(self,
body):
"""Does a POST request to /v2/catalog/object.
Creates a new or updates the specified
[CatalogObject]($m/CatalogObject).
To ensure consistency, only one update request is processed at a time
per seller account.
While one (batch or non-batch) update request is being processed,
other (batched and non-batched)
update requests are rejected with the `429` error code.
Args:
body (UpsertCatalogObjectRequest): An object containing the fields
to POST for the request. See the corresponding object
definition for field details.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/object')
.http_method(HttpMethodEnum.POST)
.header_param(Parameter()
.key('Content-Type')
.value('application/json'))
.body_param(Parameter()
.value(body))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.body_serializer(APIHelper.json_serialize)
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def delete_catalog_object(self,
object_id):
"""Does a DELETE request to /v2/catalog/object/{object_id}.
Deletes a single [CatalogObject]($m/CatalogObject) based on the
provided ID and returns the set of successfully deleted IDs in the
response.
Deletion is a cascading event such that all children of the targeted
object
are also deleted. For example, deleting a
[CatalogItem]($m/CatalogItem)
will also delete all of its
[CatalogItemVariation]($m/CatalogItemVariation) children.
To ensure consistency, only one delete request is processed at a time
per seller account.
While one (batch or non-batch) delete request is being processed,
other (batched and non-batched)
delete requests are rejected with the `429` error code.
Args:
object_id (str): The ID of the catalog object to be deleted. When
an object is deleted, other objects in the graph that depend
on that object will be deleted as well (for example, deleting
a catalog item will delete its catalog item variations).
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/object/{object_id}')
.http_method(HttpMethodEnum.DELETE)
.template_param(Parameter()
.key('object_id')
.value(object_id)
.should_encode(True))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def retrieve_catalog_object(self,
object_id,
include_related_objects=False,
catalog_version=None,
include_category_path_to_root=False):
"""Does a GET request to /v2/catalog/object/{object_id}.
Returns a single [CatalogItem]($m/CatalogItem) as a
[CatalogObject]($m/CatalogObject) based on the provided ID. The
returned
object includes all of the relevant [CatalogItem]($m/CatalogItem)
information including:
[CatalogItemVariation]($m/CatalogItemVariation)
children, references to its
[CatalogModifierList]($m/CatalogModifierList) objects, and the ids of
any [CatalogTax]($m/CatalogTax) objects that apply to it.
Args:
object_id (str): The object ID of any type of catalog objects to
be retrieved.
include_related_objects (bool, optional): If `true`, the response
will include additional objects that are related to the
requested objects. Related objects are defined as any objects
referenced by ID by the results in the `objects` field of the
response. These objects are put in the `related_objects`
field. Setting this to `true` is helpful when the objects are
needed for immediate display to a user. This process only goes
one level deep. Objects referenced by the related objects will
not be included. For example, if the `objects` field of the
response contains a CatalogItem, its associated
CatalogCategory objects, CatalogTax objects, CatalogImage
objects and CatalogModifierLists will be returned in the
`related_objects` field of the response. If the `objects`
field of the response contains a CatalogItemVariation, its
parent CatalogItem will be returned in the `related_objects`
field of the response. Default value: `false`
catalog_version (long|int, optional): Requests objects as of a
specific version of the catalog. This allows you to retrieve
historical versions of objects. The value to retrieve a
specific version of an object can be found in the version
field of [CatalogObject]($m/CatalogObject)s. If not included,
results will be from the current version of the catalog.
include_category_path_to_root (bool, optional): Specifies whether
or not to include the `path_to_root` list for each returned
category instance. The `path_to_root` list consists of
`CategoryPathToRootNode` objects and specifies the path that
starts with the immediate parent category of the returned
category and ends with its root category. If the returned
category is a top-level category, the `path_to_root` list is
empty and is not returned in the response payload.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/object/{object_id}')
.http_method(HttpMethodEnum.GET)
.template_param(Parameter()
.key('object_id')
.value(object_id)
.should_encode(True))
.query_param(Parameter()
.key('include_related_objects')
.value(include_related_objects))
.query_param(Parameter()
.key('catalog_version')
.value(catalog_version))
.query_param(Parameter()
.key('include_category_path_to_root')
.value(include_category_path_to_root))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def search_catalog_objects(self,
body):
"""Does a POST request to /v2/catalog/search.
Searches for [CatalogObject]($m/CatalogObject) of any type by matching
supported search attribute values,
excluding custom attribute values on items or item variations, against
one or more of the specified query filters.
This (`SearchCatalogObjects`) endpoint differs from the
[SearchCatalogItems]($e/Catalog/SearchCatalogItems)
endpoint in the following aspects:
- `SearchCatalogItems` can only search for items or item variations,
whereas `SearchCatalogObjects` can search for any type of catalog
objects.
- `SearchCatalogItems` supports the custom attribute query filters to
return items or item variations that contain custom attribute values,
where `SearchCatalogObjects` does not.
- `SearchCatalogItems` does not support the `include_deleted_objects`
filter to search for deleted items or item variations, whereas
`SearchCatalogObjects` does.
- The both endpoints have different call conventions, including the
query filter formats.
Args:
body (SearchCatalogObjectsRequest): An object containing the
fields to POST for the request. See the corresponding object
definition for field details.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/search')
.http_method(HttpMethodEnum.POST)
.header_param(Parameter()
.key('Content-Type')
.value('application/json'))
.body_param(Parameter()
.value(body))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.body_serializer(APIHelper.json_serialize)
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def search_catalog_items(self,
body):
"""Does a POST request to /v2/catalog/search-catalog-items.
Searches for catalog items or item variations by matching supported
search attribute values, including
custom attribute values, against one or more of the specified query
filters.
This (`SearchCatalogItems`) endpoint differs from the
[SearchCatalogObjects]($e/Catalog/SearchCatalogObjects)
endpoint in the following aspects:
- `SearchCatalogItems` can only search for items or item variations,
whereas `SearchCatalogObjects` can search for any type of catalog
objects.
- `SearchCatalogItems` supports the custom attribute query filters to
return items or item variations that contain custom attribute values,
where `SearchCatalogObjects` does not.
- `SearchCatalogItems` does not support the `include_deleted_objects`
filter to search for deleted items or item variations, whereas
`SearchCatalogObjects` does.
- The both endpoints use different call conventions, including the
query filter formats.
Args:
body (SearchCatalogItemsRequest): An object containing the fields
to POST for the request. See the corresponding object
definition for field details.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/search-catalog-items')
.http_method(HttpMethodEnum.POST)
.header_param(Parameter()
.key('Content-Type')
.value('application/json'))
.body_param(Parameter()
.value(body))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.body_serializer(APIHelper.json_serialize)
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def update_item_modifier_lists(self,
body):
"""Does a POST request to /v2/catalog/update-item-modifier-lists.
Updates the [CatalogModifierList]($m/CatalogModifierList) objects
that apply to the targeted [CatalogItem]($m/CatalogItem) without
having
to perform an upsert on the entire item.
Args:
body (UpdateItemModifierListsRequest): An object containing the
fields to POST for the request. See the corresponding object
definition for field details.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/update-item-modifier-lists')
.http_method(HttpMethodEnum.POST)
.header_param(Parameter()
.key('Content-Type')
.value('application/json'))
.body_param(Parameter()
.value(body))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.body_serializer(APIHelper.json_serialize)
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def update_item_taxes(self,
body):
"""Does a POST request to /v2/catalog/update-item-taxes.
Updates the [CatalogTax]($m/CatalogTax) objects that apply to the
targeted [CatalogItem]($m/CatalogItem) without having to perform an
upsert on the entire item.
Args:
body (UpdateItemTaxesRequest): An object containing the fields to
POST for the request. See the corresponding object definition
for field details.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/catalog/update-item-taxes')
.http_method(HttpMethodEnum.POST)
.header_param(Parameter()
.key('Content-Type')
.value('application/json'))
.body_param(Parameter()
.value(body))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.body_serializer(APIHelper.json_serialize)
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()