EDU-15445-feat/-update-pick-and-pack-api #1482
Open
+1,164
−393
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
karenkrieger
force-pushed
the
EDU-15445-feat/-update-pick-and-pack-api
branch
from
c821b28 to
a9839d6
Compare
|
Thanks for your contribution. The .json file will be checked now with Spectral. |
karenkrieger
force-pushed
the
EDU-15445-feat/-update-pick-and-pack-api
branch
from
626b575 to
6813f21
Compare
Isabella-Veloso
previously approved these changes
Jul 10, 2025
karenkrieger
force-pushed
the
EDU-15445-feat/-update-pick-and-pack-api
branch
2 times, most recently
from
a35e128 to
028c145
Compare
crisak
suggested changes
Jul 29, 2025
Comment on lines
3413
to
3420
| "items": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/Item" | ||
| "$ref": "#/components/schemas/Item", | ||
| "description": "Item details." | ||
| }, | ||
| "description": "List of items." | ||
| }, |
There was a problem hiding this comment.
This field should be a array of strings.
"items": {
"type": "array",
"items": { "type": "string", "description": "Item detail." }
},
Comment on lines
+1570
to
+1573
| "orderSource": { | ||
| "type": "string", | ||
| "description": "Order source." | ||
| }, |
There was a problem hiding this comment.
This field should be a array but is a string.
Suggestion
"orderSource": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rejectedQuantity": { "type": "integer" },
"sellingPrice": { "type": "number" },
"quantity": { "type": "integer" },
"notes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"user": { "type": "string" },
"note": { "type": "string" }
},
"required": ["id", "user", "note"]
}
},
"orderId": { "type": "string", "minLength": 1 },
"replacedQuantity": { "type": "integer" },
"replacedBy": {
"type": "array",
"items": { "type": "string" }
},
"pickedQuantity": { "type": "integer" },
"currencyCode": {
"type": "string",
"description": "ISO 4217 currency code (COP, USD).",
"minLength": 3
},
"listPrice": { "type": "number" },
"status": {
"type": "string",
"enum": [
"PENDING",
"ASSIGNED",
"COLLECTED",
"REPLACED",
"REJECTED",
"REFUNDED",
"RETURNED",
"CANCELLED",
"PENDING_TRANSFERRED",
"TRANSFERRED",
"COMPLETED",
"READY_FOR_PACKING",
"READY_FOR_SHIPPING",
"SHIPPED",
"DELIVERED",
"PACKED",
"PAUSED"
],
"minLength": 1
}
},
"required": [
"rejectedQuantity",
"sellingPrice",
"quantity",
"notes",
"orderId",
"replacedQuantity",
"replacedBy",
"pickedQuantity",
"currencyCode",
"listPrice",
"status"
]
}
}
karenkrieger
force-pushed
the
EDU-15445-feat/-update-pick-and-pack-api
branch
from
028c145 to
dd63405
Compare
…thub.com/vtex/openapi-schemas into EDU-15445-feat/-update-pick-and-pack-api
crisak
suggested changes
Jul 30, 2025
Comment on lines
+1574
to
+1577
| "referenceCode": { | ||
| "type": "string", | ||
| "description": "Picked item reference code." | ||
| }, |
There was a problem hiding this comment.
This field is new in Vtex-OpenAPI and was not present in the original schema, this should be removed.
Suggested change
| "referenceCode": { | |
| "type": "string", | |
| "description": "Picked item reference code." | |
| }, |
| "orderSource" | ||
| ], | ||
| "type": "object", | ||
| "properties": { |
There was a problem hiding this comment.
items[].rejectedQuantity: This field is not defined in entityitemsand this field should be required.items[].replacedQuantity: This field is not defined in entityitemsand this field should be required.items[].temperature: . This field is not defined in entityitemsand this field should be required .
Comment on lines
2951
to
2977
| "notes": { | ||
| "type": "array", | ||
| "description": "List of notes.", | ||
| "items": { | ||
| "type": "string", | ||
| "description": "Note." | ||
| }, | ||
| "description": "List of notes." | ||
| "type": "object", | ||
| "description": "Note information.", | ||
| "properties": { | ||
| "date": { | ||
| "type": "string", | ||
| "description": "Date and time when the note was created." | ||
| }, | ||
| "type": { | ||
| "type": "string", | ||
| "description": "Type of the note.", | ||
| "enum": ["COMMENT", "ERROR"] | ||
| }, | ||
| "content": { | ||
| "type": "string", | ||
| "description": "Content of the note." | ||
| }, | ||
| "author": { | ||
| "type": "string", | ||
| "description": "Author of the note." | ||
| } | ||
| } | ||
| } | ||
| }, |
There was a problem hiding this comment.
pickerAssignment[].notes: This field should be a array of strings but is a array of objects.
Suggested change
| "notes": { | |
| "type": "array", | |
| "description": "List of notes.", | |
| "items": { | |
| "type": "string", | |
| "description": "Note." | |
| }, | |
| "description": "List of notes." | |
| "type": "object", | |
| "description": "Note information.", | |
| "properties": { | |
| "date": { | |
| "type": "string", | |
| "description": "Date and time when the note was created." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "Type of the note.", | |
| "enum": ["COMMENT", "ERROR"] | |
| }, | |
| "content": { | |
| "type": "string", | |
| "description": "Content of the note." | |
| }, | |
| "author": { | |
| "type": "string", | |
| "description": "Author of the note." | |
| } | |
| } | |
| } | |
| }, | |
| "notes": { | |
| "type": "array", | |
| "description": "List of notes.", | |
| "items": { | |
| "type": "string", | |
| "description": "Note information." | |
| } | |
| }, |
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/GetWorksheetResponse", | ||
| "description": "Historical worksheet." | ||
| "$ref": "#/components/schemas/ItemRejected", |
There was a problem hiding this comment.
Reusing this schema conflicts with in components.schemas.GetOrderResponse.properties.rejectedItems.items.$ref. For this property, I recommend defining a new schema because they handle different fields.
| "replacedItems": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/Item", | ||
| "$ref": "#/components/schemas/ItemReplaced", |
There was a problem hiding this comment.
Reusing this schema conflicts with components.schemas.GetOrderResponse.properties.replacedItems.items.$ref. For this property, I recommend defining a new schema because they handle different fields.
Warning
| @@ -3044,21 +3705,13 @@ | |||
| "seller", | |||
| "status", | |||
There was a problem hiding this comment.
status This field should be a enum but is not defined as such.
suggestion
"status": {
"type": "string",
"description": "Shipment status.",
"enum": [
"CREATED",
"PENDING",
"ASSIGNED",
"PICKED",
"ON_ROUTE",
"INCIDENT",
"RETURNED",
"DELIVERED",
"CANCELED",
"ON_HOLD",
"TRANSFER"
]
}
Comment on lines
4334
to
4341
| "status", | ||
| "carrierName", | ||
| "paymentMethod", | ||
| "tags", | ||
| "deliveredDate", | ||
| "customerId", | ||
| "customerAddressId", | ||
| "source", | ||
| "destination", | ||
| "courierId", | ||
| "courierName", | ||
| "seller", | ||
| "packagesQuantity", | ||
| "itemsQuantity", |
There was a problem hiding this comment.
Good work on these changes, but we need to make the following changes to these properties in components.schemas.ListShipmentsResponse:
courierId: This field should be nullable but it is not nullable.courierName: This field should be nullable but it is not nullable.paymentMethod: This field should be an enum but it is not defined as one."paymentMethod": { "type": "string", "description": "Payment method.", "enum": ["ONLINE", "CASH", "CREDIT_CARD", "DEBIT_CARD", "OTHER"] }
serviceType: This field should be an enum but it is not defined as one."serviceType": { "type": "string", "description": "Service type.", "enum": ["PICKUP_DELIVERY", "DELIVERY", "PICKUP"] }
status: This field should be an enum but it is not defined as one."status": { "type": "string", "description": "Shipment status.", "enum": [ "CREATED", "PENDING", "ASSIGNED", "PICKED", "ON_ROUTE", "INCIDENT", "RETURNED", "DELIVERED", "CANCELED", "ON_HOLD", "TRANSFER" ] }
Comment on lines
803
to
808
| "servers": [ | ||
| { | ||
| "url": "https://api.pick-and-pack.com/prod", | ||
| "url": "https://api.pick-and-pack.com/prod/v1", | ||
| "description": "Server to access the Pick and Pack API." | ||
| } | ||
| ] |
| @@ -141,7 +335,7 @@ | |||
| ], | |||
| "servers": [ | |||
| { | |||
| "url": "https://api.pick-and-pack.com/prod", | |||
| "url": "https://api.pick-and-pack.com/prod/v1", | |||
There was a problem hiding this comment.
In the VTEX documentation, it's using this endpoint by default for all resources: "https://auth.pickingnpacking.com/prod", even though each resource has its own "servers" set up explicitly.
This happens because it always takes the first position from the globally(root) defined server array.
I suggest changing the position of the globally defined servers from this:
"servers": [
{
"url": "https://auth.pickingnpacking.com/prod",
"description": "Server to access the authentication necessary to make a request in the Pick and Pack API."
},
{
"url": "https://api.pick-and-pack.com/prod/v1",
"description": "Server to access the Pick and Pack API."
}
],to this:
"servers": [
{
"url": "https://api.pick-and-pack.com/prod/v1",
"description": "Server to access the Pick and Pack API."
},
{
"url": "https://auth.pickingnpacking.com/prod",
"description": "Server to access the authentication necessary to make a request in the Pick and Pack API."
}
],This is done so the default endpoint becomes: "https://api.pick-and-pack.com/prod/v1"
| "description": "Server to access the Pick and Pack API." | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "/shipments/{orderId}": { | ||
| "/shipments/": { |
There was a problem hiding this comment.
Suggested change
| "/shipments/": { | |
| "/shipments": { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Types of changes
Changelog
Do not forget to update your changes to our Developer Portal's changelog. Did you create a release note?