BigCommerce API - Undefined Resource Property - Banners :: item_id - bigcommerce

I am working with the BigCommerce API for the Banners resource, but I do not know the usage/definition for one of the properties - specifically: item_id
The usage documentation shows the following as the JSON response:
{
"id": "1",
"name": "Grand Closing Sale",
"page": "home_page",
"content": "Thanks for shopping with us.",
"date_to": "1393218000",
"item_id": "0",
"visible": "0",
"location": "top",
"date_from": "1391576400",
"date_type": "custom",
"date_created": "1392073898"
},
The property documentation however makes no reference to item_id (and also has other various typos and unlinked properties).
What is item_id?
Is it maybe supposed to be catorbrandid, which says "ID for the brand or category."
Thanks in advance!

Related

Shopify Order Updated Events Within The Same Timestamp

This question was originally asked in the shopify community, but without any response. So sorry for those of you reading this as duplicate.
We are trying to strengthen our Shopify webhook receiver and reconciliation jobs. The json object below show a list of events from an order we have processed. Examine the created_at timestamps show that 3 events was triggered within the same timestamp.
I assume that 3 webhooks are fired on topic orders/updated and the order updated_at timestamp is 2022-04-26T11:10:57+02:00 after the 3 events.
In the case where the first, of the 3, orders/updated hooks fails on our side, and retried by shopify. How can we make sure that we have the latest event, since comparing the order updated_at timestamp would properly be the same for all 3 events?
We are facing a similar issue with our reconciliation job, since we are comparing the order updated_at timestamp. as an example, if we received the first and second hooks from the example sequence below, the reconciliation job would compare updated_at timestamp and skip the rescue! How can we overcome this, without sync all orders in our reconciliation jobs?
We run the reconciliation jobs once a day and sync all orders by that job is not possible within the rate limit of 2 calls/sec for the REST API.
Thanks in advance
Mads
{
"events": [
{...},
{
"id": 90448362045627,
"subject_id": 1000,
"created_at": "2022-04-26T11:10:53+02:00",
"subject_type": "Order",
"verb": "fulfillment_success",
"arguments": [
],
"body": null,
"message": "CoolRunner fulfilled 1 item ",
"author": "CoolRunner",
"description": "CoolRunner fulfilled 1 item ",
"path": "/admin/orders/1000/fulfillments/3862202974395"
},
{
"id": 90448362275003,
"subject_id": 1000,
"created_at": "2022-04-26T11:10:54+02:00",
"subject_type": "Order",
"verb": "mail_sent",
"arguments": [
],
"body": null,
"message": "CoolRunner sent a shipping confirmation email ",
"author": "CoolRunner",
"description": "CoolRunner sent a shipping confirmation email",
"path": "/admin/orders/1000"
},
{
"id": 90448363258043,
"subject_id": 1000,
"created_at": "2022-04-26T11:10:57+02:00",
"subject_type": "Order",
"verb": "capture_success",
"arguments": [
],
"body": null,
"message": "CoolRunner captured €99.00 EUR using a Mastercard ",
"author": "CoolRunner",
"description": "CoolRunner captured €99.00 EUR using a Mastercard ",
"path": "/admin/orders/1000/transactions/5355897323707"
},
{
"id": 90448363389115,
"subject_id": 1000,
"created_at": "2022-04-26T11:10:57+02:00",
"subject_type": "Order",
"verb": "payments_charge",
"arguments": [
],
"body": null,
"message": "-",
"author": "CoolRunner",
"description": "-",
"path": "/admin/orders/1000"
},
{
"id": 90448363421883,
"subject_id": 1000,
"created_at": "2022-04-26T11:10:57+02:00",
"subject_type": "Order",
"verb": "closed",
"arguments": [],
"body": null,
"message": "This order was archived.",
"author": "Shopify",
"description": "This order was archived.",
"path": "/admin/orders/1000"
}
]
}
Not sure I understand your problem, but you have to understand, if you choose to function via handling webhooks, things like temporal ordering go out the window. You have to code for that. You will never have a guarantee that any one webhook will arrive in any kind of order. So you just process them and move on.
So if an order undergoes three updates, 1, 2, and 3, you might receive webhook notifications in the order 3,2,1 or 1,3,2, or 2,3,1 or 1,2,3 or 3,1,2 etc.
So you have exposed two problems. One, you are trusting Webhooks are a source of temporal truth and, two, you are painting yourself into a corner by not doing your API coding to respect API limits.
My advice to you is to accept webhooks when they arrive, process them, and improve your code so API limits are not holding you back.

Can we enable Save Card option with Pay By Link [POST] method

I'm working on Global Payments system and trying to achieve Pay By Link http post method to generate the link and share with customer to pay at their convenient time. In the sandbox url below request body is working fine.
{
"SHA1HASH": "606ab12bb09f5e68b1d72ce26622650d485583fd",
"TIMESTAMP": "20210612042252",
"MERCHANT_ID": "somehotel",
"ACCOUNT": "internet",
"ORDER_ID": "5ef1c1ce6da546069998744bdce3d8c9",
"AMOUNT": "2000",
"CURRENCY": "EUR",
"AUTO_SETTLE_FLAG": "1",
"COMMENT1": "Email Channel",
"HPP_VERSION": "2",
"HPP_LANG": "en",
"HPP_CUSTOMER_EMAIL": "somebody#gmail.com",
"HPP_CUSTOMER_PHONENUMBER_MOBILE": "91|9999999999",
"HPP_BILLING_STREET1": "Flat 123",
"HPP_BILLING_STREET2": "House 456",
"HPP_BILLING_STREET3": "Unit 4",
"HPP_BILLING_CITY": "Halifax",
"HPP_BILLING_POSTALCODE": "W5 9HR",
"HPP_BILLING_COUNTRY": "826",
"HPP_SHIPPING_STREET1": "Apartment 852",
"HPP_SHIPPING_STREET2": "Complex 741",
"HPP_SHIPPING_STREET3": "House 963",
"HPP_SHIPPING_CITY": "Chicago",
"HPP_SHIPPING_STATE": "IL",
"HPP_SHIPPING_POSTALCODE": "50001",
"HPP_SHIPPING_COUNTRY": "840",
"HPP_ADDRESS_MATCH_INDICATOR": "FALSE",
"HPP_CHALLENGE_REQUEST_INDICATOR": "NO_PREFERENCE",
"BILLING_CODE": "59|123",
"BILLING_CO": "GB",
"SHIPPING_CODE": "50001|Apartment 852",
"SHIPPING_CO": "US",
"CUST_NUM": "6e027928-c477-4689-a45f-4e138a1f208a",
"VAR_REF": "Acme Corporation",
"PROD_ID": "SKU1000054",
"MERCHANT_RESPONSE_URL": "https://www.example.com/responseUrl",
"SUPPLEMENTARY_DATA": "Custom Value"
}
Is there a way to enable Save Card option. I tried providing the below flags as seen on another payment reference, but the response started giving hash error.
Request Body included below
"CARD_STORAGE_ENABLE": "1",
"OFFER_SAVE_CARD": "1",
"PAYER_EXIST": "0",
"PAYER_REF": "376a2598-412d-4805-9f47-c177d5605853",
"PMT_REF": "ca46344d-4292-47dc-9ced-e8a42ce66977",
And the response from server
{
"resultCode":508,
"internalErrorCode":61000,
"errorMessage":"Incorrect hash. Please check your code and the Developers Documentation."
}
Is this a restriction by purpose or are we passing wrong flags? Please help!
These are the two sections from the developer portal describing how to generate the hash:
Card Payments: https://developer.globalpay.com/hpp/card-payments#generate-hash
Card Storage: https://developer.globalpay.com/hpp/card-storage#generate-hash

BigCommerce Orders API: unable to update

I'm trying to update an existing order in the store using PUT requests to the V2 orders API:
https://api.bigcommerce.com/stores/{$$.env.store_hash}/v2/orders/{id}
According to the docs, I should be able to update the following:
customer_id, status_id, Add a new product, Add a custom product, billing_address
The only thing I have success changing is the status_id. I can use the example body provided at the bottom of the documentation page:
{
"status_id": 1,
"billing_address": {
"first_name": "Trisha",
"last_name": "McLaughlin",
"company": "",
"street_1": "123 Main Street",
"street_2": "",
"city": "Anywhere",
"state": "Some State",
"zip": "12345",
"country": "United States",
"country_iso2": "US",
"phone": "",
"email": "elsie#example.com"
}
}
I get a 200 OK response with no body. But in the store only the status changes. If I intentionally misspell a field, then I get an error response, which suggests to me that the body is correctly formatted, but ignored.
Can anyone provide an example of a body that updates billing address or adds a new product which the API will act on?
I'm generating the PUT requests with Postman currently, but will move to PHP later.
Thanks.
Edit:
This is an example of a request I tried for adding an existing product, also accepted but doesn't work.
{
"products": [{
"product_id": 111,
"quantity": 5
}]
}
Edit 2: To provide more context, the orders I'm trying to update already have existing products and have been 'paid for' (the products are free). I've tried adding products that are already in the order as well as new ones. I've tried this on orders with various status as well. Also, the orders are processed by guest accounts, so the customer_id field is 0. I have not tried doing this with a registered account order. Could any of these things be causing the issue?
Edit 3: For anyone else wandering by, this appears to be a bug that is associated with downloadable products. Please see the comment chain under the accepted answer for details.
Add a new product:
{
"products": [{
"name": "Poster",
"quantity": 5,
"price_inc_tax": 12.45,
"price_ex_tax": 10.12
}]
}
Add an existing product: Make sure to update the product_id to one that is in the store.
{
"products": [{
"product_id": 187,
"quantity": 5,
"price_inc_tax": 12.45,
"price_ex_tax": 10.12
}]
}
It will return a 200. Then query the Order Products to see a list of products on the order.
To update a billing address this structure works:
{
"billing_address": {
"first_name": "Jane",
"last_name": "Doe",
"company": "",
"street_1": "455 Main Street",
"street_2": "",
"city": "Austin",
"state": "Texas",
"zip": "78751",
"country": "United States",
"country_iso2": "US",
"phone": "",
"email": "rick#sanchez.com"
}
}
Customer id needs to match a customer id that exists in the store. To get a list of customers use the customers endpoint.
{
"customer_id": 20
}
According to this page:
https://developer.bigcommerce.com/api-reference/b3A6MzU5MDQ3MzE-update-an-order
it states:
"The status will include one of the (string, options) - values defined under Order Statuses. This value is read-only. Do not attempt to modify or set this value in a POST or PUT operation."
It appears you cannot update the order status from the api...

HERE Places API: not all items have PVID

I'm using HERE Places API.
Firstly I'm doing a search.
For Example this query :
https://places.cit.api.here.com/places/v1/discover/search?q=Test&at=35.6111,-97.5467&r=500&size=1&app_id=DemoAppId01082013GAL&app_code=AJKnXv84fjrb0KIHawS0Tg&show_refs=pvid&pretty
According to this documentation (Link) If I add show_refs=pvid to query string, in result I will get external id which I can use to query lookup endpoint.
But in result I get next response :
{
"results": {
"next": "https://places.cit.api.here.com/places/v1/discover/search;context=Zmxvdy1pZD1hY2ExNzk3NC0zYzg3LTU5NzQtYmZkMC04YjAzMDZlYWIzMWJfMTUwNjA3NjMzMTYyMl83NDY3XzM4NTAmb2Zmc2V0PTEmc2l6ZT0x?at=35.6111%2C-97.5467&q=Test&app_id=DemoAppId01082013GAL&app_code=AJKnXv84fjrb0KIHawS0Tg",
"items": [
{
"position": [
35.60369,
-97.51761
],
"distance": 2756,
"title": "Southwest Test & Balance",
"averageRating": 0,
"category": {
"id": "business-services",
"title": "Business & Services",
"href": "https://places.cit.api.here.com/places/v1/categories/places/business-services?app_id=DemoAppId01082013GAL&app_code=AJKnXv84fjrb0KIHawS0Tg",
"type": "urn:nlp-types:category",
"system": "places"
},
"icon": "https://download.vcdn.cit.data.here.com/p/d/places2_stg/icons/categories/02.icon",
"vicinity": "200 NW 132nd St<br/>Oklahoma City, OK 73114",
"having": [],
"type": "urn:nlp-types:place",
"href": "https://places.cit.api.here.com/places/v1/places/8403fv6k-d1b2fde0616e0326e321a54b88cd9f53;context=Zmxvdy1pZD1hY2ExNzk3NC0zYzg3LTU5NzQtYmZkMC04YjAzMDZlYWIzMWJfMTUwNjA3NjMzMTYyMl83NDY3XzM4NTAmcmFuaz0w?app_id=DemoAppId01082013GAL&app_code=AJKnXv84fjrb0KIHawS0Tg",
"id": "8403fv6k-d1b2fde0616e0326e321a54b88cd9f53",
"authoritative": true
}
]
},
"search": {
"context": {
"location": {
"position": [
35.6111,
-97.5467
],
"address": {
"text": "Oklahoma City, OK 73134<br/>USA",
"postalCode": "73134",
"city": "Oklahoma City",
"county": "Oklahoma",
"stateCode": "OK",
"country": "United States",
"countryCode": "USA"
}
},
"type": "urn:nlp-types:place",
"href": "https://places.cit.api.here.com/places/v1/places/loc-dmVyc2lvbj0xO3RpdGxlPU9rbGFob21hK0NpdHk7bGF0PTM1LjYxMTE7bG9uPS05Ny41NDY3O2NpdHk9T2tsYWhvbWErQ2l0eTtwb3N0YWxDb2RlPTczMTM0O2NvdW50cnk9VVNBO3N0YXRlQ29kZT1PSztjb3VudHk9T2tsYWhvbWE7Y2F0ZWdvcnlJZD1jaXR5LXRvd24tdmlsbGFnZTtzb3VyY2VTeXN0ZW09aW50ZXJuYWw;context=c2VhcmNoQ29udGV4dD0x?app_id=DemoAppId01082013GAL&app_code=AJKnXv84fjrb0KIHawS0Tg"
}
}
}
In response no object references
Is it a bug or not every place has this external id?
I am responding as member of the team around HERE Places API.
Yes, not every place has a pvid. That is why I would suggest using the Sharing Id instead. I realize that the documentation should be improved to clarify that.
The Sharing Ids can be obtained by adding show_refs=sharing to either your search query or a place details request. It can be found in the field references. Once you have the sharing id you can you the lookup endpoint as you intended.
Take a look at:
https://places.cit.api.here.com/places/v1/places/8403fv6k-d1b2fde0616e0326e321a54b88cd9f53;context=Zmxvdy1pZD00YWU2ZWZjNi01ZjgzLTUwYTQtOTI4OS0xZjliMGMwNWY3NjBfMTUwNzA0NDE0OTc3NV84MTI5XzU1NDcmcmFuaz0w?app_id=DemoAppId01082013GAL&app_code=AJKnXv84fjrb0KIHawS0Tg&show_refs=pvid
and
https://places.cit.api.here.com/places/v1/places/8409q8yy-6af3c3e50bcb4f859686797b2be5773d;context=Zmxvdy1pZD00YWU2ZWZjNi01ZjgzLTUwYTQtOTI4OS0xZjliMGMwNWY3NjBfMTUwNzA0NDE0OTc3NV84MTI5XzU1NDcmcmFuaz0w?app_id=DemoAppId01082013GAL&app_code=AJKnXv84fjrb0KIHawS0Tg&show_refs=pvid
On those two examples, the only difference is the placeId.
In the docs, there's not a single reference saying that the external identifier is required or existant for every place.
Since it represents an external identifier, I believe we could assume that it's not required.
And it's what we just saw with your place (8403fv6k-d1b2fde0616e0326e321a54b88cd9f53): this one don't have any external identifier.
Based on your comments, what you need is the information about a place.
So, after you run your first query, you should get something like:
{
title: "Southwest Test & Balance",
position: [],
id: "8403fv6k-d1b2fde0616e0326e321a54b88cd9f53",
href: "https://[...]"
}
With this ID, you could access it:
places.cit.api.here.com/places/v1/places/8403fv6k-d1b2fde0616e0326e321a54b88cd9f53;context=Zmxvdy1pZD0zYTFlZjg5ZS02ZTY5LTUxYmEtYWFkYS1kY2UwZWMyNDdkMDBfMTUwNzEzNjUxNjI5N182NjExXzc2OTgmcmFuaz0w?app_id=DemoAppId01082013GAL&app_code=AJKnXv84fjrb0KIHawS0Tg
Or directly using the href information.
This response already is giving you the ID and URL to access all the info of a single place.
You don't need any other external ID or reference.

customer Id not return in shopify cart webhook

The Shopify cart webhook is not returning customer id. so we can't able to identify which user added the product to cart.
How can we achieve this?
I think you can't get the customer id from that webhook and the point is that a cart can be created by a registered customer or an unregistered customer as well so in this last case Shopify doesn't know the customer id yet.
Also the example response included in the documentation doesn't include the customer id.
{
"id": "eeafa272cebfd4b22385bc4b645e762c",
"token": "eeafa272cebfd4b22385bc4b645e762c",
"line_items": [
{
"id": 1234567,
"properties": {
},
"quantity": 3,
"variant_id": 1234567,
"key": "1234567:f816dcc3b2e26822a28626a786eac953",
"title": "Example T-Shirt - ",
"price": "19.99",
"original_price": "19.99",
"discounted_price": "19.99",
"line_price": "59.97",
"original_line_price": "59.97",
"total_discount": "0.00",
"discounts": [
],
"sku": "example-shirt-s",
"grams": 200,
"vendor": "Acme",
"product_id": 327475578523353102,
"gift_card": false
}
]
}
You can probably get the customer id using the checkout webhook but without knowing your requirements I can't say this will work for you.
I recommend you to open another question and provide more information on your requirement.