A valid request URL is required to generate request examples{
"id": "<string>",
"code": "<string>",
"status": "<string>",
"items": [
{
"productCode": "<string>",
"quantity": 123,
"fulfillmentItemType": "<string>",
"lineId": 123,
"optionAttributeFQN": "<string>"
}
],
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"availableActions": [
"<string>"
],
"changeMessages": [
{
"id": "<string>",
"correlationId": "<string>",
"userId": "<string>",
"userFirstName": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"subjectType": "<string>",
"success": true,
"identifier": "<string>",
"subject": "<string>",
"verb": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"oldValue": "<string>",
"newValue": "<string>",
"amount": 123,
"createDate": "2023-11-07T05:31:56Z",
"attributes": {}
}
],
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shipmentId": "<string>",
"trackingNumber": "<string>",
"trackingNumbers": [
"<string>"
],
"packagingType": "<string>",
"hasLabel": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
}
},
"carrier": "<string>",
"signatureRequired": true,
"trackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"packingSlipItemDetails": [
{
"attributes": {},
"lineId": 123,
"originalOrderItemId": "<string>",
"quantity": 123
}
],
"packingSlipNumber": 123,
"returnTrackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"returnTrackingNumbers": [
"<string>"
],
"returnCarrier": "<string>",
"packageId": "<string>",
"manifestId": "<string>",
"labelFormat": "<string>",
"integratorId": "<string>",
"fxcbPackNotificationId": "<string>",
"fxcbDocumentsUrl": "<string>",
"attributes": {}
}package?
A valid request URL is required to generate request examples{
"id": "<string>",
"code": "<string>",
"status": "<string>",
"items": [
{
"productCode": "<string>",
"quantity": 123,
"fulfillmentItemType": "<string>",
"lineId": 123,
"optionAttributeFQN": "<string>"
}
],
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"availableActions": [
"<string>"
],
"changeMessages": [
{
"id": "<string>",
"correlationId": "<string>",
"userId": "<string>",
"userFirstName": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"subjectType": "<string>",
"success": true,
"identifier": "<string>",
"subject": "<string>",
"verb": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"oldValue": "<string>",
"newValue": "<string>",
"amount": 123,
"createDate": "2023-11-07T05:31:56Z",
"attributes": {}
}
],
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shipmentId": "<string>",
"trackingNumber": "<string>",
"trackingNumbers": [
"<string>"
],
"packagingType": "<string>",
"hasLabel": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
}
},
"carrier": "<string>",
"signatureRequired": true,
"trackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"packingSlipItemDetails": [
{
"attributes": {},
"lineId": 123,
"originalOrderItemId": "<string>",
"quantity": 123
}
],
"packingSlipNumber": 123,
"returnTrackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"returnTrackingNumbers": [
"<string>"
],
"returnCarrier": "<string>",
"packageId": "<string>",
"manifestId": "<string>",
"labelFormat": "<string>",
"integratorId": "<string>",
"fxcbPackNotificationId": "<string>",
"fxcbDocumentsUrl": "<string>",
"attributes": {}
}JWT Authorization header using the Bearer scheme.
Unique identifier of the return with which to associate the package.
limits which fields are returned in the response body
Package to create and add to the return
Describes a package that will be shipped to somebody
ID of the fulfillment unit.
A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form {fulfillmentUnitType} #{next available int}
Status of the fulfillment unit See FulfillmentStatusConst
List of items in the fulfillment unit
Show child attributes
Date of the pickup
Location code from which to obtain this item
Show child attributes
Actions that can be taken on this fulfillment unit
Change messages related to the fulfillment unit.
Show child attributes
Code describing the shipping method.
Name of the shipping method
ID of the related shipment
Tracking number of this package (to support classic use cases)
Tracking number of this package
Packaging type of this package
If there is a shipping label present for this Package, this will be set to true
Physical dimensions of the package required to ship the product and its weight.
Show child attributes
Carrier of this package
SignatureRequired for this package
Tracking number and url data for this package
Show child attributes
PackingSlipItemDetails for this package
Show child attributes
PackingSlipNumber for this package
Show child attributes
Show child attributes
Success
Describes a package that will be shipped to somebody
ID of the fulfillment unit.
A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form {fulfillmentUnitType} #{next available int}
Status of the fulfillment unit See FulfillmentStatusConst
List of items in the fulfillment unit
Show child attributes
Date of the pickup
Location code from which to obtain this item
Show child attributes
Actions that can be taken on this fulfillment unit
Change messages related to the fulfillment unit.
Show child attributes
Code describing the shipping method.
Name of the shipping method
ID of the related shipment
Tracking number of this package (to support classic use cases)
Tracking number of this package
Packaging type of this package
If there is a shipping label present for this Package, this will be set to true
Physical dimensions of the package required to ship the product and its weight.
Show child attributes
Carrier of this package
SignatureRequired for this package
Tracking number and url data for this package
Show child attributes
PackingSlipItemDetails for this package
Show child attributes
PackingSlipNumber for this package
Show child attributes
Show child attributes