Skip to content

Fix: Document searchField enum and companion query parameters in List Orders #1728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
guitavano wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix: Document searchField enum and companion query parameters in List Orders #1728

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 82 additions & 2 deletions VTEX - Orders API.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4429,13 +4429,93 @@
{
"name": "searchField",
"in": "query",
"description": "You can search orders by using one of the following criterias: \r\n- SKU ID - `sku_Ids&sku_Ids` \r\n- Gift List ID - `listId&listId` \r\n- Transaction ID (TID) - `tid&tid` \r\n- PCI Connector's Transaction ID (TID) - `pci_tid&pci_tid` \r\n- Payment ID (PID) - `paymentId&paymentId` \r\n- Connector's NSU - `nsu&nsu`",
"description": "Defines the search criteria for filtering orders. Must be used together with the corresponding query parameter that provides the search value. For example, to search by SKU ID: `?searchField=sku_Ids&sku_Ids=11223`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "- SKU ID: `25` \r\n- Gift List ID: `11223` \r\n- Transaction ID (TID): `54546300238810034995829230012` \r\n- PCI Connector's Transaction ID (TID): `7032909234899834298423209` \r\n- Payment ID (PID): `2` \r\n- Connector's NSU: `2437281`"
"enum": [
"sku_Ids",
"listId",
"tid",
"pci_tid",
"paymentId",
"nsu"
],
"example": "sku_Ids"
}
},
{
"name": "sku_Ids",
"in": "query",
"description": "SKU ID to filter orders. Must be used with `searchField=sku_Ids`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "25"
}
},
{
"name": "listId",
"in": "query",
"description": "Gift List ID to filter orders. Must be used with `searchField=listId`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "11223"
}
},
{
"name": "tid",
"in": "query",
"description": "Transaction ID (TID) to filter orders. Must be used with `searchField=tid`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "54546300238810034995829230012"
}
},
{
"name": "pci_tid",
"in": "query",
"description": "PCI Connector's Transaction ID (TID) to filter orders. Must be used with `searchField=pci_tid`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "7032909234899834298423209"
}
},
{
"name": "paymentId",
"in": "query",
"description": "Payment ID (PID) to filter orders. Must be used with `searchField=paymentId`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "2"
}
},
{
"name": "nsu",
"in": "query",
"description": "Connector's NSU to filter orders. Must be used with `searchField=nsu`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "2437281"
}
},
{
Expand Down