ACSP-230 The shipment examples use POST /shipment instead of POST /order/{orderId}/ship

rubencougil commented 2 months ago

The shipment examples use POST /shipment instead of POST /order/{orderId}/ship

Description

see https://github.com/adobe/commerce-integration-starter-kit/issues/12

Motivation and Context

see https://github.com/adobe/commerce-integration-starter-kit/issues/12

How Has This Been Tested?

For an existing order in Commerce

ingest a be-observer.sales_order_shipment_create event
and confirm that the order is shipped
ingest a be-observer.sales_order_shipment_update
and confirm that the shipment is updated

Screenshots (if appropriate):

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[ ] I have signed the Adobe Open Source CLA.
[ ] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[ ] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

rojoangel commented 2 months ago

In 3b237d4 I made the payload compatible with https://adobe-commerce.redoc.ly/2.4.7-admin/tag/orderorderIdship#operation/PostV1OrderOrderIdShip

{
  "items": [
    {
      "extension_attributes": {},
      "order_item_id": 0,
      "qty": 0
    }
  ],
  "notify": true,
  "appendComment": true,
  "comment": {
    "extension_attributes": {},
    "comment": "string",
    "is_visible_on_front": 0
  },
  "tracks": [
    {
      "extension_attributes": {},
      "track_number": "string",
      "title": "string",
      "carrier_code": "string"
    }
  ],
  "packages": [
    {
      "extension_attributes": {}
    }
  ],
  "arguments": {
    "extension_attributes": {
      "source_code": "string"
    }
  }
}

For example, note that the payload is not wrapped in an entity JSON object

rojoangel commented 2 months ago

I've added how the change was tested to the PR description 😉

adobe / commerce-integration-starter-kit

ACSP-230 The shipment examples use POST /shipment instead of POST /order/{orderId}/ship #18