Update API v5 methods#117
Merged
Merged
Conversation
Method summary:
- POST /api/v5/customers/create: method already existed; expanded customer and address DTOs to match current documentation, fixed the CustomerCreate example.
- POST /api/v5/orders/create: method already existed; expanded order, order item, company, and integration delivery DTOs.
- GET /api/v5/reference/delivery-types: method and DTOs were checked, no changes required.
- GET /api/v5/store/inventories: added explicit StoreInventories on top of existing Inventories, request/response aliases, and a test.
- GET /api/v5/store/offers: method was checked; existing StoreOffers and filters match the documentation.
- GET /api/v5/store/products: added explicit StoreProducts on top of existing Products, new filter fields, and a test.
- GET /api/v5/orders/packs: method already existed; fixed filter[stores][] encoding and expanded PackItem.
- POST /api/v5/orders/packs/create: method was checked; existing PackCreate uses the current Pack DTO.
- POST /api/v5/orders/packs/{id}/delete: method was checked, no changes required.
- POST /api/v5/orders/packs/{id}/edit: method was checked; existing PackEdit uses the current Pack DTO.
- POST /api/v5/orders/{externalId}/delivery/cancel: method was checked, no changes required.
- POST /api/v5/delivery/generic/{subcode}/tracking: added cost to DeliveryTrackingRequest and expanded the test.
- GET /api/v5/delivery/shipments: method and DTOs were checked, no changes required.
- POST /api/v5/delivery/shipments/create: method was checked; current fields are already supported through DeliveryShipment.
- GET /api/v5/delivery/shipments/{id}: method was checked; current fields are already supported through DeliveryShipment.
- POST /api/v5/delivery/shipments/{id}/edit: method was checked; current fields are already supported through DeliveryShipment.
Backward compatibility:
- ProductsFilter.Groups changed from string to []int to encode filter[groups][] according to the documentation.
- PacksFilter.Stores now encodes as filter[stores][], changing the query string for this filter.
- Several exported DTOs gained new fields; this is compatible for keyed composite literals, but users with unkeyed composite literals may need to update their code.
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
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.
Method summary:
POST/api/v5/customers/create: method already existed; expanded customer and address DTOs to match current documentation, fixed theCustomerCreateexample.POST/api/v5/orders/create: method already existed; expanded order, order item, company, and integration delivery DTOs.GET/api/v5/reference/delivery-types: method and DTOs were checked, no changes required.GET/api/v5/store/inventories: added explicitStoreInventorieson top of existing Inventories, request/response aliases, and a test.GET/api/v5/store/offers: method was checked; existingStoreOffersand filters match the documentation.GET/api/v5/store/products: added explicitStoreProductson top of existingProducts, new filter fields, and a test.GET/api/v5/orders/packs: method already existed; fixedfilter[stores][]encoding and expandedPackItem.POST/api/v5/orders/packs/create: method was checked; existingPackCreateuses the currentPackDTO.POST/api/v5/orders/packs/{id}/delete: method was checked, no changes required.POST/api/v5/orders/packs/{id}/edit: method was checked; existingPackEdituses the currentPackDTO.POST/api/v5/orders/{externalId}/delivery/cancel: method was checked, no changes required.POST/api/v5/delivery/generic/{subcode}/tracking: added cost toDeliveryTrackingRequestand expanded the test.GET/api/v5/delivery/shipments: method and DTOs were checked, no changes required.POST/api/v5/delivery/shipments/create: method was checked; current fields are already supported throughDeliveryShipment.GET/api/v5/delivery/shipments/{id}: method was checked; current fields are already supported throughDeliveryShipment.POST/api/v5/delivery/shipments/{id}/edit: method was checked; current fields are already supported throughDeliveryShipment.Backward compatibility:
ProductsFilter.Groupschanged from string to[]intto encodefilter[groups][]according to the documentation.PacksFilter.Storesnow encodes asfilter[stores][], changing the query string for this filter.