Update a fulfillment by ID.
The ID of the fulfillment.
The unique store identifier is generated by AfterShip. You can obtain this id by making a GET /stores call to get existing stores or a POST /stores to create a new store.
The date and time, formatted in ISO 8601, indicating when the fulfillment was updated in your e-commerce system.
The pickup information of the fulfillment. It is recommended to include this field if the fulfillment's delivery method is pickup.
The expected date and time when the items in this fulfillment order will be ready for pickup.Show all...
The latest time by which the pickup must be completed, formatted in ISO 8601.Show all...
The shipment information of the fulfillment. Note: This endpoint directly replaces any existing trackings with the provided data. To avoid updating trackings, simply omit this key-value pair from your request. Note that providing an empty array will result in the deletion of all current trackings.
Unique courier code. For a complete list of available courier codes, click here.
The type of logistics service selected for this shipment, e.g. SeaFreight, SmartPost.
The ship date of the package in YYYY-MM-DD format.
Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any personal data in custom fields.Show all...
Next Carrier Information. Utilize this field to manually specify the details for the next leg of a shipment if it involves multiple carriers. This is especially useful when the carrier handling the initial leg of the shipment does not provide information about the carrier for the subsequent leg.Show all...
The location information where the fulfillment shipped from. It is recommended to include this field if the fulfillment's delivery method is shipping.
The unique identifier for the location, as provided by AfterShip. You can manage and configure these locations here.
The addess object of this location.
The location information where the fulfillment shipped to. It is recommended to include this field if the fulfillment's delivery method is shipping.
The address object of ship to location.
The location information where the fulfillment is designated to be pickup from. Mandatory when the delivery method of the fulfillment is pickup.
The unique identifier for the address. You can find or create the corresponding value here.
Address of the pickup location.
Opening hours information of the pickup location.
The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...
Error code in integer format. For detailed information, please refer to the Request Error introduction page.
Response type string for the reference. For detailed information, please refer to the Request Error introduction page.
Human-readable response message. For detailed information, please refer to the Request Error introduction page.
Error detail object. Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.Show all...
The Fulfillment model encapsulates the details of processing and delivering orders in an eCommerce context. It includes information such as fulfillment status, shipment tracking, the items to be fulfilled, and so on.Show all...
The fulfillment ID generated by AfterShip.
The original fulfillment ID in your system.
Unique identifier of the related order. Matches order.id to connect the fulfillment with its order.
The original order ID in your system.
Delivery method of the order. For BOPIS related feature, please specify pickup.Show all...
The status of the fulfillment. Depending of on the delivery_method, the allowed values are different.Show all...
The items which included in this fulifllment.
The date and time, formatted in ISO 8601, indicating when the fulfillment was created in your e-commerce system.
The date and time, formatted in ISO 8601, indicating when the fulfillment was updated in your e-commerce system.
The date and time (ISO 8601 format) when the fulfillment was created in AfterShip.
The date and time (ISO 8601 format) when the fulfillment was updated in AfterShip.
The location information where the fulfillment shipped from.
The location information where the fulfillment shipped to.
The location information where the fulfillment is designated to be pickup from.
The shipment information of the fulfillment.
The pickup information of the fulfillment.
{
"source_updated_at": "2021-04-15T20:02:09Z",
"pickup_info": {
"instructions": "Shop open from Mon to Fri",
"estimated_ready_for_pickup_at": {
"min": "2021-04-15T20:02:09Z",
"max": "2021-04-15T20:02:09Z"
},
"pickup_deadline_at": "2021-04-15T20:02:09Z"
},
"trackings": [
{
"tracking_number": "RA123456789US",
"slug": "usps",
"service_type": "standard shipping",
"ship_date": "2023-05-04",
"custom_fields": {},
"next_couriers": [
{
"tracking_number": "RA123456789US",
"slug": "usps"
}
]
}
],
"ship_from_location": {
"location_id": "489b4bdec18d45d387752d63fb51ee1d",
"address": {
"type": "business",
"street_1": "1234 Elm Street",
"street_2": "Apt 5",
"street_3": "",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country_region": "USA",
"company": "My Company",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone": "+11234567890"
}
},
"ship_to_location": {
"address": {
"type": "business",
"street_1": "1234 Elm Street",
"street_2": "Apt 5",
"street_3": "",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country_region": "USA",
"company": "My Company",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone": "+11234567890"
}
},
"pickup_location": {
"location_id": "e9ec84ff351e45e089a7b75ae497e1ae",
"address": {
"type": "business",
"street_1": "1234 Elm Street",
"street_2": "Apt 5",
"street_3": "",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country_region": "USA",
"company": "My Company",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone": "+11234567890",
"coordinate": {
"latitude": 43,
"longitude": -75
}
},
"opening_hours": {
"sunday": {
"open": true,
"from": "10:30",
"to": "20:30"
},
"monday": {
"open": true,
"from": "10:30",
"to": "20:30"
},
"tuesday": {
"open": true,
"from": "10:30",
"to": "20:30"
},
"wednesday": {
"open": true,
"from": "10:30",
"to": "20:30"
},
"thursday": {
"open": true,
"from": "10:30",
"to": "20:30"
},
"friday": {
"open": true,
"from": "10:30",
"to": "20:30"
},
"saturday": {
"open": true,
"from": "10:30",
"to": "20:30"
}
}
}
}{ "meta": { "code": 20000, "type": "OK", "message": "The request was successfully processed by AfterShip." }, "data": { "id": "331365ab36314decb5dd0bedf862bd5b", "source_id": "423562565", "order_id": "0ecb8ff7efa84d7d8f763ed7b89851c8", "source_order_id": "5187092316403", "delivery_method": "pickup", "status": "processing", "line_items": [ { "source_id": "13097711141107", "source_product_id": "8021450916083", "source_product_variant_id": "43768285298931", "product_title": "Power Mobile Phone", "product_variant_title": "Power Mobile Phone (While)", "sku": "SKU001", "quantity": 1, "unit_price": { "currency": "USD", "amount": "10" }, "unit_weight": { "unit": "kg", "value": 10 }, "image_urls": [ "https://example.com/product/image.png" ] } ], "source_created_at": "2021-04-15T20:02:09Z", "source_updated_at": "2021-04-16T20:02:09Z", "created_at": "2021-04-15T20:02:09Z", "updated_at": "2021-04-16T20:02:09Z", "ship_from_location": { "location_id": "489b4bdec18d45d387752d63fb51ee1d", "address": { "type": "business", "street_1": "1234 Elm Street", "street_2": "Apt 5", "street_3": "", "city": "New York", "state": "NY", "postal_code": "10001", "country_region": "USA", "company": "My Company", "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "+11234567890" } }, "ship_to_location": { "location_id": "489b4bdec18d45d387752d63fb51ee1d", "address": { "type": "business", "street_1": "1234 Elm Street", "street_2": "Apt 5", "street_3": "", "city": "New York", "state": "NY", "postal_code": "10001", "country_region": "USA", "company": "My Company", "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "+11234567890" } }, "pickup_location": { "location_id": "e9ec84ff351e45e089a7b75ae497e1ae", "address": { "type": "business", "street_1": "1234 Elm Street", "street_2": "Apt 5", "street_3": "", "city": "New York", "state": "NY", "postal_code": "10001", "country_region": "USA", "company": "My Company", "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "+11234567890", "coordinate": { "latitude": 43, "longitude": -75 } }, "opening_hours": { "sunday": { "open": true, "from": "10:30", "to": "20:30" }, "monday": { "open": true, "from": "10:30", "to": "20:30" }, "tuesday": { "open": true, "from": "10:30", "to": "20:30" }, "wednesday": { "open": true, "from": "10:30", "to": "20:30" }, "thursday": { "open": true, "from": "10:30", "to": "20:30" }, "friday": { "open": true, "from": "10:30", "to": "20:30" }, "saturday": { "open": true, "from": "10:30", "to": "20:30" } } }, "trackings": [ { "tracking_number": "RA123456789US", "slug": "usps", "service_type": "standard shipping", "ship_date": "2023-05-04", "custom_fields": {}, "next_couriers": [ { "tracking_number": "RA123456789US", "slug": "usps" } ] } ], "pickup_info": { "instructions": "Shop open from Mon to Fri", "estimated_ready_for_pickup_at": { "min": "2021-04-15T20:02:09Z", "max": "2021-04-15T20:02:09Z" }, "pickup_deadline_at": "2021-04-15T20:02:09Z" } } }