Purpose

To process a complete update of all item data, a two step process is required to first request a signed URL via Google Cloud Services (GCS) and then to submit a CSV file with all item data via PUT request

Method

1.Request a Signed URL

Sending a request to this endpoint with a callbackUrl will return a signedUrl from GCS with specific headers.

2.Submit .csv file via PUT Request

Once a signedUrl is retrieved, the Item upload process is as follows;

• Your Item .csv file should be submitted via a PUT request to the signedUrlwith all the headers provided
• Deliverect will then process the CSV asynchronously and callback to the provided callbackUrl when the CSV file has been fully processed.

Example PUT Request

curl --location --request PUT 'https://storage.googleapis.com/cicd-signed-url/items.csv?x-goog-signature=13d3&x-goog-algorithm=GOOG4-RSA-SHA256&x-goog-credential=signed-url-poc%40test-demo-410111.iam.gserviceaccount.com%2F20240223%2Fasia-south1%2Fstorage%2Fgoog4_request&x-goog-date=20240223T080312Z&x-goog-expires=86400&x-goog-signedheaders=content-type%3Bhost%3Bx-goog-meta-callback%3Bx-goog-meta-user' \
--header 'Content-Type: text/csv' \
--header 'Host: storage.googleapis.com' \
--header 'x-goog-meta-callback: https://example.com/itemsCallback' \
--header 'x-goog-meta-user: your-user-id' \
--header 'x-goog-content-sha256: UNSIGNED-PAYLOAD' \
--data-binary '@items.csv'

Callback Response

{
    "file_id": "a420*******************************725b",
    "status": "success"
}

{
    "file_id": "d0f7*******************************d278",
    "status": "error",
    "errors":
    [
        "No products found in the file. Please check the file and try again."
    ]
}

Parameters

Item CSV Format

A single Item CSV is expected with below showing a complete example. This file can include the additional columns allowing Bundles and Translateable elements to be specified, which are shown in specific sample files below;

Item Groups

The CSV supports two types of item grouping for Deals (selection of bundled products) and Modifier Groups (list of modifier options)

Product Types

Item groups are configured using values in the Product Type column.

Selection Rules

Rules can be applied to both DEALSECTION and MODIFIER_GROUP records to control how customers make selections.

These rules can be combined to enforce required selections, limit customer choices, and control the quantity of individual items or modifiers that can be added.

Translations

The translatable elements for products are "Name" & "Description" and should be added as seperate columns with an ISO-639-1 language code appended e.g. Name.fr / Description.fr language codes supported listed in the link below;

CSV Data - Glossary