Order payload doesn't have category and line items in Order doesn't have category. How do I get category?

Question

question

anayooleru asked Jul 23, '23 parquet76 edited Jul 24, '23

Order payload doesn't have category and line items in Order doesn't have category. How do I get category?

Orders


  {
            "href": '*********',
            "id": '*********',
            "currency": "USD",
            "employee": {
                "id": '*********'
            },
            "total": 1320,
            "paymentState": "OPEN",
            "title": '*********',
            "taxRemoved": false,
            "isVat": false,
            "state": "OPEN",
            "manualTransaction": false,
            "groupLineItems": false,
            "testMode": false,
            "createdTime": 1689957967000,
            "clientCreatedTime": 1689957967000,
            "modifiedTime": 1689958270000,
            "lineItems": {
                "elements": [
                    {
                        "id": '*********',
                        "orderRef": {
                            "id": '*********'
                        },
                        "item": {
                            "id": '*********'
                        },
                        "colorCode": "#FF0080",
                        "name": '*********',
                        "price": 1200,
                        "printed": false,
                        "createdTime": 1689957967000,
                        "orderClientCreatedTime": 1689957967000,
                        "exchanged": false,
                        "refunded": false,
                        "isRevenue": true
                    }
                ]
            }
        }

Orders

10 |2000

Attachments: Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Welcome to the
Clover Developer Community

Answer 1 · 2023-07-23T20:09:00Z

parquet76 answered Jul 23, '23 parquet76 edited Jul 23, '23

expand=lineItems.item.categories

https://community.clover.com/idea/38785/to-avoid-api-call-hit-rate-limit-by-allow-more-inf.html

10 |2000

Attachments: Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Answer 2 · 2023-07-23T20:30:42Z

anayooleru answered Jul 23, '23 parquet76 edited Jul 24, '23

Thanks @parquet76.

How can I expand to get the vendor(the store the items were bought from) details,(name, image/logo, category, address)?

And to get the quantity of each list item?

10

10 |2000

Attachments: Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

parquet76 commented · Jul 23, 2023 at 08:58 PM

You don't want to retrieve merchant data each time you make an orders request, that would be wasteful. You should use the merchant endpoints to get that data once (or maybe once a day) as it is relatively static.

For quantity of an item you need to look at the line items. If an order has N quantity of an item there will be N line items (if order has three hot dogs there will be three hot dog line items), the unitQuantity field only applies if an item is priced by unit (grams, ounces, etc.).

0 ·

anayooleru parquet76 commented · Jul 23, 2023 at 10:40 PM

Each time there is an order, in my webhook, I want to return the specific Order details(which I have been able to), and the merchant(or store) details where the order was made from (I need to know how to do this, expand merchant isn't working)

https://sandbox.dev.clover.com/v3/merchants/*****

Returns the Merchant I created for my account.

I hope you understand what I am trying to explain?

0 ·

parquet76 anayooleru commented · Jul 23, 2023 at 10:50 PM

As I said, you need to use the merchant end point to get merchant information. So, you will need to make two calls. It is completely unnecessary to get the merchant information every time there is a new order. I would recommend caching/storing that data to reduce the API calls you have to make.

0 ·

Show more comments

question