From 1fc343f29fd0f9c2264548d8e017210fdd345cef Mon Sep 17 00:00:00 2001 From: A-Guiu Date: Tue, 13 Feb 2024 19:24:37 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20main=20from=20@=20ankorstore/a?= =?UTF-8?q?nkorstore@c3ac2944a74c5fc88ebb6a0f66c689a1003dec59=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pull/38742/index.html | 296 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 292 insertions(+), 4 deletions(-) diff --git a/pull/38742/index.html b/pull/38742/index.html index 5ff1d5f..8275eba 100644 --- a/pull/38742/index.html +++ b/pull/38742/index.html @@ -520,7 +520,7 @@ -
Ankorstore
API docs by Redocly
Ankorstore
API docs by Redocly
}

More details can be found in the endpoint specification

+

ℹ️ℹ️ℹ️ WIP ℹ️ℹ️ℹ️ 💡 Working with Catalog Integrations

ℹ️ℹ️ℹ️ WIP ℹ️ℹ️ℹ️ 💡 Working with Catalog Integrations

ℹ️ℹ️ℹ️ WIP ℹ️ℹ️ℹ️ 💡 Listing current Catalog Integrations

/api/v1/catalog/integrations

Returns a list of current Catalog Integrations for the authenticated Brand.

@@ -1672,6 +1817,149 @@

ℹ️ℹ️ℹ️ WIP ℹ️ℹ️ℹ️ 💡 Listing Products related to an specific Operation from a Catalog Integration

GET /api/v1/catalog/integrations/:IntegrationUrlId/products/:OperationUrlId/products

Returns a list of Products affected by an specific Operation made in the context of a Catalog Integration

+

ℹ️ℹ️ℹ️ WIP ℹ️ℹ️ℹ️ 💡 Working with Catalog Integrations

+

ℹ️ℹ️ℹ️ WIP ℹ️ℹ️ℹ️ 💡 Listing current Catalog Integrations

+

/api/v1/catalog/integrations

+

Returns a list of current Catalog Integrations for the authenticated Brand.

+ +

/api/v1/catalog/integrations/:IntegrationUrlId/products

+

Returns a list of current Products related to an specific Catalog Integration.

+ +

DELETE /api/v1/catalog/integrations/:IntegrationUrlId/products/:OperationUrlId

+

Delete the Product Integration provided as parameter

+
    +
  • This action affects at the product as a whole entity.
    • +
  • In order to delete related variants, images or any other property related to the product, please perform an update Operation
    • +
+ +

GET /api/v1/catalog/integrations/:IntegrationUrlId/operations

+

Returns a list of Operations performed within the context of an specific Integration

+

💡 Creating a new Operation to perform within a Catalog Integration context

+
    +
  • First operation for each Catalog Integration MUST be of type import
    • +
  • One and only one Operation of type import is allowed
    • +
  • Ongoing Operations MUST be of type update
    • +
+

Example of the payload to create an Operation for multiple products:

+

POST /api/v1/catalog/integrations/:IntegrationUrlId/operations

+
{
+    "chunk": 1,
+    "totalChunks": 1,
+    "callbackUrl": "https://callback.url/called/after/processing",
+    "operationType": "import",
+    "products": [
+        {
+            "external_id": "a12aef05-7c20-4efb-a336-ea53be904d0e",
+            "name": "Example product 1",
+            "tags": [
+                "tags_fresh_product",
+                "tags_frozen_product",
+                "tags_organic",
+                "tags_handmade",
+                "tags_eco_friendly",
+                "tags_zero_waste",
+                "tags_cruelty_free",
+                "tags_bestseller",
+                "tags_vegan",
+                "tags_contains_alcohol"
+            ],
+            "main_image": "https://url.of/product_main_image.png",
+            "images": [
+                {
+                    "order": 2,
+                    "url": "https://image.2/"
+                },
+                {
+                    "order": 3,
+                    "url": "https://image.3/"
+                },
+                {
+                    "order": 4,
+                    "url": "https://image.4/"
+                }
+            ],
+            "hs_code": 123456,
+            "currency": "EUR",
+            "vat_rate": 20.0,
+            "description": "This is an example of product description received in the payload.",
+            "discount_rate": 0.0,
+            "product_type_id": 1234,
+            "retail_price": 25.0,
+            "wholesale_price": 20.0,
+            "made_in_country": "ES",
+            "shape_properties": {
+                "dimensions": {
+                    "unit_code": "cm",
+                    "width": 10,
+                    "height": 10,
+                    "length": 10
+                },
+                "capacity": {
+                    "unit_code": "L",
+                    "amount": 1
+                },
+                "weight": {
+                    "unit_code": "kg",
+                    "amount": 1
+                }
+            },
+            "variants": [
+                {
+                    "ian": 1234567890123,
+                    "sku": "Example SKU",
+                    "external_id": "747476f8-e268-4fab-9788-7f7752f61095",
+                    "discount_rate": 0.0,
+                    "retail_price": 25.0,
+                    "wholesale_price": 20.0,
+                    "shape_properties": {
+                        "dimensions": {
+                            "unit_code": "cm",
+                            "width": 10,
+                            "height": 10,
+                            "length": 10
+                        },
+                        "capacity": {
+                            "unit_code": "L",
+                            "amount": 1
+                        },
+                        "weight": {
+                            "unit_code": "kg",
+                            "amount": 1
+                        },
+                        "options": [
+                            {
+                                "nane": "size",
+                                "value": "XXL"
+                            },
+                            {
+                                "nane": "color",
+                                "value": "blue"
+                            }
+                        ],
+                        "images": [
+                            {
+                                "order": 1,
+                                "url": "https://image.1/"
+                            },
+                            {
+                                "order": 2,
+                                "url": "https://image.2/"
+                            },
+                            {
+                                "order": 3,
+                                "url": "https://image.3/"
+                            }
+                        ]
+                    }
+                }
+            ]
+        }
+    ]
+}
+
+ +

GET /api/v1/catalog/integrations/:IntegrationUrlId/products/:OperationUrlId/products

+

Returns a list of Products affected by an specific Operation made in the context of a Catalog Integration

List Products

Request samples

Content type
application/vnd.api+json
Example
{
  • "order": {
    • "trackingProvider": "ups",
    • "trackingNumber": "123456"
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "order",
    • "id": "1ecb023e-7ec0-6d5c-a477-0242ac170007",
    • "attributes": {
      • "status": "brand_confirmed",
      • "reference": 3434273911,
      • "brandCurrency": "EUR",
      • "brandNetAmount": 10229,
      • "brandTotalAmount": 10940,
      • "brandTotalAmountVat": 602,
      • "brandTotalAmountWithVat": 11542,
      • "brandRejectReason": null,
      • "retailerRejectReason": null,
      • "retailerCancellationRequestReason": null,
      • "billingName": "Charles Attan",
      • "billingOrganisationName": "Jumbo",
      • "billingStreet": "Kortricklaan 101",
      • "billingPostalCode": "8121 GW",
      • "billingCity": "Arnhem",
      • "billingCountryCode": "NL",
      • "submittedAt": "2022-03-17T13:19:33+00:00",
      • "shippedAt": null,
      • "brandPaidAt": null,
      • "createdAt": "2022-02-01T14:37:10+00:00",
      • "updatedAt": "2022-03-31T15:10:07+00:00",
      • "shippingMethod": "custom",
      • "shippingOverview": {
        }
      }
    }
}