Acknowledge package tracking

We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.

Take me there

Acknowledge package tracking

Acknowledges package tracking details

Request

header Parameters

required

object

x-site-context value

Request Body schema: application/json

orderNumber required	string Order number generated by fabric OMS
eventType required	string Enum: "ORDER_CREATE_IN_PTS" "ORDER_CANCELLED_IN_PTS" "SHIPMENT_CREATE_IN_PTS" "SHIPMENT_CANCELLED_IN_PTS"
entity required	string Enum: "ORDER" "SHIPMENT"
shipmentId	string Shipment ID generated by fabric OMS

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

post/order/package-tracking/acknowledge

Request samples

Payload

application/json

{"orderNumber": "order123",
"eventType": "ORDER_CREATE_IN_PTS",
"entity": "ORDER",
"shipmentId": "shipment123"
}

Response samples

application/json

{"shipmentId": "627963716b19511e8a3a631b",
"shipmentNum": "78974156816152",
"invoiceId": "5674156816152",
"allocationId": "112345678912340",
"orderNumber": 112345678912340,
"poNumber": 1125,
"vendorId": 56,
"statusCode": "SHIPPED",
"type": "STANDARD",
"reshipmentReasonCode": "Order went missing",
"shipDate": "2022-06-06T07:58:30.996Z",
"locationNum": "132412",
"locationType": "DC",
"totalCartons": 2,
"masterTrackingNumber": "TX112345678",
"shipToId": "1",
"shipToAddress": {"addressLine1": "888 Broadway",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "New York",
"state": "NY",
"country": "USA",
"postalCode": "1003",
"type": "home",
"latitude": 134.13413,
"longitude": 757.0435
},
"recipient": [{"name": {"first": "John",
"middle": "string",
"last": "Doe"
},
"email": "wa",
"phone": {"number": "+10612345678",
"type": "MOBILE"
}
}
],
"cartons": [{"cartonNum": "1",
"cartonType": "Package",
"promisedDeliveryDate": "2022-05-26T07:58:30.996Z",
"estimatedShipDate": "2022-05-25T07:58:30.996Z",
"estimatedDeliveryDate": "2022-05-26T07:58:30.996Z",
"shipmentMethod": "ground",
"shipmentCarrier": "FEDEX",
"weight": "500 gram",
"trackingNumber": "1Z999AA10123456784",
"trackingURL": "https://fedex.com/tracking",
"trackingDetails": [{"event": "picked up",
"eventId": "627963716b19511e8a3a631b",
"timestamp": "2019-09-30T07:58:30.996Z",
"shipmentCarrier": "FEDEX",
"location": "Reno, NV",
"notes": {"property1": "string",
"property2": "string"
}
}
],
"items": [{"shipmentLineItemId": "607f1f77bcf86cd799439011",
"orderId": "317736896",
"orderNumber": "507f1f77bcf86cd799439011",
"lineItemId": "1",
"itemId": "100023",
"sku": "SKU0023",
"channelId": "12",
"segment": "string",
"vendorId": "string",
"orderedQuantity": 2,
"shippedQuantity": 2,
"returnQuantity": 1,
"returnAmount": 10,
"fees": [{"type": "tax",
"value": 34.56,
"quantity": 12,
"refundAmount": 10.4
}
],
"giftCard": [{"giftCardNum": "453456765",
"amount": 50,
"giftCardStatus": "ACTIVE",
"giftCardActiveRequestDate": "2022-05-26T07:58:30.996Z",
"giftCardActiveDate": "2022-06-26T07:58:30.996Z"
}
],
"attributes": {"property1": { },
"property2": { }
},
"uom": "string"
}
]
}
],
"scratchedItems": [{"orderId": "507f1f77bcf86cd799439012",
"lineItemId": "2",
"itemId": "100043",
"sku": "SKU00043",
"quantity": 1,
"reasonCode": "string",
"subReasonCode": "string",
"attributes": {"property1": { },
"property2": { }
},
"uom": "EA"
}
],
"createdAt": "2022-06-06T07:58:30.996Z",
"updatedAt": "2022-06-06T07:58:30.996Z",
"auditLogs": [{"auditType": "create",
"employeeId": "62272e917b12209e68751d94",
"auditTimestamp": "2022-05-12T09:24:54.804Z",
"source": "POS",
"note": "Note",
"attributes": {"property1": { },
"property2": { }
},
"updatedFields": [{"attributeName": "UOM",
"attributeOriginalValue": "PK"
}
]
}
],
"attributes": {"property1": { },
"property2": { }
}
}