From d3de6ba1f8827c7f97d9e81f9d079ed10b1dfa2c Mon Sep 17 00:00:00 2001 From: julia-rabello <77292838+julia-rabello@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:45:46 -0300 Subject: [PATCH 1/3] update profileId and alternativeKey fields --- VTEX - Profile System.json | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/VTEX - Profile System.json b/VTEX - Profile System.json index 1f0ada7f4..091e886a6 100644 --- a/VTEX - Profile System.json +++ b/VTEX - Profile System.json @@ -3588,7 +3588,7 @@ "profileId": { "name": "profileId", "in": "path", - "description": "ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "description": "There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "required": true, "style": "simple", "schema": { @@ -3643,12 +3643,16 @@ "alternativeKey": { "name": "alternativeKey", "in": "query", - "description": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "description": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "required": false, "style": "form", "schema": { "type": "string", - "example": "email" + "example": "email", + "enum": [ + "email", + "document" + ] } }, "ttl": { From fb57dd97d02c3e07b3fcdeca1cd9b2d23a72008b Mon Sep 17 00:00:00 2001 From: julia-rabello <> Date: Fri, 22 Nov 2024 19:49:05 +0000 Subject: [PATCH 2/3] Update generated files by portman --- PostmanCollections/VTEX - Profile System.json | 2826 +++++------------ 1 file changed, 817 insertions(+), 2009 deletions(-) diff --git a/PostmanCollections/VTEX - Profile System.json b/PostmanCollections/VTEX - Profile System.json index 7cf5b7db4..5b1702afa 100644 --- a/PostmanCollections/VTEX - Profile System.json +++ b/PostmanCollections/VTEX - Profile System.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "ff72acb7-69a2-48d3-8834-856cbeb4c7e2" + "postman_id": "c1043b9a-592c-453e-97fa-a2fe30ec953b" }, "item": [ { - "id": "1961b98b-6ff5-4bff-8191-52719eab1cd7", + "id": "00c76bbd-4c95-42e8-aedd-fd9f9be347a7", "name": "Profiles", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "74418b42-e515-45b1-8719-ddd2f075164b", + "id": "d5716a80-a157-464d-af65-924089d57167", "name": "Create client profile", "request": { "name": "Create client profile", @@ -41,26 +41,7 @@ "value": "365" } ], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -80,6 +61,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -88,6 +77,7 @@ "raw": "{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"document\": \"12345678900\",\n \"documentType\": \"CPF\",\n \"birthDate\": \"1925-11-17\",\n \"{customField}\": \"{value}\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -98,7 +88,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3c23bf45-c924-4076-ac92-114660c5952b", + "id": "e8845406-99d0-4cb7-82f9-8d41e9ff18e6", "name": "Created", "originalRequest": { "url": { @@ -113,40 +103,18 @@ ], "query": [ { - "key": "ttl", - "value": "365" - } - ], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "This parameter sets the the Time To Live (TTL), in days, of the specific document being created or updated with this request. After this period of time from the moment of the request, the document is deleted. By sending this parameter you override the TTL set for the schema.\n\r\n\r> Currently, the available default document schemas have no TTL. This means that documents are stored indefinitely, unless a TTL is sent when creating or updating.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "ttl", + "value": "365" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -165,9 +133,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -176,6 +156,7 @@ "raw": "{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"document\": \"12345678900\",\n \"documentType\": \"CPF\",\n \"birthDate\": \"1925-11-17\",\n \"{customField}\": \"{value}\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -197,13 +178,13 @@ { "listen": "test", "script": { - "id": "edb45467-3147-4363-9668-19a27a5aa3e4", + "id": "38429675-3cc7-497e-8e0a-e1eecc85fc7f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/storage/profile-system/profiles - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/storage/profile-system/profiles - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/storage/profile-system/profiles - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\",\"example\":\"John\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\",\"example\":\"Doe\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\",\"example\":\"john.doe@example.com\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\",\"example\":\"1925-11-17\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\",\"example\":\"12345678900\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\",\"example\":\"CPF\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\",\"example\":\"{value}\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/storage/profile-system/profiles - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/storage/profile-system/profiles - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -213,7 +194,7 @@ } }, { - "id": "29ade4bc-0625-4a48-9154-b429a864a623", + "id": "757d47e1-be84-4776-9680-7a18051ecc78", "name": "Get profile", "request": { "name": "Get profile", @@ -236,7 +217,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -247,30 +228,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -292,16 +255,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "741a1e59-c215-4b0f-95d4-2fb8e0bf8361", + "id": "fb2462e6-918a-44ae-9227-7e8df112523c", "name": "OK", "originalRequest": { "url": { @@ -317,50 +285,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -382,6 +318,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -403,13 +347,13 @@ { "listen": "test", "script": { - "id": "6154e296-c7f3-4e86-b2c4-9d8776a033b4", + "id": "292b1862-0ba0-4a47-b315-c45590a10f67", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Masked profile response\",\"type\":\"array\",\"description\":\"Array containing masked profile information.\",\"items\":{\"type\":\"object\",\"description\":\"Masked profile information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\",\"example\":\"John\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\",\"example\":\"Doe\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\",\"example\":\"john.doe@example.com\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\",\"example\":\"1925-11-17\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\",\"example\":\"12345678900\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\",\"example\":\"CPF\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\",\"example\":\"{value}\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Masked profile response\",\"type\":\"array\",\"description\":\"Array containing masked profile information.\",\"items\":{\"type\":\"object\",\"description\":\"Masked profile information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -419,7 +363,7 @@ } }, { - "id": "5d0a9532-9954-4346-933d-7914e2c29230", + "id": "0f0d9f1e-f536-4f7d-9484-e81ba8b1919d", "name": "Update client profile", "request": { "name": "Update client profile", @@ -442,7 +386,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -462,30 +406,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -507,6 +433,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PATCH", @@ -515,6 +449,7 @@ "raw": "{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"document\": \"12345678900\",\n \"documentType\": \"CPF\",\n \"birthDate\": \"1925-11-17\",\n \"{customField}\": \"{value}\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -525,7 +460,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5e9a6c23-a933-41a8-aa4e-8f6074282d82", + "id": "bbfe0aa0-b933-4b31-af38-b92ef3b3a7b6", "name": "OK", "originalRequest": { "url": { @@ -541,54 +476,27 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - }, - { - "key": "ttl", - "value": "365" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { + "disabled": true, "description": { - "content": "Name of the VTEX account. Used as part of the URL.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" + "key": "alternativeKey", + "value": "email" }, { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "This parameter sets the the Time To Live (TTL), in days, of the specific document being created or updated with this request. After this period of time from the moment of the request, the document is deleted. By sending this parameter you override the TTL set for the schema.\n\r\n\r> Currently, the available default document schemas have no TTL. This means that documents are stored indefinitely, unless a TTL is sent when creating or updating.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "ttl", + "value": "365" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -607,9 +515,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PATCH", @@ -618,6 +538,7 @@ "raw": "{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"document\": \"12345678900\",\n \"documentType\": \"CPF\",\n \"birthDate\": \"1925-11-17\",\n \"{customField}\": \"{value}\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -639,13 +560,13 @@ { "listen": "test", "script": { - "id": "087f288f-2ea1-4bf8-ba8d-8371cdaf52a9", + "id": "cefaefd8-6614-4456-a805-2984084c6a94", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Unmasked profile response\",\"type\":\"object\",\"description\":\"Unmasked profile response.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\",\"example\":\"John\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\",\"example\":\"Doe\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\",\"example\":\"john.doe@example.com\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\",\"example\":\"1925-11-17\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\",\"example\":\"12345678900\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\",\"example\":\"CPF\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\",\"example\":\"{value}\"}}},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Unmasked profile response\",\"type\":\"object\",\"description\":\"Unmasked profile response.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\"}}},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -655,7 +576,7 @@ } }, { - "id": "b0288e31-523f-40b0-9037-da30bca0b4ac", + "id": "29ea5b92-587a-4dd0-a00e-7f067573c71b", "name": "Delete client profile", "request": { "name": "Delete client profile", @@ -679,30 +600,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -726,14 +629,15 @@ "value": "application/json" } ], - "method": "DELETE" + "method": "DELETE", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "9e50c13f-ab2d-437e-bc3f-f25576e4fa1f", + "id": "d9acb9e4-5c79-43f1-ab75-c40944fddc72", "name": "No content", "originalRequest": { "url": { @@ -748,46 +652,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -805,6 +672,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "DELETE", @@ -812,13 +687,7 @@ }, "status": "No Content", "code": 204, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -826,7 +695,7 @@ { "listen": "test", "script": { - "id": "eb8a05ad-1b57-4083-95ed-6dde28d60fc8", + "id": "30a53bce-7f73-49e2-ac0c-ba560967fb6a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/storage/profile-system/profiles/:profileId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -840,7 +709,7 @@ } }, { - "id": "3e6d28db-26b1-4782-8cf2-cb6976e12809", + "id": "6cf54d0f-c68d-4754-987e-cae3aac72d1b", "name": "Get unmasked profile", "request": { "name": "Get unmasked profile", @@ -873,7 +742,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -884,30 +753,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -929,16 +780,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "52e35c80-c06e-4163-9588-b406ba604b49", + "id": "dc5f059c-1484-4e38-b63b-e34bb513c9c4", "name": "OK", "originalRequest": { "url": { @@ -954,59 +810,32 @@ "{{baseUrl}}" ], "query": [ - { - "key": "reason", - "value": "data-validation" - }, - { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) Reason for requesting unmasked data.", "type": "text/plain" }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" + "key": "reason", + "value": "data-validation" }, { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ { + "disabled": false, "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "(Required) Type of the content being sent.", + "content": "(Required) Type of the content being sent.", "type": "text/plain" }, "key": "Content-Type", @@ -1024,6 +853,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1045,13 +882,13 @@ { "listen": "test", "script": { - "id": "6e9acf5d-1b7f-4896-81a8-e295a2b04cdd", + "id": "e82664f6-da71-4cbf-a508-126d5bba76c5", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/unmask - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/unmask - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/unmask - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"Array with unmasked profile information.\",\"items\":{\"title\":\"Unmasked profile response\",\"type\":\"object\",\"description\":\"Unmasked profile response.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\",\"example\":\"John\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\",\"example\":\"Doe\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\",\"example\":\"john.doe@example.com\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\",\"example\":\"1925-11-17\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\",\"example\":\"12345678900\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\",\"example\":\"CPF\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\",\"example\":\"{value}\"}}},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"Array with unmasked profile information.\",\"items\":{\"title\":\"Unmasked profile response\",\"type\":\"object\",\"description\":\"Unmasked profile response.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\"}}},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1061,7 +898,7 @@ } }, { - "id": "58c18d98-12a6-45ef-b721-3b589cd57f6f", + "id": "06691a5a-94e7-4a78-b66b-0dab21a65156", "name": "Get profile by version", "request": { "name": "Get profile by version", @@ -1087,7 +924,7 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", @@ -1103,24 +940,6 @@ "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileVersionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -1142,16 +961,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "6446ebf1-c786-4a6e-a75f-3db947854539", + "id": "73420bf0-0417-41d1-90bb-f0a770f10f89", "name": "OK", "originalRequest": { "url": { @@ -1168,56 +992,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "disabled": false, - "description": { - "content": "(Required) ID of the version of the client's profile as returned by endpoints that create or update profile information in the `version` field.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileVersionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1239,6 +1016,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1260,13 +1045,13 @@ { "listen": "test", "script": { - "id": "62e6fa1a-d7d6-47d8-825a-71a7dd774514", + "id": "229d3229-992c-436b-9d1a-eeb5e526f668", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Masked profile response\",\"type\":\"array\",\"description\":\"Array containing masked profile information.\",\"items\":{\"type\":\"object\",\"description\":\"Masked profile information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\",\"example\":\"John\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\",\"example\":\"Doe\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\",\"example\":\"john.doe@example.com\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\",\"example\":\"1925-11-17\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\",\"example\":\"12345678900\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\",\"example\":\"CPF\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\",\"example\":\"{value}\"}}},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Masked profile response\",\"type\":\"array\",\"description\":\"Array containing masked profile information.\",\"items\":{\"type\":\"object\",\"description\":\"Masked profile information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\"}}},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1276,7 +1061,7 @@ } }, { - "id": "52d4cd61-82e0-4d7d-9f76-3be9d6b288df", + "id": "ff277d7d-aba5-433c-be02-6747f2b281c6", "name": "Get unmasked profile by version", "request": { "name": "Get unmasked profile by version", @@ -1313,7 +1098,7 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", @@ -1329,24 +1114,6 @@ "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileVersionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -1368,16 +1135,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "9c5bad99-26c9-4724-835d-ee7a5c3374dc", + "id": "cf2f6380-f4d6-4aa7-8195-e1d5c9c77c99", "name": "OK", "originalRequest": { "url": { @@ -1395,61 +1167,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "reason", - "value": "data-validation" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, { "disabled": false, "description": { - "content": "(Required) ID of the version of the client's profile as returned by endpoints that create or update profile information in the `version` field.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileVersionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Reason for requesting unmasked data.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "reason", + "value": "data-validation" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1471,6 +1201,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1492,13 +1230,13 @@ { "listen": "test", "script": { - "id": "8708525d-a55a-4bff-b7bc-1247b6fa7c77", + "id": "f625575e-bc42-4c40-8bda-813ca6b690a7", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId/unmask - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId/unmask - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId/unmask - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"Array with unmasked profile information.\",\"items\":{\"title\":\"Unmasked profile response\",\"type\":\"object\",\"description\":\"Unmasked profile response.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\",\"example\":\"John\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\",\"example\":\"Doe\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\",\"example\":\"john.doe@example.com\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\",\"example\":\"1925-11-17\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\",\"example\":\"12345678900\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\",\"example\":\"CPF\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\",\"example\":\"{value}\"}}},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"Array with unmasked profile information.\",\"items\":{\"title\":\"Unmasked profile response\",\"type\":\"object\",\"description\":\"Unmasked profile response.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"document\":{\"title\":\"Profile\",\"type\":\"object\",\"description\":\"Profile schema.\",\"required\":[\"firstName\",\"lastName\",\"email\",\"document\",\"documentType\"],\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"Client's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Client's last name.\"},\"email\":{\"type\":\"string\",\"description\":\"Client's email address.\"},\"birthDate\":{\"type\":\"string\",\"description\":\"Client's birth date in ISO 8601 format.\"},\"document\":{\"type\":\"string\",\"description\":\"Client's document.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of document informed in `document`.\"},\"{customField}\":{\"type\":\"string\",\"description\":\"Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.\"}}},\"meta\":{\"title\":\"Profile metadata\",\"type\":\"object\",\"description\":\"Profile metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the profile version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the profile.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the profile was created in ISO 8601 format.\"},\"lastUpdate\":{\"type\":\"string\",\"description\":\"Date when the profile was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1511,7 +1249,7 @@ "event": [] }, { - "id": "4fbbca19-ac51-4179-8de2-f6c6130f40d0", + "id": "0db15095-5e4f-4941-9e73-2b4f527d07d3", "name": "Addresses", "description": { "content": "", @@ -1519,7 +1257,7 @@ }, "item": [ { - "id": "feaa2cfb-22b7-445f-bdcf-764cac82a810", + "id": "602d20cf-0a90-4b61-a48c-d8842de5d07b", "name": "Create client address", "request": { "name": "Create client address", @@ -1543,7 +1281,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -1554,30 +1292,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -1599,6 +1319,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -1607,6 +1335,7 @@ "raw": "{\n \"postalCode\": \"20200-000\",\n \"countryName\": \"Brasil\",\n \"countryCode\": \"BR\",\n \"administrativeAreaLevel1\": \"RJ\",\n \"locality\": \"Locality\",\n \"localityAreaLevel1\": \"locality area\",\n \"route\": \"51\",\n \"streetNumber\": \"999\",\n \"contactId\": \"1\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1617,7 +1346,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a3eabf79-db13-4a47-b85e-8d092c041b4f", + "id": "cfd4822c-a8e4-496c-ad04-d06558159d7b", "name": "Created", "originalRequest": { "url": { @@ -1634,50 +1363,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1696,9 +1393,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -1707,6 +1416,7 @@ "raw": "{\n \"postalCode\": \"20200-000\",\n \"countryName\": \"Brasil\",\n \"countryCode\": \"BR\",\n \"administrativeAreaLevel1\": \"RJ\",\n \"locality\": \"Locality\",\n \"localityAreaLevel1\": \"locality area\",\n \"route\": \"51\",\n \"streetNumber\": \"999\",\n \"contactId\": \"1\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1728,13 +1438,13 @@ { "listen": "test", "script": { - "id": "35d2a979-a165-4475-921d-d55472dd1d2c", + "id": "ef143624-0e13-4d07-925b-527b4dafdf42", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/addresses - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/addresses - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/addresses - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}},\"example\":{\"postalCode\":\"20200-000\",\"countryName\":\"Brasil\",\"countryCode\":\"BR\",\"administrativeAreaLevel1\":\"RJ\",\"locality\":\"Locality\",\"localityAreaLevel1\":\"locality area\",\"route\":\"51\",\"streetNumber\":\"999\",\"profileId\":\"70caf394-8534-447e-a0ca-1803c669c771\",\"contactId\":\"1\"}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/addresses - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/addresses - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1744,7 +1454,7 @@ } }, { - "id": "07741b66-d8ec-49cf-a12c-e1af73da57b7", + "id": "adaa12c6-3757-40dd-82c9-5f9227953ab3", "name": "Get client addresses", "request": { "name": "Get client addresses", @@ -1768,7 +1478,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -1779,30 +1489,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -1824,16 +1516,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "0d20bfc5-ca27-4dde-b893-280405c9cca8", + "id": "2d32ce12-aec8-414e-ad00-7049369c2721", "name": "OK", "originalRequest": { "url": { @@ -1850,50 +1547,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1915,6 +1580,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1936,13 +1609,13 @@ { "listen": "test", "script": { - "id": "66d4772f-5e3e-4a0e-a9e5-2a79a8ef81bf", + "id": "8b553c8d-c8d4-482a-a205-a9cae9852d82", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"title\":\"Masked address response\",\"type\":\"object\",\"description\":\"Masked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}},\"example\":{\"postalCode\":\"20200-000\",\"countryName\":\"Brasil\",\"countryCode\":\"BR\",\"administrativeAreaLevel1\":\"RJ\",\"locality\":\"Locality\",\"localityAreaLevel1\":\"locality area\",\"route\":\"51\",\"streetNumber\":\"999\",\"profileId\":\"70caf394-8534-447e-a0ca-1803c669c771\",\"contactId\":\"1\"}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"title\":\"Masked address response\",\"type\":\"object\",\"description\":\"Masked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1952,7 +1625,7 @@ } }, { - "id": "df7b0f85-7a05-4fad-8aa2-aabbec06dbe2", + "id": "884fd2b1-7ee6-4ec7-b436-451aa2cd69f1", "name": "Get unmasked client addresses", "request": { "name": "Get unmasked client addresses", @@ -1977,7 +1650,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -1988,30 +1661,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -2033,16 +1688,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "2c4e938a-238a-4328-a43f-9b5deac660ff", + "id": "95c476f6-267c-42c7-b69a-e4ffbb2a0bd7", "name": "OK", "originalRequest": { "url": { @@ -2060,50 +1720,18 @@ ], "query": [ { + "disabled": true, + "description": { + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", + "type": "text/plain" + }, "key": "alternativeKey", "value": "email" } ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2125,6 +1753,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2146,13 +1782,13 @@ { "listen": "test", "script": { - "id": "1ebeabfb-c63f-47b7-b288-9c62b4b079a5", + "id": "89061dec-9c98-4498-b719-147a75ddb018", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/unmask - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/unmask - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/unmask - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}},\"example\":{\"postalCode\":\"20200-000\",\"countryName\":\"Brasil\",\"countryCode\":\"BR\",\"administrativeAreaLevel1\":\"RJ\",\"locality\":\"Locality\",\"localityAreaLevel1\":\"locality area\",\"route\":\"51\",\"streetNumber\":\"999\",\"profileId\":\"70caf394-8534-447e-a0ca-1803c669c771\",\"contactId\":\"1\"}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2162,7 +1798,7 @@ } }, { - "id": "b3f22885-dbf7-4bce-bbf3-900a8dc755b7", + "id": "2db79454-d5a5-4050-974d-03129f6b984e", "name": "Get address", "request": { "name": "Get address", @@ -2187,7 +1823,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -2198,7 +1834,7 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", @@ -2214,24 +1850,6 @@ "type": "any", "value": "bf82180e-cf9e-4089-9af6-ae1518555992", "key": "addressId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -2253,16 +1871,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "f4a2d5c5-6c9b-4f6f-b52c-3b468ca1a700", + "id": "b8bf9135-1080-4d8d-b8e5-ba1570fc7894", "name": "OK", "originalRequest": { "url": { @@ -2280,60 +1903,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "disabled": false, - "description": { - "content": "(Required) ID of a client's specific address as returned in the [Create client address](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/addresses) endpoint's response, in the `id` field.", - "type": "text/plain" - }, - "type": "any", - "value": "bf82180e-cf9e-4089-9af6-ae1518555992", - "key": "addressId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2355,6 +1936,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2376,13 +1965,13 @@ { "listen": "test", "script": { - "id": "6ba5078a-9066-4137-9f95-7ccbb7eaa8da", + "id": "c2b28981-f80d-45b7-829a-e600dab65105", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Masked address response\",\"type\":\"object\",\"description\":\"Masked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}},\"example\":{\"postalCode\":\"20200-000\",\"countryName\":\"Brasil\",\"countryCode\":\"BR\",\"administrativeAreaLevel1\":\"RJ\",\"locality\":\"Locality\",\"localityAreaLevel1\":\"locality area\",\"route\":\"51\",\"streetNumber\":\"999\",\"profileId\":\"70caf394-8534-447e-a0ca-1803c669c771\",\"contactId\":\"1\"}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Masked address response\",\"type\":\"object\",\"description\":\"Masked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2392,7 +1981,7 @@ } }, { - "id": "604a4bf4-9810-4df4-9158-7049a063021e", + "id": "63fee58c-b750-48e9-9cd0-f582b5e3d995", "name": "Update client address", "request": { "name": "Update client address", @@ -2417,7 +2006,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -2428,7 +2017,7 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", @@ -2444,24 +2033,6 @@ "type": "any", "value": "bf82180e-cf9e-4089-9af6-ae1518555992", "key": "addressId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -2483,6 +2054,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PATCH", @@ -2491,6 +2070,7 @@ "raw": "{\n \"postalCode\": \"20200-000\",\n \"countryName\": \"Brasil\",\n \"countryCode\": \"BR\",\n \"administrativeAreaLevel1\": \"RJ\",\n \"locality\": \"Locality\",\n \"localityAreaLevel1\": \"locality area\",\n \"route\": \"51\",\n \"streetNumber\": \"999\",\n \"contactId\": \"1\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2501,7 +2081,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ab196023-f551-40f2-81f2-06c18f5201c2", + "id": "ca9a9115-5e54-459c-b279-3aabcb0d34a6", "name": "OK", "originalRequest": { "url": { @@ -2519,60 +2099,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "disabled": false, - "description": { - "content": "(Required) ID of a client's specific address as returned in the [Create client address](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/addresses) endpoint's response, in the `id` field.", - "type": "text/plain" - }, - "type": "any", - "value": "bf82180e-cf9e-4089-9af6-ae1518555992", - "key": "addressId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2591,9 +2129,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PATCH", @@ -2602,6 +2152,7 @@ "raw": "{\n \"postalCode\": \"20200-000\",\n \"countryName\": \"Brasil\",\n \"countryCode\": \"BR\",\n \"administrativeAreaLevel1\": \"RJ\",\n \"locality\": \"Locality\",\n \"localityAreaLevel1\": \"locality area\",\n \"route\": \"51\",\n \"streetNumber\": \"999\",\n \"contactId\": \"1\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2623,13 +2174,13 @@ { "listen": "test", "script": { - "id": "d28a5c2f-0ace-450c-8a53-871a5d73593e", + "id": "ca1f37f2-7777-4403-b597-bf9ff1bc79cd", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}},\"example\":{\"postalCode\":\"20200-000\",\"countryName\":\"Brasil\",\"countryCode\":\"BR\",\"administrativeAreaLevel1\":\"RJ\",\"locality\":\"Locality\",\"localityAreaLevel1\":\"locality area\",\"route\":\"51\",\"streetNumber\":\"999\",\"profileId\":\"70caf394-8534-447e-a0ca-1803c669c771\",\"contactId\":\"1\"}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2639,7 +2190,7 @@ } }, { - "id": "09ba544c-5d06-48d1-bac0-d17da1a1863b", + "id": "d33a52b7-268d-49bb-9f81-3e3e4531672e", "name": "Delete address", "request": { "name": "Delete address", @@ -2664,7 +2215,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -2675,7 +2226,7 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", @@ -2691,24 +2242,6 @@ "type": "any", "value": "bf82180e-cf9e-4089-9af6-ae1518555992", "key": "addressId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -2732,14 +2265,15 @@ "value": "application/json" } ], - "method": "DELETE" + "method": "DELETE", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "2dc526a8-e3a6-4023-af55-ae2f40144bef", + "id": "5635f530-9fda-4002-977e-8c3dbaae06e7", "name": "No content", "originalRequest": { "url": { @@ -2757,60 +2291,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "disabled": false, - "description": { - "content": "(Required) ID of a client's specific address as returned in the [Create client address](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/addresses) endpoint's response, in the `id` field.", - "type": "text/plain" - }, - "type": "any", - "value": "bf82180e-cf9e-4089-9af6-ae1518555992", - "key": "addressId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2828,6 +2320,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "DELETE", @@ -2835,13 +2335,7 @@ }, "status": "No Content", "code": 204, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -2849,7 +2343,7 @@ { "listen": "test", "script": { - "id": "99cad060-50b9-4a72-9a14-470cdd36dd59", + "id": "48bc14ca-81fc-4f33-bcdd-4aa9135804f8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2863,7 +2357,7 @@ } }, { - "id": "6615f8b0-460f-4b72-9db5-906b0d799b9c", + "id": "c12a753f-871d-405d-928a-89b59c54c66a", "name": "Get unmasked address", "request": { "name": "Get unmasked address", @@ -2898,7 +2392,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -2909,7 +2403,7 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", @@ -2925,24 +2419,6 @@ "type": "any", "value": "bf82180e-cf9e-4089-9af6-ae1518555992", "key": "addressId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -2964,16 +2440,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "fcb325db-7500-4f41-9779-d65d19ea5a6d", + "id": "5c373be3-4e32-4d54-8755-0c2f4fcb78fa", "name": "OK", "originalRequest": { "url": { @@ -2991,69 +2472,32 @@ "{{baseUrl}}" ], "query": [ - { - "key": "reason", - "value": "data-validation" - }, - { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, { "disabled": false, "description": { - "content": "(Required) ID of a client's specific address as returned in the [Create client address](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/addresses) endpoint's response, in the `id` field.", + "content": "(Required) Reason for requesting unmasked data.", "type": "text/plain" }, - "type": "any", - "value": "bf82180e-cf9e-4089-9af6-ae1518555992", - "key": "addressId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" + "key": "reason", + "value": "data-validation" }, { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ { + "disabled": false, "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "(Required) Type of the content being sent.", + "content": "(Required) Type of the content being sent.", "type": "text/plain" }, "key": "Content-Type", @@ -3071,6 +2515,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -3092,13 +2544,13 @@ { "listen": "test", "script": { - "id": "27aa0db1-5020-431c-8715-c11602616fe0", + "id": "7157ad9f-4975-4c54-a650-fb926f600b72", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/unmask - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/unmask - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/unmask - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}},\"example\":{\"postalCode\":\"20200-000\",\"countryName\":\"Brasil\",\"countryCode\":\"BR\",\"administrativeAreaLevel1\":\"RJ\",\"locality\":\"Locality\",\"localityAreaLevel1\":\"locality area\",\"route\":\"51\",\"streetNumber\":\"999\",\"profileId\":\"70caf394-8534-447e-a0ca-1803c669c771\",\"contactId\":\"1\"}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -3108,7 +2560,7 @@ } }, { - "id": "94655bdd-1dda-49e2-9dda-b526943e1f64", + "id": "cf044316-069c-450f-8666-e07716d3a63d", "name": "Get address by version", "request": { "name": "Get address by version", @@ -3144,7 +2596,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -3155,7 +2607,7 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", @@ -3181,24 +2633,6 @@ "type": "any", "value": "86dfae79-1d23-43f2-a643-2fc8f1839461", "key": "addressVersionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -3220,16 +2654,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "c2db25d2-0864-4ec2-bc1f-67ef079096ad", + "id": "a3a7b589-54b6-4fdd-9146-cd53393ca633", "name": "OK", "originalRequest": { "url": { @@ -3248,75 +2687,28 @@ "{{baseUrl}}" ], "query": [ - { - "key": "reason", - "value": "data-validation" - }, - { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "disabled": false, - "description": { - "content": "(Required) ID of a client's specific address as returned in the [Create client address](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/addresses) endpoint's response, in the `id` field.", - "type": "text/plain" - }, - "type": "any", - "value": "bf82180e-cf9e-4089-9af6-ae1518555992", - "key": "addressId" - }, { "disabled": false, "description": { - "content": "(Required) ID of the version of a given client's address as returned by endpoints that create or update address information in the `version` field.", + "content": "(Required) Reason for requesting unmasked data.", "type": "text/plain" }, - "type": "any", - "value": "86dfae79-1d23-43f2-a643-2fc8f1839461", - "key": "addressVersionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" + "key": "reason", + "value": "data-validation" }, { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3338,6 +2730,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -3359,13 +2759,13 @@ { "listen": "test", "script": { - "id": "317ad5b6-9e08-46b0-ae62-21a51a150eca", + "id": "658a52ed-4756-4a7a-9a6d-9c148da1efbf", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Masked address response\",\"type\":\"object\",\"description\":\"Masked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}},\"example\":{\"postalCode\":\"20200-000\",\"countryName\":\"Brasil\",\"countryCode\":\"BR\",\"administrativeAreaLevel1\":\"RJ\",\"locality\":\"Locality\",\"localityAreaLevel1\":\"locality area\",\"route\":\"51\",\"streetNumber\":\"999\",\"profileId\":\"70caf394-8534-447e-a0ca-1803c669c771\",\"contactId\":\"1\"}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Masked address response\",\"type\":\"object\",\"description\":\"Masked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -3375,7 +2775,7 @@ } }, { - "id": "94182a87-5102-4d41-9977-7b49f3114cab", + "id": "df44b9e1-2488-46f8-b340-0fe46c49fb85", "name": "Get unmasked address by version", "request": { "name": "Get unmasked address by version", @@ -3412,7 +2812,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -3423,7 +2823,7 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", @@ -3449,24 +2849,6 @@ "type": "any", "value": "86dfae79-1d23-43f2-a643-2fc8f1839461", "key": "addressVersionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -3488,16 +2870,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "287b0d78-df02-419d-94f0-6ec4abfcc185", + "id": "2abcee34-8670-461d-98e7-3e71f79fea2b", "name": "OK", "originalRequest": { "url": { @@ -3517,75 +2904,28 @@ "{{baseUrl}}" ], "query": [ - { - "key": "reason", - "value": "data-validation" - }, - { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "disabled": false, - "description": { - "content": "(Required) ID of a client's specific address as returned in the [Create client address](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/addresses) endpoint's response, in the `id` field.", - "type": "text/plain" - }, - "type": "any", - "value": "bf82180e-cf9e-4089-9af6-ae1518555992", - "key": "addressId" - }, { "disabled": false, "description": { - "content": "(Required) ID of the version of a given client's address as returned by endpoints that create or update address information in the `version` field.", + "content": "(Required) Reason for requesting unmasked data.", "type": "text/plain" }, - "type": "any", - "value": "86dfae79-1d23-43f2-a643-2fc8f1839461", - "key": "addressVersionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" + "key": "reason", + "value": "data-validation" }, { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3607,6 +2947,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -3628,13 +2976,13 @@ { "listen": "test", "script": { - "id": "35910e5b-96f8-448b-918e-a37b4b2a48ec", + "id": "bb7898cd-ad05-4b31-8860-0f7c57019903", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId/unmask - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId/unmask - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId/unmask - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}},\"example\":{\"postalCode\":\"20200-000\",\"countryName\":\"Brasil\",\"countryCode\":\"BR\",\"administrativeAreaLevel1\":\"RJ\",\"locality\":\"Locality\",\"localityAreaLevel1\":\"locality area\",\"route\":\"51\",\"streetNumber\":\"999\",\"profileId\":\"70caf394-8534-447e-a0ca-1803c669c771\",\"contactId\":\"1\"}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Unmasked address response\",\"type\":\"object\",\"description\":\"Unmasked address information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of a client's address.\"},\"document\":{\"title\":\"Address\",\"type\":\"object\",\"description\":\"Address information.\",\"required\":[\"postalCode\",\"countryName\",\"administrativeAreaLevel1\",\"locality\",\"localityAreaLevel1\",\"route\",\"streetNumber\",\"profileId\"],\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Address postal code.\"},\"countryName\":{\"type\":\"string\",\"description\":\"Name of the address country.\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Two letter country code.\"},\"administrativeAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of administrative area, such as the state or province.\"},\"locality\":{\"type\":\"string\",\"description\":\"Name of address locality, such as the city.\"},\"localityAreaLevel1\":{\"type\":\"string\",\"description\":\"Name of the address locality area, such as the neighborhood or district.\"},\"route\":{\"type\":\"string\",\"description\":\"Address route or street name.\"},\"streetNumber\":{\"type\":\"string\",\"description\":\"Address street number.\"},\"profileId\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the client's profile.\"},\"contactId\":{\"type\":\"string\",\"description\":\"Contact unique identifier.\"}}},\"meta\":{\"title\":\"Address metadata\",\"type\":\"object\",\"description\":\"Address metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the address version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the address was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the address was last updated in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -3647,7 +2995,7 @@ "event": [] }, { - "id": "748fcea9-5f5d-431c-ac51-e92d333a774f", + "id": "fe169008-7035-472c-b98a-3c9566ce0111", "name": "Prospects", "description": { "content": "", @@ -3655,7 +3003,7 @@ }, "item": [ { - "id": "196244ec-4e7d-4ec9-b465-b2a862144da2", + "id": "9b3afd14-d838-4e39-abb3-9ec38e69b6ab", "name": "Create prospect", "request": { "name": "Create prospect", @@ -3674,26 +3022,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -3713,14 +3042,23 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"availableAddresses\": [\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n },\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n }\n ],\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n },\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [\n \"12345\",\n \"12345\"\n ],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"laboris cupidatat commodo\",\n \"paymentSystem\": \"dolor reprehenderit Ut\",\n \"paymentSystemName\": \"quis voluptate iru\",\n \"value\": -43112547,\n \"installments\": -14513391,\n \"referenceValue\": -88827790,\n \"cardHolder\": \"in dolor\",\n \"cardNumber\": \"nulla in ullamco do dolore\",\n \"firstDigits\": \"non\",\n \"lastDigits\": \"veniam anim cillum sed officia\",\n \"cvv2\": \"irure nostrud anim\",\n \"expireMonth\": \"nulla do\",\n \"expireYear\": \"deserunt ut\",\n \"url\": \"ad irure\",\n \"giftCardId\": \"incididunt officia est\",\n \"giftCardName\": \"laborum commodo dolore\",\n \"giftCardCaption\": \"pariatur aute ut\",\n \"redemptionCode\": \"tempor mollit Duis\",\n \"group\": \"pariatur ut aliquip Duis\",\n \"tid\": \"non in quis\",\n \"dueDate\": \"est eiusmod\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"nulla sed\",\n \"paymentSystem\": \"ut voluptate deserunt cillum\",\n \"paymentSystemName\": \"in cupidatat\",\n \"value\": -19282948,\n \"installments\": 62558845,\n \"referenceValue\": 46281823,\n \"cardHolder\": \"sunt aliquip\",\n \"cardNumber\": \"cillum ipsum\",\n \"firstDigits\": \"consequat dolore deserunt ut sunt\",\n \"lastDigits\": \"ea Lorem\",\n \"cvv2\": \"non sunt qui\",\n \"expireMonth\": \"Lorem\",\n \"expireYear\": \"in ipsum esse\",\n \"url\": \"aliqui\",\n \"giftCardId\": \"in ullamco veniam\",\n \"giftCardName\": \"occaecat adipisicing in sunt Ut\",\n \"giftCardCaption\": \"dolor do en\",\n \"redemptionCode\": \"adipisicing ut aute veniam\",\n \"group\": \"eiusmod in occaecat\",\n \"tid\": \"culpa in nisi\",\n \"dueDate\": \"sint\",\n \"connectorResponses\": {}\n }\n ]\n },\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"voluptate\",\n \"paymentSystem\": \"aliquip id\",\n \"paymentSystemName\": \"consequat Duis amet exercitation\",\n \"value\": 61895655,\n \"installments\": -91925975,\n \"referenceValue\": -7230165,\n \"cardHolder\": \"cu\",\n \"cardNumber\": \"in\",\n \"firstDigits\": \"magna commodo non in\",\n \"lastDigits\": \"nostrud dolor ad\",\n \"cvv2\": \"veniam proident Duis\",\n \"expireMonth\": \"minim qui officia dolor\",\n \"expireYear\": \"sed aliqua\",\n \"url\": \"tempor velit i\",\n \"giftCardId\": \"Lorem Duis esse\",\n \"giftCardName\": \"quis ullamco ut\",\n \"giftCardCaption\": \"est eu\",\n \"redemptionCode\": \"anim incididunt ullamco minim\",\n \"group\": \"in\",\n \"tid\": \"do in\",\n \"dueDate\": \"dolore velit reprehenderit fugiat\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"Excepteur\",\n \"paymentSystem\": \"do Lorem amet\",\n \"paymentSystemName\": \"adipisicing\",\n \"value\": 61971790,\n \"installments\": 46117597,\n \"referenceValue\": -16595843,\n \"cardHolder\": \"irure ex sit aliqua aliquip\",\n \"cardNumber\": \"aliquip non Lorem dolore\",\n \"firstDigits\": \"elit reprehenderit\",\n \"lastDigits\": \"sint dolore nostrud aliquip\",\n \"cvv2\": \"culpa amet incididunt\",\n \"expireMonth\": \"nisi\",\n \"expireYear\": \"reprehenderit tempor labore\",\n \"url\": \"tempor sit enim\",\n \"giftCardId\": \"voluptate\",\n \"giftCardName\": \"nisi consect\",\n \"giftCardCaption\": \"dolore ullamco incididunt et\",\n \"redemptionCode\": \"dolore\",\n \"group\": \"veniam eu Ut proident\",\n \"tid\": \"sit eu nulla\",\n \"dueDate\": \"non incididunt\",\n \"connectorResponses\": {}\n }\n ]\n }\n ],\n \"giftCards\": [\n \"12345\",\n \"12345\"\n ],\n \"giftCardMessages\": [\n \"Message.\",\n \"Message.\"\n ],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"contacts\": [\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n },\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n }\n ],\n \"invoiceSubject\": {\n \"invoiceSubjectId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\"\n },\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"document\": \"5397eefef23741d4976ebdf772cc42e0\",\n \"cellPhone\": \"12345678910\",\n \"isPJ\": false,\n \"customerCode\": \"5397eefe-f237-41d4-976e-bdf772cc42e0\"\n}", + "raw": "{\n \"availableAddresses\": [\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n },\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n }\n ],\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n },\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [\n \"12345\",\n \"12345\"\n ],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"culpa in nisi sit veniam\",\n \"paymentSystem\": \"dolore eu minim cupida\",\n \"paymentSystemName\": \"sed nulla laborum dolore\",\n \"value\": 19794399,\n \"installments\": -67705574,\n \"referenceValue\": -63837365,\n \"cardHolder\": \"do ut est Ut\",\n \"cardNumber\": \"aliqua\",\n \"firstDigits\": \"adipisicing quis dolore fugiat\",\n \"lastDigits\": \"ullamco tempor in ea non\",\n \"cvv2\": \"exercitation ut\",\n \"expireMonth\": \"consequat cillum\",\n \"expireYear\": \"ut laborum dolore irure\",\n \"url\": \"sint enim sunt ut\",\n \"giftCardId\": \"nulla in\",\n \"giftCardName\": \"sint quis sed\",\n \"giftCardCaption\": \"ut laboris pari\",\n \"redemptionCode\": \"sunt exercitation nostrud\",\n \"group\": \"fugiat ut cillum in\",\n \"tid\": \"officia esse proident\",\n \"dueDate\": \"reprehenderit officia dolor\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"deserunt\",\n \"paymentSystem\": \"aute ex ullamco nisi\",\n \"paymentSystemName\": \"cupidatat commodo incididunt\",\n \"value\": -44330911,\n \"installments\": -3274686,\n \"referenceValue\": -20720008,\n \"cardHolder\": \"sed in\",\n \"cardNumber\": \"deserunt mollit eni\",\n \"firstDigits\": \"sit ad\",\n \"lastDigits\": \"tempor occaecat aliquip\",\n \"cvv2\": \"velit anim\",\n \"expireMonth\": \"magna\",\n \"expireYear\": \"veniam id Lorem\",\n \"url\": \"cillum in eu laboris eiusmod\",\n \"giftCardId\": \"Duis consectetur dolor non proident\",\n \"giftCardName\": \"velit ex pariatur ad mollit\",\n \"giftCardCaption\": \"magna cupidatat\",\n \"redemptionCode\": \"laborum eiusmod ut in\",\n \"group\": \"ut nisi\",\n \"tid\": \"fugiat et Ut\",\n \"dueDate\": \"sit id\",\n \"connectorResponses\": {}\n }\n ]\n },\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"quis\",\n \"paymentSystem\": \"ea dolore\",\n \"paymentSystemName\": \"nisi ut est\",\n \"value\": -75722387,\n \"installments\": -97421684,\n \"referenceValue\": -29672698,\n \"cardHolder\": \"ut tempor\",\n \"cardNumber\": \"minim amet\",\n \"firstDigits\": \"sed cupidatat dolor\",\n \"lastDigits\": \"mollit minim e\",\n \"cvv2\": \"quis labore\",\n \"expireMonth\": \"sit\",\n \"expireYear\": \"tempor proident velit reprehenderit\",\n \"url\": \"in in do\",\n \"giftCardId\": \"Ut est reprehenderit aliquip\",\n \"giftCardName\": \"tempor consequat\",\n \"giftCardCaption\": \"sin\",\n \"redemptionCode\": \"elit mollit tempor\",\n \"group\": \"magna\",\n \"tid\": \"voluptate i\",\n \"dueDate\": \"Ut occaecat ea eiusmod\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"esse\",\n \"paymentSystem\": \"mollit laborum ut cillum sit\",\n \"paymentSystemName\": \"consequat dolore magna\",\n \"value\": -87167928,\n \"installments\": -75150717,\n \"referenceValue\": -94213577,\n \"cardHolder\": \"do minim\",\n \"cardNumber\": \"exercitation reprehenderit pariatur elit aliquip\",\n \"firstDigits\": \"aliquip magna incididunt\",\n \"lastDigits\": \"sed elit eu\",\n \"cvv2\": \"sit\",\n \"expireMonth\": \"Duis\",\n \"expireYear\": \"id Ut anim Lorem\",\n \"url\": \"deserunt laboris\",\n \"giftCardId\": \"fugiat tempor incididunt laborum\",\n \"giftCardName\": \"enim adipisicing cillum ipsum\",\n \"giftCardCaption\": \"occaecat incididunt dolore\",\n \"redemptionCode\": \"proident ea\",\n \"group\": \"pariatur aliquip consectetur\",\n \"tid\": \"Ut officia reprehenderit sed eiusmod\",\n \"dueDate\": \"ex culpa aliquip\",\n \"connectorResponses\": {}\n }\n ]\n }\n ],\n \"giftCards\": [\n \"12345\",\n \"12345\"\n ],\n \"giftCardMessages\": [\n \"Message.\",\n \"Message.\"\n ],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"contacts\": [\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n },\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n }\n ],\n \"invoiceSubject\": {\n \"invoiceSubjectId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\"\n },\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"document\": \"5397eefef23741d4976ebdf772cc42e0\",\n \"cellPhone\": \"12345678910\",\n \"isPJ\": false,\n \"customerCode\": \"5397eefe-f237-41d4-976e-bdf772cc42e0\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3731,7 +3069,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "edef4fef-09ee-4966-a687-9a036591527d", + "id": "65f7e5fb-803b-480b-ad57-e4be4238e998", "name": "Created", "originalRequest": { "url": { @@ -3745,36 +3083,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3793,17 +3104,30 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"availableAddresses\": [\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n },\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n }\n ],\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n },\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [\n \"12345\",\n \"12345\"\n ],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"dolor enim amet\",\n \"paymentSystem\": \"amet Ut consectetur\",\n \"paymentSystemName\": \"ad sed\",\n \"value\": 40924033,\n \"installments\": -49883677,\n \"referenceValue\": 55211805,\n \"cardHolder\": \"ea\",\n \"cardNumber\": \"tempor Ut officia incididunt reprehenderit\",\n \"firstDigits\": \"nulla voluptate magna velit\",\n \"lastDigits\": \"exercit\",\n \"cvv2\": \"in tempor\",\n \"expireMonth\": \"proident tempor officia cupidatat\",\n \"expireYear\": \"labore et aute incididunt\",\n \"url\": \"dolore reprehenderit\",\n \"giftCardId\": \"aliquip occaecat deserunt\",\n \"giftCardName\": \"velit mollit ut enim\",\n \"giftCardCaption\": \"ad anim aute\",\n \"redemptionCode\": \"reprehenderit exerci\",\n \"group\": \"dolore non laborum esse\",\n \"tid\": \"aliquip voluptate veniam\",\n \"dueDate\": \"id ea\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"dolor nisi Duis Ut\",\n \"paymentSystem\": \"\",\n \"paymentSystemName\": \"do dolor nostrud aliquip culpa\",\n \"value\": 999686,\n \"installments\": -52625297,\n \"referenceValue\": 56347847,\n \"cardHolder\": \"do laborum in\",\n \"cardNumber\": \"incididunt Ut\",\n \"firstDigits\": \"et Lorem fugiat nisi nostrud\",\n \"lastDigits\": \"consequat cupidat\",\n \"cvv2\": \"culpa nisi\",\n \"expireMonth\": \"ad non irure\",\n \"expireYear\": \"irure ea eu deserunt q\",\n \"url\": \"do\",\n \"giftCardId\": \"Ut qui dolor labore minim\",\n \"giftCardName\": \"nulla irure\",\n \"giftCardCaption\": \"anim dolor\",\n \"redemptionCode\": \"reprehenderit tempor deserunt nulla\",\n \"group\": \"qui eu ullamco\",\n \"tid\": \"est laboris ad culpa nostrud\",\n \"dueDate\": \"laboris officia\",\n \"connectorResponses\": {}\n }\n ]\n },\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"adipisicing ex sit\",\n \"paymentSystem\": \"deserunt in magna\",\n \"paymentSystemName\": \"id et\",\n \"value\": -79020991,\n \"installments\": -68659601,\n \"referenceValue\": -51718720,\n \"cardHolder\": \"deserunt aliquip non\",\n \"cardNumber\": \"officia reprehenderit\",\n \"firstDigits\": \"magna officia nostrud\",\n \"lastDigits\": \"nulla officia reprehenderit\",\n \"cvv2\": \"proident deserunt\",\n \"expireMonth\": \"proident elit laborum mollit\",\n \"expireYear\": \"in Ut\",\n \"url\": \"reprehenderit ex Excepteur consectetur\",\n \"giftCardId\": \"velit consectet\",\n \"giftCardName\": \"non labore\",\n \"giftCardCaption\": \"dolor est\",\n \"redemptionCode\": \"sunt proident nulla aliquip\",\n \"group\": \"elit eu dolor esse\",\n \"tid\": \"ipsum t\",\n \"dueDate\": \"deserunt officia\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"pariatur ea est\",\n \"paymentSystem\": \"in do dolore\",\n \"paymentSystemName\": \"sed qu\",\n \"value\": -13566787,\n \"installments\": 57007,\n \"referenceValue\": 99780048,\n \"cardHolder\": \"ea ei\",\n \"cardNumber\": \"dolo\",\n \"firstDigits\": \"esse est\",\n \"lastDigits\": \"officia eiusmod non\",\n \"cvv2\": \"officia tempor fugiat\",\n \"expireMonth\": \"dolor ex esse\",\n \"expireYear\": \"id consectetur\",\n \"url\": \"do nostrud\",\n \"giftCardId\": \"in esse deserunt in\",\n \"giftCardName\": \"qui ad do\",\n \"giftCardCaption\": \"nisi\",\n \"redemptionCode\": \"cillum amet nostrud ut\",\n \"group\": \"magna dolor reprehenderit Duis\",\n \"tid\": \"exercitation Ut Duis\",\n \"dueDate\": \"sunt Lorem\",\n \"connectorResponses\": {}\n }\n ]\n }\n ],\n \"giftCards\": [\n \"12345\",\n \"12345\"\n ],\n \"giftCardMessages\": [\n \"Message.\",\n \"Message.\"\n ],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"contacts\": [\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n },\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n }\n ],\n \"invoiceSubject\": {\n \"invoiceSubjectId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\"\n },\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"document\": \"5397eefef23741d4976ebdf772cc42e0\",\n \"cellPhone\": \"12345678910\",\n \"isPJ\": false,\n \"customerCode\": \"5397eefe-f237-41d4-976e-bdf772cc42e0\"\n}", + "raw": "{\n \"availableAddresses\": [\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n },\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n }\n ],\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n },\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [\n \"12345\",\n \"12345\"\n ],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"culpa in nisi sit veniam\",\n \"paymentSystem\": \"dolore eu minim cupida\",\n \"paymentSystemName\": \"sed nulla laborum dolore\",\n \"value\": 19794399,\n \"installments\": -67705574,\n \"referenceValue\": -63837365,\n \"cardHolder\": \"do ut est Ut\",\n \"cardNumber\": \"aliqua\",\n \"firstDigits\": \"adipisicing quis dolore fugiat\",\n \"lastDigits\": \"ullamco tempor in ea non\",\n \"cvv2\": \"exercitation ut\",\n \"expireMonth\": \"consequat cillum\",\n \"expireYear\": \"ut laborum dolore irure\",\n \"url\": \"sint enim sunt ut\",\n \"giftCardId\": \"nulla in\",\n \"giftCardName\": \"sint quis sed\",\n \"giftCardCaption\": \"ut laboris pari\",\n \"redemptionCode\": \"sunt exercitation nostrud\",\n \"group\": \"fugiat ut cillum in\",\n \"tid\": \"officia esse proident\",\n \"dueDate\": \"reprehenderit officia dolor\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"deserunt\",\n \"paymentSystem\": \"aute ex ullamco nisi\",\n \"paymentSystemName\": \"cupidatat commodo incididunt\",\n \"value\": -44330911,\n \"installments\": -3274686,\n \"referenceValue\": -20720008,\n \"cardHolder\": \"sed in\",\n \"cardNumber\": \"deserunt mollit eni\",\n \"firstDigits\": \"sit ad\",\n \"lastDigits\": \"tempor occaecat aliquip\",\n \"cvv2\": \"velit anim\",\n \"expireMonth\": \"magna\",\n \"expireYear\": \"veniam id Lorem\",\n \"url\": \"cillum in eu laboris eiusmod\",\n \"giftCardId\": \"Duis consectetur dolor non proident\",\n \"giftCardName\": \"velit ex pariatur ad mollit\",\n \"giftCardCaption\": \"magna cupidatat\",\n \"redemptionCode\": \"laborum eiusmod ut in\",\n \"group\": \"ut nisi\",\n \"tid\": \"fugiat et Ut\",\n \"dueDate\": \"sit id\",\n \"connectorResponses\": {}\n }\n ]\n },\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"quis\",\n \"paymentSystem\": \"ea dolore\",\n \"paymentSystemName\": \"nisi ut est\",\n \"value\": -75722387,\n \"installments\": -97421684,\n \"referenceValue\": -29672698,\n \"cardHolder\": \"ut tempor\",\n \"cardNumber\": \"minim amet\",\n \"firstDigits\": \"sed cupidatat dolor\",\n \"lastDigits\": \"mollit minim e\",\n \"cvv2\": \"quis labore\",\n \"expireMonth\": \"sit\",\n \"expireYear\": \"tempor proident velit reprehenderit\",\n \"url\": \"in in do\",\n \"giftCardId\": \"Ut est reprehenderit aliquip\",\n \"giftCardName\": \"tempor consequat\",\n \"giftCardCaption\": \"sin\",\n \"redemptionCode\": \"elit mollit tempor\",\n \"group\": \"magna\",\n \"tid\": \"voluptate i\",\n \"dueDate\": \"Ut occaecat ea eiusmod\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"esse\",\n \"paymentSystem\": \"mollit laborum ut cillum sit\",\n \"paymentSystemName\": \"consequat dolore magna\",\n \"value\": -87167928,\n \"installments\": -75150717,\n \"referenceValue\": -94213577,\n \"cardHolder\": \"do minim\",\n \"cardNumber\": \"exercitation reprehenderit pariatur elit aliquip\",\n \"firstDigits\": \"aliquip magna incididunt\",\n \"lastDigits\": \"sed elit eu\",\n \"cvv2\": \"sit\",\n \"expireMonth\": \"Duis\",\n \"expireYear\": \"id Ut anim Lorem\",\n \"url\": \"deserunt laboris\",\n \"giftCardId\": \"fugiat tempor incididunt laborum\",\n \"giftCardName\": \"enim adipisicing cillum ipsum\",\n \"giftCardCaption\": \"occaecat incididunt dolore\",\n \"redemptionCode\": \"proident ea\",\n \"group\": \"pariatur aliquip consectetur\",\n \"tid\": \"Ut officia reprehenderit sed eiusmod\",\n \"dueDate\": \"ex culpa aliquip\",\n \"connectorResponses\": {}\n }\n ]\n }\n ],\n \"giftCards\": [\n \"12345\",\n \"12345\"\n ],\n \"giftCardMessages\": [\n \"Message.\",\n \"Message.\"\n ],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"contacts\": [\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n },\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n }\n ],\n \"invoiceSubject\": {\n \"invoiceSubjectId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\"\n },\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"document\": \"5397eefef23741d4976ebdf772cc42e0\",\n \"cellPhone\": \"12345678910\",\n \"isPJ\": false,\n \"customerCode\": \"5397eefe-f237-41d4-976e-bdf772cc42e0\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3825,13 +3149,13 @@ { "listen": "test", "script": { - "id": "4ec44695-1b7a-4185-8204-dcaf0fa67a57", + "id": "4f9be294-8f62-4171-a3ca-e8697a5eafbb", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/storage/profile-system/prospects - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/storage/profile-system/prospects - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/storage/profile-system/prospects - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Unmasked prospect information.\",\"type\":\"object\",\"description\":\"Unmasked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\",\"example\":true},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\",\"example\":\"98478f6b-d025-4f35-a560-dd1ee7a6f26e\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\",\"example\":\"Home\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\",\"example\":\"residential\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\",\"example\":\"32137\"},\"city\":{\"type\":\"string\",\"description\":\"City.\",\"example\":\"Palm Coast\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\",\"example\":\"USA\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\",\"example\":\"Fifth St.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\",\"example\":\"9538\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\",\"example\":\"Apartment 2B\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\",\"example\":\"49.334934\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\",\"example\":\"12345678910\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\",\"example\":\"12345678910\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\",\"example\":\"12345678910\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\",\"example\":\"Doe\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\",\"example\":\"5397eefef23741d4976ebdf772cc42e0\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\",\"example\":\"12345678910\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\",\"example\":false},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\",\"example\":\"5397eefe-f237-41d4-976e-bdf772cc42e0\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/storage/profile-system/prospects - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Unmasked prospect information.\",\"type\":\"object\",\"description\":\"Unmasked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\"},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City.\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\"},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/storage/profile-system/prospects - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -3841,7 +3165,7 @@ } }, { - "id": "60779217-7f2e-4410-a5f5-6923631f6245", + "id": "3e78ccc3-a6bf-4b31-9be9-a82fe4e995ef", "name": "Get prospects", "request": { "name": "Get prospects", @@ -3860,26 +3184,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -3899,16 +3204,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "377bb609-7cba-4e82-9f43-523dca5b664e", + "id": "c99d9154-5c8c-4e8c-b4e7-b31496209c74", "name": "OK", "originalRequest": { "url": { @@ -3922,36 +3232,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3973,6 +3256,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -3994,13 +3285,13 @@ { "listen": "test", "script": { - "id": "ba1cedf7-0eac-47a9-b205-71aa0eb35125", + "id": "d542392c-2660-4c8f-9910-057a2c465a40", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/prospects - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/prospects - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/prospects - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of masked prospects.\",\"items\":{\"title\":\"Masked prospect information.\",\"type\":\"object\",\"description\":\"Masked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\",\"example\":true},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\",\"example\":\"98478f6b-d025-4f35-a560-dd1ee7a6f26e\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\",\"example\":\"Home\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\",\"example\":\"residential\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\",\"example\":\"32137\"},\"city\":{\"type\":\"string\",\"description\":\"City.\",\"example\":\"Palm Coast\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\",\"example\":\"USA\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\",\"example\":\"Fifth St.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\",\"example\":\"9538\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\",\"example\":\"Apartment 2B\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\",\"example\":\"49.334934\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\",\"example\":\"12345678910\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\",\"example\":\"12345678910\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\",\"example\":\"12345678910\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\",\"example\":\"Doe\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\",\"example\":\"5397eefef23741d4976ebdf772cc42e0\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\",\"example\":\"12345678910\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\",\"example\":false},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\",\"example\":\"5397eefe-f237-41d4-976e-bdf772cc42e0\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/prospects - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of masked prospects.\",\"items\":{\"title\":\"Masked prospect information.\",\"type\":\"object\",\"description\":\"Masked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\"},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City.\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\"},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/prospects - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4010,7 +3301,7 @@ } }, { - "id": "909c1cd1-d017-4f89-9423-5744bb4d8f24", + "id": "d89dcdc1-fbd1-494f-b0a7-9d2503823d04", "name": "Get unmasked prospects", "request": { "name": "Get unmasked prospects", @@ -4030,26 +3321,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -4069,16 +3341,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "c32f87fd-d9eb-4df3-af7f-7f3af23592e0", + "id": "4937a6cd-c612-407d-9afa-3d79548ac007", "name": "OK", "originalRequest": { "url": { @@ -4093,36 +3370,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4144,6 +3394,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -4165,13 +3423,13 @@ { "listen": "test", "script": { - "id": "bc729232-8e4b-485a-8194-dc98dd2186a4", + "id": "cf5ae80b-333e-4529-8ab7-ce2227da44df", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/prospects/unmask - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/prospects/unmask - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/prospects/unmask - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of prospects.\",\"items\":{\"title\":\"Unmasked prospect information.\",\"type\":\"object\",\"description\":\"Unmasked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\",\"example\":true},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\",\"example\":\"98478f6b-d025-4f35-a560-dd1ee7a6f26e\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\",\"example\":\"Home\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\",\"example\":\"residential\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\",\"example\":\"32137\"},\"city\":{\"type\":\"string\",\"description\":\"City.\",\"example\":\"Palm Coast\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\",\"example\":\"USA\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\",\"example\":\"Fifth St.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\",\"example\":\"9538\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\",\"example\":\"Apartment 2B\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\",\"example\":\"49.334934\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\",\"example\":\"12345678910\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\",\"example\":\"12345678910\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\",\"example\":\"12345678910\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\",\"example\":\"Doe\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\",\"example\":\"5397eefef23741d4976ebdf772cc42e0\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\",\"example\":\"12345678910\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\",\"example\":false},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\",\"example\":\"5397eefe-f237-41d4-976e-bdf772cc42e0\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/prospects/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of prospects.\",\"items\":{\"title\":\"Unmasked prospect information.\",\"type\":\"object\",\"description\":\"Unmasked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\"},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City.\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\"},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/prospects/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4181,7 +3439,7 @@ } }, { - "id": "5021c5fa-837e-478a-8ec8-b5cef8657515", + "id": "2983aaba-c29a-4ef5-9262-8cadb103550d", "name": "Get prospect", "request": { "name": "Get prospect", @@ -4211,24 +3469,6 @@ "type": "any", "value": "98478f6b-d025-4f35-a560-dd1ee7a6f26e", "key": "prospectId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -4250,16 +3490,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "2ab417dc-26fe-4c75-b990-610203e1374b", + "id": "0e260090-19be-4247-9cf5-2be6a97b0c75", "name": "OK", "originalRequest": { "url": { @@ -4274,46 +3519,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the prospect as returned by the [Create prospect](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/prospects) endpoint's response, in the `id` field.", - "type": "text/plain" - }, - "type": "any", - "value": "98478f6b-d025-4f35-a560-dd1ee7a6f26e", - "key": "prospectId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4335,6 +3543,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -4356,13 +3572,13 @@ { "listen": "test", "script": { - "id": "6259dcca-176b-4142-9834-0a8b027b0b52", + "id": "93a980ef-d17e-4853-918b-877b3e77a568", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Masked prospect information.\",\"type\":\"object\",\"description\":\"Masked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\",\"example\":true},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\",\"example\":\"98478f6b-d025-4f35-a560-dd1ee7a6f26e\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\",\"example\":\"Home\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\",\"example\":\"residential\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\",\"example\":\"32137\"},\"city\":{\"type\":\"string\",\"description\":\"City.\",\"example\":\"Palm Coast\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\",\"example\":\"USA\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\",\"example\":\"Fifth St.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\",\"example\":\"9538\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\",\"example\":\"Apartment 2B\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\",\"example\":\"49.334934\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\",\"example\":\"12345678910\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\",\"example\":\"12345678910\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\",\"example\":\"12345678910\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\",\"example\":\"Doe\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\",\"example\":\"5397eefef23741d4976ebdf772cc42e0\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\",\"example\":\"12345678910\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\",\"example\":false},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\",\"example\":\"5397eefe-f237-41d4-976e-bdf772cc42e0\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Masked prospect information.\",\"type\":\"object\",\"description\":\"Masked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\"},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City.\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\"},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4372,7 +3588,7 @@ } }, { - "id": "85ad5ec8-f752-461e-85fb-08fec66b5bc3", + "id": "4c150843-6e5d-41ad-a74a-3437521ac9ab", "name": "Update prospect", "request": { "name": "Update prospect", @@ -4402,24 +3618,6 @@ "type": "any", "value": "98478f6b-d025-4f35-a560-dd1ee7a6f26e", "key": "prospectId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -4441,14 +3639,23 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"availableAddresses\": [\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n },\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n }\n ],\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n },\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [\n \"12345\",\n \"12345\"\n ],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"dolor enim amet\",\n \"paymentSystem\": \"amet Ut consectetur\",\n \"paymentSystemName\": \"ad sed\",\n \"value\": 40924033,\n \"installments\": -49883677,\n \"referenceValue\": 55211805,\n \"cardHolder\": \"ea\",\n \"cardNumber\": \"tempor Ut officia incididunt reprehenderit\",\n \"firstDigits\": \"nulla voluptate magna velit\",\n \"lastDigits\": \"exercit\",\n \"cvv2\": \"in tempor\",\n \"expireMonth\": \"proident tempor officia cupidatat\",\n \"expireYear\": \"labore et aute incididunt\",\n \"url\": \"dolore reprehenderit\",\n \"giftCardId\": \"aliquip occaecat deserunt\",\n \"giftCardName\": \"velit mollit ut enim\",\n \"giftCardCaption\": \"ad anim aute\",\n \"redemptionCode\": \"reprehenderit exerci\",\n \"group\": \"dolore non laborum esse\",\n \"tid\": \"aliquip voluptate veniam\",\n \"dueDate\": \"id ea\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"dolor nisi Duis Ut\",\n \"paymentSystem\": \"\",\n \"paymentSystemName\": \"do dolor nostrud aliquip culpa\",\n \"value\": 999686,\n \"installments\": -52625297,\n \"referenceValue\": 56347847,\n \"cardHolder\": \"do laborum in\",\n \"cardNumber\": \"incididunt Ut\",\n \"firstDigits\": \"et Lorem fugiat nisi nostrud\",\n \"lastDigits\": \"consequat cupidat\",\n \"cvv2\": \"culpa nisi\",\n \"expireMonth\": \"ad non irure\",\n \"expireYear\": \"irure ea eu deserunt q\",\n \"url\": \"do\",\n \"giftCardId\": \"Ut qui dolor labore minim\",\n \"giftCardName\": \"nulla irure\",\n \"giftCardCaption\": \"anim dolor\",\n \"redemptionCode\": \"reprehenderit tempor deserunt nulla\",\n \"group\": \"qui eu ullamco\",\n \"tid\": \"est laboris ad culpa nostrud\",\n \"dueDate\": \"laboris officia\",\n \"connectorResponses\": {}\n }\n ]\n },\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"adipisicing ex sit\",\n \"paymentSystem\": \"deserunt in magna\",\n \"paymentSystemName\": \"id et\",\n \"value\": -79020991,\n \"installments\": -68659601,\n \"referenceValue\": -51718720,\n \"cardHolder\": \"deserunt aliquip non\",\n \"cardNumber\": \"officia reprehenderit\",\n \"firstDigits\": \"magna officia nostrud\",\n \"lastDigits\": \"nulla officia reprehenderit\",\n \"cvv2\": \"proident deserunt\",\n \"expireMonth\": \"proident elit laborum mollit\",\n \"expireYear\": \"in Ut\",\n \"url\": \"reprehenderit ex Excepteur consectetur\",\n \"giftCardId\": \"velit consectet\",\n \"giftCardName\": \"non labore\",\n \"giftCardCaption\": \"dolor est\",\n \"redemptionCode\": \"sunt proident nulla aliquip\",\n \"group\": \"elit eu dolor esse\",\n \"tid\": \"ipsum t\",\n \"dueDate\": \"deserunt officia\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"pariatur ea est\",\n \"paymentSystem\": \"in do dolore\",\n \"paymentSystemName\": \"sed qu\",\n \"value\": -13566787,\n \"installments\": 57007,\n \"referenceValue\": 99780048,\n \"cardHolder\": \"ea ei\",\n \"cardNumber\": \"dolo\",\n \"firstDigits\": \"esse est\",\n \"lastDigits\": \"officia eiusmod non\",\n \"cvv2\": \"officia tempor fugiat\",\n \"expireMonth\": \"dolor ex esse\",\n \"expireYear\": \"id consectetur\",\n \"url\": \"do nostrud\",\n \"giftCardId\": \"in esse deserunt in\",\n \"giftCardName\": \"qui ad do\",\n \"giftCardCaption\": \"nisi\",\n \"redemptionCode\": \"cillum amet nostrud ut\",\n \"group\": \"magna dolor reprehenderit Duis\",\n \"tid\": \"exercitation Ut Duis\",\n \"dueDate\": \"sunt Lorem\",\n \"connectorResponses\": {}\n }\n ]\n }\n ],\n \"giftCards\": [\n \"12345\",\n \"12345\"\n ],\n \"giftCardMessages\": [\n \"Message.\",\n \"Message.\"\n ],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"contacts\": [\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n },\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n }\n ],\n \"invoiceSubject\": {\n \"invoiceSubjectId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\"\n },\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"document\": \"5397eefef23741d4976ebdf772cc42e0\",\n \"cellPhone\": \"12345678910\",\n \"isPJ\": false,\n \"customerCode\": \"5397eefe-f237-41d4-976e-bdf772cc42e0\"\n}", + "raw": "{\n \"availableAddresses\": [\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n },\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n }\n ],\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n },\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [\n \"12345\",\n \"12345\"\n ],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"culpa in nisi sit veniam\",\n \"paymentSystem\": \"dolore eu minim cupida\",\n \"paymentSystemName\": \"sed nulla laborum dolore\",\n \"value\": 19794399,\n \"installments\": -67705574,\n \"referenceValue\": -63837365,\n \"cardHolder\": \"do ut est Ut\",\n \"cardNumber\": \"aliqua\",\n \"firstDigits\": \"adipisicing quis dolore fugiat\",\n \"lastDigits\": \"ullamco tempor in ea non\",\n \"cvv2\": \"exercitation ut\",\n \"expireMonth\": \"consequat cillum\",\n \"expireYear\": \"ut laborum dolore irure\",\n \"url\": \"sint enim sunt ut\",\n \"giftCardId\": \"nulla in\",\n \"giftCardName\": \"sint quis sed\",\n \"giftCardCaption\": \"ut laboris pari\",\n \"redemptionCode\": \"sunt exercitation nostrud\",\n \"group\": \"fugiat ut cillum in\",\n \"tid\": \"officia esse proident\",\n \"dueDate\": \"reprehenderit officia dolor\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"deserunt\",\n \"paymentSystem\": \"aute ex ullamco nisi\",\n \"paymentSystemName\": \"cupidatat commodo incididunt\",\n \"value\": -44330911,\n \"installments\": -3274686,\n \"referenceValue\": -20720008,\n \"cardHolder\": \"sed in\",\n \"cardNumber\": \"deserunt mollit eni\",\n \"firstDigits\": \"sit ad\",\n \"lastDigits\": \"tempor occaecat aliquip\",\n \"cvv2\": \"velit anim\",\n \"expireMonth\": \"magna\",\n \"expireYear\": \"veniam id Lorem\",\n \"url\": \"cillum in eu laboris eiusmod\",\n \"giftCardId\": \"Duis consectetur dolor non proident\",\n \"giftCardName\": \"velit ex pariatur ad mollit\",\n \"giftCardCaption\": \"magna cupidatat\",\n \"redemptionCode\": \"laborum eiusmod ut in\",\n \"group\": \"ut nisi\",\n \"tid\": \"fugiat et Ut\",\n \"dueDate\": \"sit id\",\n \"connectorResponses\": {}\n }\n ]\n },\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"quis\",\n \"paymentSystem\": \"ea dolore\",\n \"paymentSystemName\": \"nisi ut est\",\n \"value\": -75722387,\n \"installments\": -97421684,\n \"referenceValue\": -29672698,\n \"cardHolder\": \"ut tempor\",\n \"cardNumber\": \"minim amet\",\n \"firstDigits\": \"sed cupidatat dolor\",\n \"lastDigits\": \"mollit minim e\",\n \"cvv2\": \"quis labore\",\n \"expireMonth\": \"sit\",\n \"expireYear\": \"tempor proident velit reprehenderit\",\n \"url\": \"in in do\",\n \"giftCardId\": \"Ut est reprehenderit aliquip\",\n \"giftCardName\": \"tempor consequat\",\n \"giftCardCaption\": \"sin\",\n \"redemptionCode\": \"elit mollit tempor\",\n \"group\": \"magna\",\n \"tid\": \"voluptate i\",\n \"dueDate\": \"Ut occaecat ea eiusmod\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"esse\",\n \"paymentSystem\": \"mollit laborum ut cillum sit\",\n \"paymentSystemName\": \"consequat dolore magna\",\n \"value\": -87167928,\n \"installments\": -75150717,\n \"referenceValue\": -94213577,\n \"cardHolder\": \"do minim\",\n \"cardNumber\": \"exercitation reprehenderit pariatur elit aliquip\",\n \"firstDigits\": \"aliquip magna incididunt\",\n \"lastDigits\": \"sed elit eu\",\n \"cvv2\": \"sit\",\n \"expireMonth\": \"Duis\",\n \"expireYear\": \"id Ut anim Lorem\",\n \"url\": \"deserunt laboris\",\n \"giftCardId\": \"fugiat tempor incididunt laborum\",\n \"giftCardName\": \"enim adipisicing cillum ipsum\",\n \"giftCardCaption\": \"occaecat incididunt dolore\",\n \"redemptionCode\": \"proident ea\",\n \"group\": \"pariatur aliquip consectetur\",\n \"tid\": \"Ut officia reprehenderit sed eiusmod\",\n \"dueDate\": \"ex culpa aliquip\",\n \"connectorResponses\": {}\n }\n ]\n }\n ],\n \"giftCards\": [\n \"12345\",\n \"12345\"\n ],\n \"giftCardMessages\": [\n \"Message.\",\n \"Message.\"\n ],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"contacts\": [\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n },\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n }\n ],\n \"invoiceSubject\": {\n \"invoiceSubjectId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\"\n },\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"document\": \"5397eefef23741d4976ebdf772cc42e0\",\n \"cellPhone\": \"12345678910\",\n \"isPJ\": false,\n \"customerCode\": \"5397eefe-f237-41d4-976e-bdf772cc42e0\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4459,7 +3666,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a36712d4-33ea-4575-846c-8c5428e6f0d1", + "id": "5b31c7cd-aea8-4460-9533-ef7862d783fb", "name": "OK", "originalRequest": { "url": { @@ -4474,46 +3681,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the prospect as returned by the [Create prospect](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/prospects) endpoint's response, in the `id` field.", - "type": "text/plain" - }, - "type": "any", - "value": "98478f6b-d025-4f35-a560-dd1ee7a6f26e", - "key": "prospectId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4532,17 +3702,30 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"availableAddresses\": [\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n },\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n }\n ],\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n },\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [\n \"12345\",\n \"12345\"\n ],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"dolor enim amet\",\n \"paymentSystem\": \"amet Ut consectetur\",\n \"paymentSystemName\": \"ad sed\",\n \"value\": 40924033,\n \"installments\": -49883677,\n \"referenceValue\": 55211805,\n \"cardHolder\": \"ea\",\n \"cardNumber\": \"tempor Ut officia incididunt reprehenderit\",\n \"firstDigits\": \"nulla voluptate magna velit\",\n \"lastDigits\": \"exercit\",\n \"cvv2\": \"in tempor\",\n \"expireMonth\": \"proident tempor officia cupidatat\",\n \"expireYear\": \"labore et aute incididunt\",\n \"url\": \"dolore reprehenderit\",\n \"giftCardId\": \"aliquip occaecat deserunt\",\n \"giftCardName\": \"velit mollit ut enim\",\n \"giftCardCaption\": \"ad anim aute\",\n \"redemptionCode\": \"reprehenderit exerci\",\n \"group\": \"dolore non laborum esse\",\n \"tid\": \"aliquip voluptate veniam\",\n \"dueDate\": \"id ea\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"dolor nisi Duis Ut\",\n \"paymentSystem\": \"\",\n \"paymentSystemName\": \"do dolor nostrud aliquip culpa\",\n \"value\": 999686,\n \"installments\": -52625297,\n \"referenceValue\": 56347847,\n \"cardHolder\": \"do laborum in\",\n \"cardNumber\": \"incididunt Ut\",\n \"firstDigits\": \"et Lorem fugiat nisi nostrud\",\n \"lastDigits\": \"consequat cupidat\",\n \"cvv2\": \"culpa nisi\",\n \"expireMonth\": \"ad non irure\",\n \"expireYear\": \"irure ea eu deserunt q\",\n \"url\": \"do\",\n \"giftCardId\": \"Ut qui dolor labore minim\",\n \"giftCardName\": \"nulla irure\",\n \"giftCardCaption\": \"anim dolor\",\n \"redemptionCode\": \"reprehenderit tempor deserunt nulla\",\n \"group\": \"qui eu ullamco\",\n \"tid\": \"est laboris ad culpa nostrud\",\n \"dueDate\": \"laboris officia\",\n \"connectorResponses\": {}\n }\n ]\n },\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"adipisicing ex sit\",\n \"paymentSystem\": \"deserunt in magna\",\n \"paymentSystemName\": \"id et\",\n \"value\": -79020991,\n \"installments\": -68659601,\n \"referenceValue\": -51718720,\n \"cardHolder\": \"deserunt aliquip non\",\n \"cardNumber\": \"officia reprehenderit\",\n \"firstDigits\": \"magna officia nostrud\",\n \"lastDigits\": \"nulla officia reprehenderit\",\n \"cvv2\": \"proident deserunt\",\n \"expireMonth\": \"proident elit laborum mollit\",\n \"expireYear\": \"in Ut\",\n \"url\": \"reprehenderit ex Excepteur consectetur\",\n \"giftCardId\": \"velit consectet\",\n \"giftCardName\": \"non labore\",\n \"giftCardCaption\": \"dolor est\",\n \"redemptionCode\": \"sunt proident nulla aliquip\",\n \"group\": \"elit eu dolor esse\",\n \"tid\": \"ipsum t\",\n \"dueDate\": \"deserunt officia\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"pariatur ea est\",\n \"paymentSystem\": \"in do dolore\",\n \"paymentSystemName\": \"sed qu\",\n \"value\": -13566787,\n \"installments\": 57007,\n \"referenceValue\": 99780048,\n \"cardHolder\": \"ea ei\",\n \"cardNumber\": \"dolo\",\n \"firstDigits\": \"esse est\",\n \"lastDigits\": \"officia eiusmod non\",\n \"cvv2\": \"officia tempor fugiat\",\n \"expireMonth\": \"dolor ex esse\",\n \"expireYear\": \"id consectetur\",\n \"url\": \"do nostrud\",\n \"giftCardId\": \"in esse deserunt in\",\n \"giftCardName\": \"qui ad do\",\n \"giftCardCaption\": \"nisi\",\n \"redemptionCode\": \"cillum amet nostrud ut\",\n \"group\": \"magna dolor reprehenderit Duis\",\n \"tid\": \"exercitation Ut Duis\",\n \"dueDate\": \"sunt Lorem\",\n \"connectorResponses\": {}\n }\n ]\n }\n ],\n \"giftCards\": [\n \"12345\",\n \"12345\"\n ],\n \"giftCardMessages\": [\n \"Message.\",\n \"Message.\"\n ],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"contacts\": [\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n },\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n }\n ],\n \"invoiceSubject\": {\n \"invoiceSubjectId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\"\n },\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"document\": \"5397eefef23741d4976ebdf772cc42e0\",\n \"cellPhone\": \"12345678910\",\n \"isPJ\": false,\n \"customerCode\": \"5397eefe-f237-41d4-976e-bdf772cc42e0\"\n}", + "raw": "{\n \"availableAddresses\": [\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n },\n {\n \"disposable\": true,\n \"userId\": \"98478f6b-d025-4f35-a560-dd1ee7a6f26e\",\n \"addressName\": \"Home\",\n \"addressType\": \"residential\",\n \"postalCode\": \"32137\",\n \"city\": \"Palm Coast\",\n \"country\": \"USA\",\n \"street\": \"Fifth St.\",\n \"number\": \"9538\",\n \"complement\": \"Apartment 2B\",\n \"geoCoordinate\": [\n \"49.334934\",\n \"49.334934\"\n ]\n }\n ],\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n },\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\",\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [\n \"12345\",\n \"12345\"\n ],\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"culpa in nisi sit veniam\",\n \"paymentSystem\": \"dolore eu minim cupida\",\n \"paymentSystemName\": \"sed nulla laborum dolore\",\n \"value\": 19794399,\n \"installments\": -67705574,\n \"referenceValue\": -63837365,\n \"cardHolder\": \"do ut est Ut\",\n \"cardNumber\": \"aliqua\",\n \"firstDigits\": \"adipisicing quis dolore fugiat\",\n \"lastDigits\": \"ullamco tempor in ea non\",\n \"cvv2\": \"exercitation ut\",\n \"expireMonth\": \"consequat cillum\",\n \"expireYear\": \"ut laborum dolore irure\",\n \"url\": \"sint enim sunt ut\",\n \"giftCardId\": \"nulla in\",\n \"giftCardName\": \"sint quis sed\",\n \"giftCardCaption\": \"ut laboris pari\",\n \"redemptionCode\": \"sunt exercitation nostrud\",\n \"group\": \"fugiat ut cillum in\",\n \"tid\": \"officia esse proident\",\n \"dueDate\": \"reprehenderit officia dolor\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"deserunt\",\n \"paymentSystem\": \"aute ex ullamco nisi\",\n \"paymentSystemName\": \"cupidatat commodo incididunt\",\n \"value\": -44330911,\n \"installments\": -3274686,\n \"referenceValue\": -20720008,\n \"cardHolder\": \"sed in\",\n \"cardNumber\": \"deserunt mollit eni\",\n \"firstDigits\": \"sit ad\",\n \"lastDigits\": \"tempor occaecat aliquip\",\n \"cvv2\": \"velit anim\",\n \"expireMonth\": \"magna\",\n \"expireYear\": \"veniam id Lorem\",\n \"url\": \"cillum in eu laboris eiusmod\",\n \"giftCardId\": \"Duis consectetur dolor non proident\",\n \"giftCardName\": \"velit ex pariatur ad mollit\",\n \"giftCardCaption\": \"magna cupidatat\",\n \"redemptionCode\": \"laborum eiusmod ut in\",\n \"group\": \"ut nisi\",\n \"tid\": \"fugiat et Ut\",\n \"dueDate\": \"sit id\",\n \"connectorResponses\": {}\n }\n ]\n },\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"quis\",\n \"paymentSystem\": \"ea dolore\",\n \"paymentSystemName\": \"nisi ut est\",\n \"value\": -75722387,\n \"installments\": -97421684,\n \"referenceValue\": -29672698,\n \"cardHolder\": \"ut tempor\",\n \"cardNumber\": \"minim amet\",\n \"firstDigits\": \"sed cupidatat dolor\",\n \"lastDigits\": \"mollit minim e\",\n \"cvv2\": \"quis labore\",\n \"expireMonth\": \"sit\",\n \"expireYear\": \"tempor proident velit reprehenderit\",\n \"url\": \"in in do\",\n \"giftCardId\": \"Ut est reprehenderit aliquip\",\n \"giftCardName\": \"tempor consequat\",\n \"giftCardCaption\": \"sin\",\n \"redemptionCode\": \"elit mollit tempor\",\n \"group\": \"magna\",\n \"tid\": \"voluptate i\",\n \"dueDate\": \"Ut occaecat ea eiusmod\",\n \"connectorResponses\": {}\n },\n {\n \"id\": \"esse\",\n \"paymentSystem\": \"mollit laborum ut cillum sit\",\n \"paymentSystemName\": \"consequat dolore magna\",\n \"value\": -87167928,\n \"installments\": -75150717,\n \"referenceValue\": -94213577,\n \"cardHolder\": \"do minim\",\n \"cardNumber\": \"exercitation reprehenderit pariatur elit aliquip\",\n \"firstDigits\": \"aliquip magna incididunt\",\n \"lastDigits\": \"sed elit eu\",\n \"cvv2\": \"sit\",\n \"expireMonth\": \"Duis\",\n \"expireYear\": \"id Ut anim Lorem\",\n \"url\": \"deserunt laboris\",\n \"giftCardId\": \"fugiat tempor incididunt laborum\",\n \"giftCardName\": \"enim adipisicing cillum ipsum\",\n \"giftCardCaption\": \"occaecat incididunt dolore\",\n \"redemptionCode\": \"proident ea\",\n \"group\": \"pariatur aliquip consectetur\",\n \"tid\": \"Ut officia reprehenderit sed eiusmod\",\n \"dueDate\": \"ex culpa aliquip\",\n \"connectorResponses\": {}\n }\n ]\n }\n ],\n \"giftCards\": [\n \"12345\",\n \"12345\"\n ],\n \"giftCardMessages\": [\n \"Message.\",\n \"Message.\"\n ],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"contacts\": [\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n },\n {\n \"contactId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\",\n \"document\": \"12345678910\"\n }\n ],\n \"invoiceSubject\": {\n \"invoiceSubjectId\": \"0\",\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345678910\"\n },\n \"email\": \"jane@mail.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"document\": \"5397eefef23741d4976ebdf772cc42e0\",\n \"cellPhone\": \"12345678910\",\n \"isPJ\": false,\n \"customerCode\": \"5397eefe-f237-41d4-976e-bdf772cc42e0\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4564,13 +3747,13 @@ { "listen": "test", "script": { - "id": "20f6a909-3486-4ab9-a8ea-dcc26637ed92", + "id": "1296d102-fb54-4ba3-a509-9b2111e1f99f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/storage/profile-system/prospects/:prospectId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/storage/profile-system/prospects/:prospectId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/storage/profile-system/prospects/:prospectId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Unmasked prospect information.\",\"type\":\"object\",\"description\":\"Unmasked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\",\"example\":true},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\",\"example\":\"98478f6b-d025-4f35-a560-dd1ee7a6f26e\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\",\"example\":\"Home\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\",\"example\":\"residential\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\",\"example\":\"32137\"},\"city\":{\"type\":\"string\",\"description\":\"City.\",\"example\":\"Palm Coast\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\",\"example\":\"USA\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\",\"example\":\"Fifth St.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\",\"example\":\"9538\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\",\"example\":\"Apartment 2B\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\",\"example\":\"49.334934\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\",\"example\":\"12345678910\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\",\"example\":\"12345678910\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\",\"example\":\"12345678910\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\",\"example\":\"Doe\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\",\"example\":\"5397eefef23741d4976ebdf772cc42e0\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\",\"example\":\"12345678910\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\",\"example\":false},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\",\"example\":\"5397eefe-f237-41d4-976e-bdf772cc42e0\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/storage/profile-system/prospects/:prospectId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Unmasked prospect information.\",\"type\":\"object\",\"description\":\"Unmasked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\"},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City.\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\"},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/storage/profile-system/prospects/:prospectId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4580,7 +3763,7 @@ } }, { - "id": "ff5fefc0-b6f9-48ba-8118-12bb8c9c0a16", + "id": "8b38c1b9-c620-43f4-be56-8b1fb5fcc1dc", "name": "Delete prospect", "request": { "name": "Delete prospect", @@ -4599,35 +3782,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the prospect as returned by the [Create prospect](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/prospects) endpoint's response, in the `id` field.", - "type": "text/plain" - }, - "type": "any", - "value": "98478f6b-d025-4f35-a560-dd1ee7a6f26e", - "key": "prospectId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, + "query": [], + "variable": [ { + "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) ID of the prospect as returned by the [Create prospect](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/prospects) endpoint's response, in the `id` field.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", - "key": "environment" + "value": "98478f6b-d025-4f35-a560-dd1ee7a6f26e", + "key": "prospectId" } ] }, @@ -4651,14 +3816,15 @@ "value": "application/json" } ], - "method": "DELETE" + "method": "DELETE", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "3effefa1-33d5-4dfe-ab27-6414b96d75bd", + "id": "9b2c7871-1872-4129-9aff-3f741be6dc37", "name": "No content", "originalRequest": { "url": { @@ -4673,46 +3839,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the prospect as returned by the [Create prospect](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/prospects) endpoint's response, in the `id` field.", - "type": "text/plain" - }, - "type": "any", - "value": "98478f6b-d025-4f35-a560-dd1ee7a6f26e", - "key": "prospectId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4730,6 +3859,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "DELETE", @@ -4737,13 +3874,7 @@ }, "status": "No Content", "code": 204, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -4751,7 +3882,7 @@ { "listen": "test", "script": { - "id": "75833b91-cda8-4a14-ad5a-c1fddbe6e870", + "id": "205fbfc7-6e63-4d16-bc7e-6030829502be", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/storage/profile-system/prospects/:prospectId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4765,7 +3896,7 @@ } }, { - "id": "bbf00e0d-e963-4a2d-a502-aa947f0a605b", + "id": "be59cbd7-1467-4ce2-bce9-a6e5e23127d8", "name": "Get unmasked prospect", "request": { "name": "Get unmasked prospect", @@ -4806,24 +3937,6 @@ "type": "any", "value": "98478f6b-d025-4f35-a560-dd1ee7a6f26e", "key": "prospectId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -4845,16 +3958,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "06252b70-a839-41f6-8076-ba159a352d36", + "id": "d587c409-f7cb-440b-9497-ec85aad736df", "name": "OK", "originalRequest": { "url": { @@ -4870,51 +3988,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "reason", - "value": "data-validation" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "(Required) ID of the prospect as returned by the [Create prospect](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/prospects) endpoint's response, in the `id` field.", + "content": "(Required) Reason for requesting unmasked data.", "type": "text/plain" }, - "type": "any", - "value": "98478f6b-d025-4f35-a560-dd1ee7a6f26e", - "key": "prospectId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "reason", + "value": "data-validation" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4936,6 +4022,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -4957,13 +4051,13 @@ { "listen": "test", "script": { - "id": "06265895-b94e-44e3-9f71-51ec6048ab06", + "id": "41c2282b-9521-488e-9973-69dd32a0bf76", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId/unmask - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId/unmask - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId/unmask - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Unmasked prospect information.\",\"type\":\"object\",\"description\":\"Unmasked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\",\"example\":true},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\",\"example\":\"98478f6b-d025-4f35-a560-dd1ee7a6f26e\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\",\"example\":\"Home\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\",\"example\":\"residential\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\",\"example\":\"32137\"},\"city\":{\"type\":\"string\",\"description\":\"City.\",\"example\":\"Palm Coast\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\",\"example\":\"USA\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\",\"example\":\"Fifth St.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\",\"example\":\"9538\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\",\"example\":\"Apartment 2B\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\",\"example\":\"49.334934\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\",\"example\":\"12345678910\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\",\"example\":\"12345678910\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\",\"example\":\"0\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\",\"example\":\"Doe\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\",\"example\":\"12345678910\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\",\"example\":\"jane@mail.com\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\",\"example\":\"Jane\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\",\"example\":\"Doe\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\",\"example\":\"5397eefef23741d4976ebdf772cc42e0\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\",\"example\":\"12345678910\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\",\"example\":false},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\",\"example\":\"5397eefe-f237-41d4-976e-bdf772cc42e0\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Unmasked prospect information.\",\"type\":\"object\",\"description\":\"Unmasked prospect information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of the prospect.\"},\"document\":{\"title\":\"Prospect information.\",\"type\":\"object\",\"description\":\"Prospect information.\",\"properties\":{\"availableAddresses\":{\"type\":\"array\",\"description\":\"Available addresses.\",\"items\":{\"type\":\"object\",\"description\":\"Available address information.\",\"properties\":{\"disposable\":{\"type\":\"boolean\",\"description\":\"Defines whether the address is deleted after use (`true`) or not (`false`).\"},\"userId\":{\"type\":\"string\",\"description\":\"User unique identifier.\"},\"addressName\":{\"type\":\"string\",\"description\":\"Address name.\"},\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City.\"},\"country\":{\"type\":\"string\",\"description\":\"Country code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"complement\":{\"type\":\"string\",\"description\":\"Complement information.\"},\"geoCoordinate\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"string\",\"description\":\"Geocoordinate.\"}}}}},\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"contacts\":{\"type\":\"array\",\"description\":\"List of contacts.\",\"items\":{\"type\":\"object\",\"description\":\"Contact information.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Contact's unique identifier.\"},\"email\":{\"type\":\"string\",\"description\":\"Contact's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Contact's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Contact's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Contact's phone number.\"},\"document\":{\"type\":\"string\",\"description\":\"Contact's document.\"}}}},\"invoiceSubject\":{\"type\":\"object\",\"description\":\"Information about the invoice subject.\",\"properties\":{\"invoiceSubjectId\":{\"type\":\"string\",\"description\":\"Invoice subject ID.\"},\"email\":{\"type\":\"string\",\"description\":\"Invoice subject's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Invoice subject's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Invoice subject's last name.\"},\"phone\":{\"type\":\"string\",\"description\":\"Invoice subject's phone number.\"}}},\"email\":{\"type\":\"string\",\"description\":\"Prospect's email address.\"},\"firstName\":{\"type\":\"string\",\"description\":\"Prospect's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Prospect's last name.\"},\"document\":{\"type\":\"string\",\"description\":\"Prospect's document.\"},\"cellPhone\":{\"type\":\"string\",\"description\":\"Prospect's cellphone number.\"},\"isPJ\":{\"type\":\"boolean\",\"description\":\"Defines if a prospect is corporate (`true`) or not (`false`).\"},\"customerCode\":{\"type\":\"string\",\"description\":\"Prospect's customer code.\"}}},\"meta\":{\"title\":\"Prospect information metadata.\",\"description\":\"Prospect information metadata.\",\"type\":\"object\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the prospect version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the prospect.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the prospect information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the prospect information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/prospects/:prospectId/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4976,7 +4070,7 @@ "event": [] }, { - "id": "547b022b-6342-444c-8ef2-e444b0d57577", + "id": "bdad3b91-94ea-460c-93ab-0907a9a13fad", "name": "Purchase information", "description": { "content": "", @@ -4984,7 +4078,7 @@ }, "item": [ { - "id": "225b7099-1cc5-46b8-a341-944cb3f3794a", + "id": "bac4d30a-693d-4947-b258-727329ecaeea", "name": "Create purchase information", "request": { "name": "Create purchase information", @@ -5008,7 +4102,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -5019,30 +4113,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -5064,6 +4140,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -5072,6 +4156,7 @@ "raw": "{\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [],\n \"transactions\": null,\n \"giftCards\": [],\n \"giftCardMessages\": [],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"clientPreferences\": {\n \"userId\": \"d9b946b8-9524-4b2d-96ec-b35d0625c0a7\",\n \"localeDefault\": \"pt-BR\",\n \"isNewsletterOptIn\": true\n },\n \"isToSavePersonalData\": true,\n \"lastUserPurchases\": [\n {\n \"creationDate\": \"2023-10-23T19:22:12.8989883Z\",\n \"orderId\": \"1370990595750-01\",\n \"orderGroup\": \"1370990595750\",\n \"value\": 3498\n }\n ],\n \"lastPurchasesAddressId\": \"db267dcc53c14fb2b9a985532dd287bc\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -5082,7 +4167,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "cac865f9-49ce-4b76-ba66-3dc97fa0e893", + "id": "2ef07106-5392-45cf-9090-95df67cceeca", "name": "OK", "originalRequest": { "url": { @@ -5099,50 +4184,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5161,9 +4214,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -5172,6 +4237,7 @@ "raw": "{\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [],\n \"transactions\": null,\n \"giftCards\": [],\n \"giftCardMessages\": [],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"clientPreferences\": {\n \"userId\": \"d9b946b8-9524-4b2d-96ec-b35d0625c0a7\",\n \"localeDefault\": \"pt-BR\",\n \"isNewsletterOptIn\": true\n },\n \"isToSavePersonalData\": true,\n \"lastUserPurchases\": [\n {\n \"creationDate\": \"2023-10-23T19:22:12.8989883Z\",\n \"orderId\": \"1370990595750-01\",\n \"orderGroup\": \"1370990595750\",\n \"value\": 3498\n }\n ],\n \"lastPurchasesAddressId\": \"db267dcc53c14fb2b9a985532dd287bc\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -5193,13 +4259,13 @@ { "listen": "test", "script": { - "id": "40bcacba-6b65-4dff-b4b4-2c2ef7102ee4", + "id": "7c278a2c-6f2d-4221-95d2-848a73c4a29c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/purchase-info - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/purchase-info - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/purchase-info - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Masked purchase information response.\",\"type\":\"object\",\"description\":\"Masked purchase information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of purchase information.\"},\"document\":{\"title\":\"Purchase information.\",\"type\":\"object\",\"description\":\"Purchase information object.\",\"properties\":{\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"clientPreferences\":{\"type\":\"object\",\"description\":\"Client preferences.\",\"properties\":{}},\"isToSavePersonalData\":{\"type\":\"boolean\",\"description\":\"Defines if personal data will be saved (`true`) or not (`false`).\"},\"lastUserPurchases\":{\"type\":\"array\",\"description\":\"Array with latest purchases from the client.\",\"items\":{\"type\":\"object\",\"description\":\"Purchase information.\",\"properties\":{\"creationDate\":{\"type\":\"string\",\"description\":\"Purchase date in the ISO 8601 format.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Unique identifier of the order.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Unique identifier of the order group.\"},\"value\":{\"type\":\"number\",\"description\":\"Purchase value.\"}}}},\"lastPurchasesAddressId\":{\"type\":\"string\",\"description\":\"Unique identifier of the client address.\"}}},\"meta\":{\"title\":\"Purchase information metadata.\",\"type\":\"object\",\"description\":\"Purchase information metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the purchase information version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the purchase information.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the purchase information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/purchase-info - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Masked purchase information response.\",\"type\":\"object\",\"description\":\"Masked purchase information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of purchase information.\"},\"document\":{\"title\":\"Purchase information.\",\"type\":\"object\",\"description\":\"Purchase information object.\",\"properties\":{\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"clientPreferences\":{\"type\":\"object\",\"description\":\"Client preferences.\",\"properties\":{}},\"isToSavePersonalData\":{\"type\":\"boolean\",\"description\":\"Defines if personal data will be saved (`true`) or not (`false`).\"},\"lastUserPurchases\":{\"type\":\"array\",\"description\":\"Array with latest purchases from the client.\",\"items\":{\"type\":\"object\",\"description\":\"Purchase information.\",\"properties\":{\"creationDate\":{\"type\":\"string\",\"description\":\"Purchase date in the ISO 8601 format.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Unique identifier of the order.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Unique identifier of the order group.\"},\"value\":{\"type\":\"number\",\"description\":\"Purchase value.\"}}}},\"lastPurchasesAddressId\":{\"type\":\"string\",\"description\":\"Unique identifier of the client address.\"}}},\"meta\":{\"title\":\"Purchase information metadata.\",\"type\":\"object\",\"description\":\"Purchase information metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the purchase information version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the purchase information.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the purchase information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/storage/profile-system/profiles/:profileId/purchase-info - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -5209,7 +4275,7 @@ } }, { - "id": "5e53c7f6-5339-47d8-951f-3308f7c212e8", + "id": "a38ae60b-d626-42af-8a22-f05d5f71db04", "name": "Get purchase information", "request": { "name": "Get purchase information", @@ -5233,7 +4299,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -5244,30 +4310,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -5289,16 +4337,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "27c8f403-7745-4ddf-9eb5-4b85662d5354", + "id": "cdaa8f09-c9ca-4076-b6da-91696450c4ad", "name": "OK", "originalRequest": { "url": { @@ -5315,50 +4368,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5380,6 +4401,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -5401,13 +4430,13 @@ { "listen": "test", "script": { - "id": "cf5c3f7c-9837-4cca-a9f5-dbe5025a3501", + "id": "27be66f0-e7bb-4607-886b-54909196f591", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"title\":\"Masked purchase information response.\",\"type\":\"object\",\"description\":\"Masked purchase information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of purchase information.\"},\"document\":{\"title\":\"Purchase information.\",\"type\":\"object\",\"description\":\"Purchase information object.\",\"properties\":{\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"clientPreferences\":{\"type\":\"object\",\"description\":\"Client preferences.\",\"properties\":{}},\"isToSavePersonalData\":{\"type\":\"boolean\",\"description\":\"Defines if personal data will be saved (`true`) or not (`false`).\"},\"lastUserPurchases\":{\"type\":\"array\",\"description\":\"Array with latest purchases from the client.\",\"items\":{\"type\":\"object\",\"description\":\"Purchase information.\",\"properties\":{\"creationDate\":{\"type\":\"string\",\"description\":\"Purchase date in the ISO 8601 format.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Unique identifier of the order.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Unique identifier of the order group.\"},\"value\":{\"type\":\"number\",\"description\":\"Purchase value.\"}}}},\"lastPurchasesAddressId\":{\"type\":\"string\",\"description\":\"Unique identifier of the client address.\"}}},\"meta\":{\"title\":\"Purchase information metadata.\",\"type\":\"object\",\"description\":\"Purchase information metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the purchase information version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the purchase information.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the purchase information expires in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"title\":\"Masked purchase information response.\",\"type\":\"object\",\"description\":\"Masked purchase information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of purchase information.\"},\"document\":{\"title\":\"Purchase information.\",\"type\":\"object\",\"description\":\"Purchase information object.\",\"properties\":{\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"clientPreferences\":{\"type\":\"object\",\"description\":\"Client preferences.\",\"properties\":{}},\"isToSavePersonalData\":{\"type\":\"boolean\",\"description\":\"Defines if personal data will be saved (`true`) or not (`false`).\"},\"lastUserPurchases\":{\"type\":\"array\",\"description\":\"Array with latest purchases from the client.\",\"items\":{\"type\":\"object\",\"description\":\"Purchase information.\",\"properties\":{\"creationDate\":{\"type\":\"string\",\"description\":\"Purchase date in the ISO 8601 format.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Unique identifier of the order.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Unique identifier of the order group.\"},\"value\":{\"type\":\"number\",\"description\":\"Purchase value.\"}}}},\"lastPurchasesAddressId\":{\"type\":\"string\",\"description\":\"Unique identifier of the client address.\"}}},\"meta\":{\"title\":\"Purchase information metadata.\",\"type\":\"object\",\"description\":\"Purchase information metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the purchase information version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the purchase information.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the purchase information expires in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -5417,7 +4446,7 @@ } }, { - "id": "f7fe0fa1-31b1-4857-b7ce-f59ec43b108e", + "id": "7e0a0156-1435-419b-8a4e-df7773bdd635", "name": "Update purchase information", "request": { "name": "Update purchase information", @@ -5441,7 +4470,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -5452,30 +4481,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -5497,6 +4508,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PATCH", @@ -5505,6 +4524,7 @@ "raw": "{\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [],\n \"transactions\": null,\n \"giftCards\": [],\n \"giftCardMessages\": [],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"clientPreferences\": {\n \"userId\": \"d9b946b8-9524-4b2d-96ec-b35d0625c0a7\",\n \"localeDefault\": \"pt-BR\",\n \"isNewsletterOptIn\": true\n },\n \"isToSavePersonalData\": true,\n \"lastUserPurchases\": [\n {\n \"creationDate\": \"2023-10-23T19:22:12.8989883Z\",\n \"orderId\": \"1370990595750-01\",\n \"orderGroup\": \"1370990595750\",\n \"value\": 3498\n }\n ],\n \"lastPurchasesAddressId\": \"db267dcc53c14fb2b9a985532dd287bc\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -5515,7 +4535,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7dd36462-2934-429c-9834-851f64265944", + "id": "42c2c1d3-e437-4f81-ad8f-5ee155896cd5", "name": "OK", "originalRequest": { "url": { @@ -5532,50 +4552,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5594,9 +4582,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PATCH", @@ -5605,6 +4605,7 @@ "raw": "{\n \"paymentData\": {\n \"availableAccounts\": [\n {\n \"accountId\": \"D09F5E3F01054C959CFC4CB357961ADE\",\n \"paymentSystem\": \"2\",\n \"paymentSystemName\": \"Visa\",\n \"cardNumber\": \"************1111\",\n \"bin\": \"44443334\",\n \"availableAddresses\": [\n \"db267dcc53c14fb2b9a985532dd287bc\"\n ],\n \"expirationDate\": \"01/2032\",\n \"isExpired\": false,\n \"accountStatus\": null\n }\n ],\n \"availableTokens\": [],\n \"transactions\": null,\n \"giftCards\": [],\n \"giftCardMessages\": [],\n \"numberOfPaymentErrors\": 0,\n \"numberOfDeniedTransactions\": 0,\n \"lastDeniedTransaction\": null\n },\n \"clientPreferences\": {\n \"userId\": \"d9b946b8-9524-4b2d-96ec-b35d0625c0a7\",\n \"localeDefault\": \"pt-BR\",\n \"isNewsletterOptIn\": true\n },\n \"isToSavePersonalData\": true,\n \"lastUserPurchases\": [\n {\n \"creationDate\": \"2023-10-23T19:22:12.8989883Z\",\n \"orderId\": \"1370990595750-01\",\n \"orderGroup\": \"1370990595750\",\n \"value\": 3498\n }\n ],\n \"lastPurchasesAddressId\": \"db267dcc53c14fb2b9a985532dd287bc\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -5626,13 +4627,13 @@ { "listen": "test", "script": { - "id": "9578c7c5-d6fa-4fe0-9d2a-a97714d0d426", + "id": "ede87c54-827c-44ae-b810-11818768c767", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/purchase-info - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/purchase-info - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/purchase-info - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"Masked purchase information response.\",\"type\":\"object\",\"description\":\"Masked purchase information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of purchase information.\"},\"document\":{\"title\":\"Purchase information.\",\"type\":\"object\",\"description\":\"Purchase information object.\",\"properties\":{\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"clientPreferences\":{\"type\":\"object\",\"description\":\"Client preferences.\",\"properties\":{}},\"isToSavePersonalData\":{\"type\":\"boolean\",\"description\":\"Defines if personal data will be saved (`true`) or not (`false`).\"},\"lastUserPurchases\":{\"type\":\"array\",\"description\":\"Array with latest purchases from the client.\",\"items\":{\"type\":\"object\",\"description\":\"Purchase information.\",\"properties\":{\"creationDate\":{\"type\":\"string\",\"description\":\"Purchase date in the ISO 8601 format.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Unique identifier of the order.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Unique identifier of the order group.\"},\"value\":{\"type\":\"number\",\"description\":\"Purchase value.\"}}}},\"lastPurchasesAddressId\":{\"type\":\"string\",\"description\":\"Unique identifier of the client address.\"}}},\"meta\":{\"title\":\"Purchase information metadata.\",\"type\":\"object\",\"description\":\"Purchase information metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the purchase information version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the purchase information.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the purchase information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/purchase-info - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"Masked purchase information response.\",\"type\":\"object\",\"description\":\"Masked purchase information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of purchase information.\"},\"document\":{\"title\":\"Purchase information.\",\"type\":\"object\",\"description\":\"Purchase information object.\",\"properties\":{\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"clientPreferences\":{\"type\":\"object\",\"description\":\"Client preferences.\",\"properties\":{}},\"isToSavePersonalData\":{\"type\":\"boolean\",\"description\":\"Defines if personal data will be saved (`true`) or not (`false`).\"},\"lastUserPurchases\":{\"type\":\"array\",\"description\":\"Array with latest purchases from the client.\",\"items\":{\"type\":\"object\",\"description\":\"Purchase information.\",\"properties\":{\"creationDate\":{\"type\":\"string\",\"description\":\"Purchase date in the ISO 8601 format.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Unique identifier of the order.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Unique identifier of the order group.\"},\"value\":{\"type\":\"number\",\"description\":\"Purchase value.\"}}}},\"lastPurchasesAddressId\":{\"type\":\"string\",\"description\":\"Unique identifier of the client address.\"}}},\"meta\":{\"title\":\"Purchase information metadata.\",\"type\":\"object\",\"description\":\"Purchase information metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the purchase information version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the purchase information.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the purchase information expires in ISO 8601 format.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/storage/profile-system/profiles/:profileId/purchase-info - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -5642,7 +4643,7 @@ } }, { - "id": "29f38e95-97a0-4b59-879c-878279d53a90", + "id": "9557cb0e-fae0-4dec-a7cd-aa4e4d8ad732", "name": "Delete purchase information", "request": { "name": "Delete purchase information", @@ -5666,7 +4667,7 @@ { "disabled": true, "description": { - "content": "The `profileId` path parameter may be substituted by other profile fields in this request. When making this request, send the `alternativeKey` parameter with a value equal to the key of the field you wish to use as `profileId`.\n\r\n\r> Currently, there are two possible values for this parameter: `email` and `document`.", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, "key": "alternativeKey", @@ -5677,30 +4678,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -5724,14 +4707,15 @@ "value": "application/json" } ], - "method": "DELETE" + "method": "DELETE", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "e528dc29-dba6-4d73-a9dc-82d0b525dee4", + "id": "600e7ba7-c67a-4eb8-8dcb-3c528f5477bc", "name": "No content", "originalRequest": { "url": { @@ -5748,50 +4732,18 @@ ], "query": [ { - "key": "alternativeKey", - "value": "email" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "alternativeKey", + "value": "email" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5809,6 +4761,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "DELETE", @@ -5816,13 +4776,7 @@ }, "status": "No Content", "code": 204, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -5830,7 +4784,7 @@ { "listen": "test", "script": { - "id": "520b2dd5-c24a-4b39-bfae-b647dbbd05e9", + "id": "af4efacc-1182-48ae-901a-cd82882a5b59", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/storage/profile-system/profiles/:profileId/purchase-info - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5844,7 +4798,7 @@ } }, { - "id": "14c8dc1a-de1d-4d9c-8ffb-5bbab46e053a", + "id": "b44ecac8-5a8c-497a-a0e0-6fc22c8e2bc8", "name": "Get unmasked purchase information", "request": { "name": "Get unmasked purchase information", @@ -5880,30 +4834,12 @@ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", + "content": "(Required) There are two value options for this field: \n\n1. ID of the client's profile, as in the `id` field returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint.\n\r\n2. The value of an alternative key (`email` or `document`). When using this option, the `alternativeKey` query parameter is required, to inform which key is being used.", "type": "text/plain" }, "type": "any", "value": "70caf394-8534-447e-a0ca-1803c669c771", "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -5925,16 +4861,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "42609673-fd77-4600-89a4-1722d92a659a", + "id": "75b8924d-5fc3-4649-ae6d-575a624fb593", "name": "OK", "originalRequest": { "url": { @@ -5951,51 +4892,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "reason", - "value": "data-validation" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "(Required) ID of the client's profile as returned by the [Create profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles) endpoint's response, in the `id` field. It can also be an `alternativeKey` according to your custom profile schema. In this case, this request should also send the `alternativeKey` parameter.", - "type": "text/plain" - }, - "type": "any", - "value": "70caf394-8534-447e-a0ca-1803c669c771", - "key": "profileId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Reason for requesting unmasked data.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "reason", + "value": "data-validation" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -6017,6 +4926,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -6038,13 +4955,13 @@ { "listen": "test", "script": { - "id": "ceb788bc-851b-4eac-8b53-07fa46ca8c52", + "id": "17cd9bb7-2192-4370-9cde-0802c448c221", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info/unmask - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info/unmask - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info/unmask - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of purchase information.\",\"items\":{\"title\":\"Masked purchase information response.\",\"type\":\"object\",\"description\":\"Masked purchase information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of purchase information.\"},\"document\":{\"title\":\"Purchase information.\",\"type\":\"object\",\"description\":\"Purchase information object.\",\"properties\":{\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\",\"example\":\"D09F5E3F01054C959CFC4CB357961ADE\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\",\"example\":\"2\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\",\"example\":\"Visa\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\",\"example\":\"************1111\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\",\"example\":\"44443334\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\",\"example\":\"db267dcc53c14fb2b9a985532dd287bc\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\",\"example\":\"01/2032\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\",\"example\":false},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\",\"example\":null}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\",\"example\":\"12345\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\",\"example\":true},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\",\"example\":\"418213DE29634837A63DD693A937A696\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\",\"example\":\"luxstore\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}},\"example\":{\"id\":\"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\"paymentSystem\":\"6\",\"paymentSystemName\":\"Boleto Bancário\",\"value\":4450,\"installments\":1,\"referenceValue\":4450,\"cardHolder\":null,\"cardNumber\":null,\"firstDigits\":null,\"lastDigits\":null,\"cvv2\":null,\"expireMonth\":null,\"expireYear\":null,\"url\":\"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\"giftCardId\":null,\"giftCardName\":null,\"giftCardCaption\":null,\"redemptionCode\":null,\"group\":\"bankInvoice\",\"tid\":null,\"dueDate\":\"2019-02-02\",\"connectorResponses\":{}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\",\"example\":\"12345\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\",\"example\":\"Message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\",\"example\":0},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\",\"example\":0},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\",\"example\":null}}},\"clientPreferences\":{\"type\":\"object\",\"description\":\"Client preferences.\",\"properties\":{}},\"isToSavePersonalData\":{\"type\":\"boolean\",\"description\":\"Defines if personal data will be saved (`true`) or not (`false`).\"},\"lastUserPurchases\":{\"type\":\"array\",\"description\":\"Array with latest purchases from the client.\",\"items\":{\"type\":\"object\",\"description\":\"Purchase information.\",\"properties\":{\"creationDate\":{\"type\":\"string\",\"description\":\"Purchase date in the ISO 8601 format.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Unique identifier of the order.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Unique identifier of the order group.\"},\"value\":{\"type\":\"number\",\"description\":\"Purchase value.\"}}}},\"lastPurchasesAddressId\":{\"type\":\"string\",\"description\":\"Unique identifier of the client address.\"}}},\"meta\":{\"title\":\"Purchase information metadata.\",\"type\":\"object\",\"description\":\"Purchase information metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the purchase information version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the purchase information.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the purchase information expires in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of purchase information.\",\"items\":{\"title\":\"Masked purchase information response.\",\"type\":\"object\",\"description\":\"Masked purchase information.\",\"properties\":{\"id\":{\"title\":\"id\",\"type\":\"string\",\"description\":\"ID of purchase information.\"},\"document\":{\"title\":\"Purchase information.\",\"type\":\"object\",\"description\":\"Purchase information object.\",\"properties\":{\"paymentData\":{\"title\":\"paymentData\",\"type\":\"object\",\"description\":\"Payment data.\",\"properties\":{\"availableAccounts\":{\"type\":\"array\",\"description\":\"List of available payment accounts.\",\"items\":{\"type\":\"object\",\"description\":\"Information about an available payment account.\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Payment account ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system code.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"cardNumber\":{\"type\":\"string\",\"description\":\"Masked card number.\"},\"bin\":{\"type\":\"string\",\"description\":\"Card bin.\"},\"availableAddresses\":{\"type\":\"array\",\"description\":\"List of available addresses.\",\"items\":{\"type\":\"string\",\"description\":\"Available address ID.\"}},\"expirationDate\":{\"type\":\"string\",\"description\":\"Card expiration date, in `MM/YYYY` format.\"},\"isExpired\":{\"type\":\"boolean\",\"description\":\"Defines if the card is expired (`true`) or not (`false`).\"},\"accountStatus\":{\"type\":[\"string\",\"null\"],\"description\":\"Account status.\"}}}},\"availableTokens\":{\"type\":\"array\",\"description\":\"Available tokens.\",\"items\":{\"type\":\"string\",\"description\":\"Available token.\"}},\"transactions\":{\"type\":[\"array\",\"null\"],\"description\":\"List of transactions.\",\"items\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"required\":[\"isActive\",\"transactionId\",\"merchantName\",\"payments\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether the transaction is active (`true`) or not (`false`).\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"List of payments information.\",\"items\":{\"title\":\"Payment\",\"required\":[\"id\",\"paymentSystem\",\"paymentSystemName\",\"value\",\"installments\",\"referenceValue\",\"cardHolder\",\"cardNumber\",\"firstDigits\",\"lastDigits\",\"cvv2\",\"expireMonth\",\"expireYear\",\"url\",\"giftCardId\",\"giftCardName\",\"giftCardCaption\",\"redemptionCode\",\"group\",\"tid\",\"dueDate\",\"connectorResponses\"],\"type\":\"object\",\"description\":\"Payment information.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment ID.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"paymentSystemName\":{\"type\":\"string\",\"description\":\"Payment system name.\"},\"value\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment value in cents.\"},\"installments\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Payment installments.\"},\"referenceValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reference value for interest calculation in cents.\"},\"cardHolder\":{\"type\":[\"string\",\"null\"],\"description\":\"Card holder.\"},\"cardNumber\":{\"type\":[\"string\",\"null\"],\"description\":\"Card number.\"},\"firstDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card first digits.\"},\"lastDigits\":{\"type\":[\"string\",\"null\"],\"description\":\"Card last digits.\"},\"cvv2\":{\"type\":[\"string\",\"null\"],\"description\":\"Card verification code.\"},\"expireMonth\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration month.\"},\"expireYear\":{\"type\":[\"string\",\"null\"],\"description\":\"Card expiration year.\"},\"url\":{\"type\":\"string\",\"description\":\"Payment URL.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"},\"giftCardName\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card name.\"},\"giftCardCaption\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card caption.\"},\"redemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Redemption code.\"},\"group\":{\"type\":\"string\",\"description\":\"Payment group.\"},\"tid\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment TID.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Due date.\"},\"connectorResponses\":{\"type\":\"object\",\"description\":\"Connector responses.\"}}}}}}},\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card ID.\"}},\"giftCardMessages\":{\"type\":\"array\",\"description\":\"Gift card messages.\",\"items\":{\"type\":\"string\",\"description\":\"Gift card message.\"}},\"numberOfPaymentErrors\":{\"type\":\"number\",\"description\":\"Amount of payment errors.\"},\"numberOfDeniedTransactions\":{\"type\":\"number\",\"description\":\"Amount of denied transactions.\"},\"lastDeniedTransaction\":{\"type\":[\"string\",\"null\"],\"description\":\"Last denied transaction.\"}}},\"clientPreferences\":{\"type\":\"object\",\"description\":\"Client preferences.\",\"properties\":{}},\"isToSavePersonalData\":{\"type\":\"boolean\",\"description\":\"Defines if personal data will be saved (`true`) or not (`false`).\"},\"lastUserPurchases\":{\"type\":\"array\",\"description\":\"Array with latest purchases from the client.\",\"items\":{\"type\":\"object\",\"description\":\"Purchase information.\",\"properties\":{\"creationDate\":{\"type\":\"string\",\"description\":\"Purchase date in the ISO 8601 format.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Unique identifier of the order.\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Unique identifier of the order group.\"},\"value\":{\"type\":\"number\",\"description\":\"Purchase value.\"}}}},\"lastPurchasesAddressId\":{\"type\":\"string\",\"description\":\"Unique identifier of the client address.\"}}},\"meta\":{\"title\":\"Purchase information metadata.\",\"type\":\"object\",\"description\":\"Purchase information metadata.\",\"required\":[\"version\",\"author\",\"creationDate\",\"lastUpdateDate\"],\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Unique identifier of the purchase information version.\"},\"author\":{\"type\":\"string\",\"description\":\"Unique identifier of the user who created the purchase information.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was created in ISO 8601 format.\"},\"lastUpdateDate\":{\"type\":\"string\",\"description\":\"Date when the purchase information was last updated in ISO 8601 format.\"},\"expirationDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Date when the purchase information expires in ISO 8601 format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/storage/profile-system/profiles/:profileId/purchase-info/unmask - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -6057,7 +4974,7 @@ "event": [] }, { - "id": "8e47a82b-d829-42bd-ace7-2f264d5f37b9", + "id": "eb47c417-f5f9-4b9b-b590-6f3485d27676", "name": "Schemas", "description": { "content": "", @@ -6065,7 +4982,7 @@ }, "item": [ { - "id": "483762e5-4fa3-4025-88de-7314755f9b5b", + "id": "2fa2916c-dc48-4ce2-9de2-4713a728e7f7", "name": "Get full schema", "request": { "name": "Get full schema", @@ -6085,26 +5002,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -6124,16 +5022,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "6c2a5301-cb1c-4f62-99ce-afd000bbed8e", + "id": "23a46ea7-6c50-410e-ae3f-a826ec140400", "name": "OK", "originalRequest": { "url": { @@ -6148,36 +5051,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -6199,6 +5075,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -6220,7 +5104,7 @@ { "listen": "test", "script": { - "id": "742cd83c-42af-4d78-a945-c0878d9947d7", + "id": "9d419e12-801f-464c-91a8-f7e3e6d648ed", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/schemas/profileSystem - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6236,7 +5120,7 @@ } }, { - "id": "4a9cbb15-a94a-42f4-99c4-0cee040e0ef6", + "id": "aca2590b-1c64-462d-8589-c7055a1ba720", "name": "Create or delete custom fields", "request": { "name": "Create or delete custom fields", @@ -6257,26 +5141,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -6296,6 +5161,10 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "PUT", @@ -6304,6 +5173,7 @@ "raw": "{\n \"customField1\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"sensitive\": true,\n \"pii\": true\n },\n \"customField2\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"sensitive\": false,\n \"pii\": false\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -6314,7 +5184,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "39f55a11-0989-42f8-a011-930032db9f74", + "id": "66aa3bd4-7a0d-4079-9755-09b986483799", "name": "Created", "originalRequest": { "url": { @@ -6330,36 +5200,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -6377,6 +5220,18 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -6385,6 +5240,7 @@ "raw": "{\n \"customField1\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"sensitive\": true,\n \"pii\": true\n },\n \"customField2\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"sensitive\": false,\n \"pii\": false\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -6392,13 +5248,7 @@ }, "status": "Created", "code": 201, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -6406,7 +5256,7 @@ { "listen": "test", "script": { - "id": "175dd713-277e-4281-aa7e-583c97c490a4", + "id": "f74a086f-14b3-4e36-8161-185a651f07b8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/storage/profile-system/schemas/profileSystem/custom - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -6419,7 +5269,7 @@ } }, { - "id": "ae6e665b-8e8d-4887-9aa9-144c35bc6234", + "id": "1b80fe6e-1e9c-4ac5-a6a0-f29d722cc94c", "name": "Get custom fields", "request": { "name": "Get custom fields", @@ -6440,26 +5290,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -6479,16 +5310,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "dc30be2d-07da-4cd3-a0e4-5f8b58da5156", + "id": "16637e8e-77ac-4112-a494-93541c8ab58a", "name": "OK", "originalRequest": { "url": { @@ -6504,36 +5340,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -6555,6 +5364,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -6576,7 +5393,7 @@ { "listen": "test", "script": { - "id": "0c426632-ff8a-41a1-98b7-931d91dc5536", + "id": "3c86c386-bee7-4331-8769-9582b6b7fdde", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/storage/profile-system/schemas/profileSystem/custom - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6618,33 +5435,24 @@ "event": [], "variable": [ { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, "type": "any", "value": "apiexamples", "key": "accountName" }, { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, "type": "any", "value": "vtexcommercestable", "key": "environment" }, { - "type": "string", + "type": "any", "value": "https://{{accountName}}.{{environment}}.com.br", "key": "baseUrl" } ], "info": { - "_postman_id": "ff72acb7-69a2-48d3-8834-856cbeb4c7e2", + "_postman_id": "c1043b9a-592c-453e-97fa-a2fe30ec953b", "name": "Profile System - PII data architecture", - "version": {}, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": ">⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).\r\n\r\nThe **Profile System** is VTEX's single source of truth regarding shoppers' profile data for stores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture-specifications) from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus). Other modules, such as **Checkout** and **Order Management**, can request data from the **Profile System** when necessary. Learn more at the [Profile System](https://developers.vtex.com/docs/guides/profile-system) guide.\r\n\r\n>⚠️ Data stored in the Profile System is not related to documents saved in [Master Data v1](https://developers.vtex.com/docs/api-reference/masterdata-api) or [Master Data v2](https://developers.vtex.com/docs/api-reference/master-data-api-v2). The API endpoints and features described in this article only apply to documents registered in the new Profile System designed to handle PII data architecture.\r\n\r\n## Index\r\n\r\n### Profiles\r\n\r\n- `POST` [Create client profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles)\r\n- `GET` [Get profile](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-)\r\n- `PATCH` [Update client profile](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/profiles/-profileId-)\r\n- `DELETE` [Delete client profile](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/profiles/-profileId-)\r\n- `GET` [Get unmasked profile](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/unmask)\r\n- `GET` [Get profile by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/versions/-profileVersionId-)\r\n- `GET` [Get unmasked profile by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/versions/-profileVersionId-/unmask)\r\n\r\n### Addresses\r\n\r\n- `POST` [Create client address](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/addresses)\r\n- `GET` [Get client addresses](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses)\r\n- `GET` [Get unmasked client addresses](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/unmask)\r\n- `GET` [Get address](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)\r\n- `PATCH` [Update client address](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)\r\n- `DELETE` [Delete address](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)\r\n- `GET` [Get unmasked address](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/unmask)\r\n- `GET` [Get address by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/versions/-addressVersionId-)\r\n- `GET` [Get unmasked address by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/versions/-addressVersionId-/unmask)\r\n\r\n### Prospects\r\n\r\n- `POST` [Create prospect](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/prospects)\r\n- `GET` [Get prospect](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/-prospectId-)\r\n- `PATCH` [Update prospect](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/prospects/-prospectId-)\r\n- `DELETE` [Delete prospect](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/prospects/-prospectId-)\r\n- `GET` [Get unmasked prospect](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/-prospectId-/unmask)\r\n\r\n### Purchase information\r\n\r\n- `POST` [Create purchase information](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/purchase-info)\r\n- `GET` [Get purchase information](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/purchase-info)\r\n- `PATCH` [Update purchase information](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/profiles/-profileId-/purchase-info)\r\n- `DELETE` [Delete purchase information](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/profiles/-profileId-/purchase-info)\r\n- `GET` [Get unmasked profile information](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/purchase-info/unmask)", From df27bb5d565cf5c64f7456c167f0453ba6f00b68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlia=20Rabello?= <77292838+julia-rabello@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:57:51 -0300 Subject: [PATCH 3/3] apply suggestion MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Isabella Veloso Sá <77300325+Isabella-Veloso@users.noreply.github.com> --- VTEX - Profile System.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Profile System.json b/VTEX - Profile System.json index 091e886a6..7b69f8d57 100644 --- a/VTEX - Profile System.json +++ b/VTEX - Profile System.json @@ -3643,7 +3643,7 @@ "alternativeKey": { "name": "alternativeKey", "in": "query", - "description": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`.There are two possible values: `email` and `document`.", + "description": "When using an alternative key as `profileId` value, fill this parameter with the key you wish to use as `profileId`. There are two possible values: `email` and `document`.", "required": false, "style": "form", "schema": {