ecommerce/fulfillments

Retrieve Fulfillments

Changed on

Retrieve fulfillments from any connected Ats software

get/ecommerce/fulfillments/{id}

Request

  • Base URL
    https://api.panora.dev
  • URL
    https://api.panora.dev/ecommerce/fulfillments/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

id of the fulfillment you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Ats software.

Headers

x-connection-tokenstring required

The connection token

Response

carrierstring nullable

The carrier of the fulfilment

tracking_urlsstring[] nullable

The tracking URLs of the fulfilment

tracking_numbersstring[] nullable

The tracking numbers of the fulfilment

itemsobject nullable

The items in the fulfilment

order_idstring nullable

The UUID of the order associated with the fulfilment

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the fulfilment

remote_idstring nullable

The remote ID of the fulfilment in the context of the 3rd Party

remote_dataobject nullable

The remote data of the customer in the context of the 3rd Party

created_atstring nullable

The created date of the object

modified_atstring nullable

The modified date of the object

Example response

{
  "carrier": "DHL",
  "tracking_urls": [
    "https://tracing-url.sf.com"
  ],
  "tracking_numbers": [
    "track_1029_191919"
  ],
  "items": {},
  "order_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}

Changes

  • 87189baf7791Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

  • 3ce49f5aad53Revision changes
    • info

      endpoint added