A fulfillment record representing a shipment of one or more items in a production order. Contains tracking information and fulfillment status.
| Name | Type | Description | |
|---|---|---|---|
id
|
number
|
Unique numeric identifier for the OrderFulfillment. | |
trackingNumber
|
string
|
Tracking numbers provided by the shipping company. | |
trackingUrl
|
string
|
The URLs of tracking pages for the fulfillment. | |
name
|
string
|
Display name or label for this fulfillment, typically the carrier service name. | |
carrier
|
Carrier | The shipping company. |
{
"orderFulfillment" : {
"id" : 12345,
"trackingNumber" : "222201010015732844",
"trackingUrl" : "https://www.ups.com/track?222201010015732844",
"name" : "UPS Standard",
"carrier" : {
"id" : 12345,
"name" : "UPS",
"description" : "Standard domestic shipping method",
"phoneRequired" : true,
"moduleProvider" : {
"id" : 12345,
"name" : "Standard",
"provider" : "ups",
"serviceType" : "standard",
"moduleType" : { }
},
"customProvider" : "...",
"premium" : true,
"emdorsement" : "...",
"ddp" : true,
"showTicketLogo" : true,
"customApiUser" : "...",
"customApiKey" : "...",
"htmlTemplate" : "...",
"mainCarrier" : { },
"perProduct" : true
}
}
}A fulfillment record representing a shipment of one or more items in a production order. Contains tracking information and fulfillment status.
| Name | Type | Description | |
|---|---|---|---|
carrier
|
Carrier | The shipping company. | |
id
|
int
|
Unique numeric identifier for the OrderFulfillment. | |
name
|
string
|
Display name or label for this fulfillment, typically the carrier service name. | |
trackingNumber
|
string
|
Tracking numbers provided by the shipping company. | |
trackingUrl
|
string
|
The URLs of tracking pages for the fulfillment. |
<orderFulfillment>
<id>...</id>
<trackingNumber>222201010015732844</trackingNumber>
<trackingUrl>https://www.ups.com/track?222201010015732844</trackingUrl>
<name>UPS Standard</name>
<carrier>
<id>...</id>
<name>UPS</name>
<description>Standard domestic shipping method</description>
<phoneRequired>true</phoneRequired>
<moduleProvider>
<id>...</id>
<name>Standard</name>
<provider>ups</provider>
<serviceType>standard</serviceType>
<moduleType/>
</moduleProvider>
<customProvider>...</customProvider>
<premium>...</premium>
<emdorsement>...</emdorsement>
<ddp>...</ddp>
<showTicketLogo>...</showTicketLogo>
<customApiUser>...</customApiUser>
<customApiKey>...</customApiKey>
<htmlTemplate>...</htmlTemplate>
<mainCarrier/>
<perProduct>...</perProduct>
</carrier>
</orderFulfillment>