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.

Responses

Body

Meta

The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by AfterShip."}

code

number

required

Error code in integer format. For detailed information, please refer to the Request Error introduction page.

Default:

20000

Example:

20000

type

string

required

Response type string for the reference. For detailed information, please refer to the Request Error introduction page.

>= 1 characters

Example:

message

string

required

Human-readable response message. For detailed information, please refer to the Request Error introduction page.

>= 1 characters

Example:

The request was successfully processed by AfterShip.

errors

array[Error]

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...

data

Fulfillment

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...

string

required

The fulfillment ID generated by AfterShip.

Example:

331365ab36314decb5dd0bedf862bd5b

source_id

string

required

The original fulfillment ID in your system.

Example:

423562565

order_id

string

required

Unique identifier of the related order. Matches order.id to connect the fulfillment with its order.

Example:

0ecb8ff7efa84d7d8f763ed7b89851c8

source_order_id

string

The original order ID in your system.

Example:

5187092316403

delivery_method

string

required

Delivery method of the order. For BOPIS related feature, please specify pickup.Show all...

Allowed values:

pickupshipping

status

string

required

The status of the fulfillment. Depending of on the delivery_method, the allowed values are different.Show all...

Example:

processing

line_items

array[object]

required

The items which included in this fulifllment.

source_created_at

string<date-time>

The date and time, formatted in ISO 8601, indicating when the fulfillment was created in your e-commerce system.

Example:

2021-04-15T20:02:09Z

source_updated_at

string<date-time>

The date and time, formatted in ISO 8601, indicating when the fulfillment was updated in your e-commerce system.

Example:

2021-04-16T20:02:09Z

created_at

string<date-time>

required

The date and time (ISO 8601 format) when the fulfillment was created in AfterShip.

Example:

2021-04-15T20:02:09Z

updated_at

string<date-time>

required

The date and time (ISO 8601 format) when the fulfillment was updated in AfterShip.

Example:

2021-04-16T20:02:09Z

ship_from_location

Location

The location information where the fulfillment shipped from.

ship_to_location

Location

The location information where the fulfillment shipped to.

pickup_location

PickupLocation

The location information where the fulfillment is designated to be pickup from.

trackings

array[Tracking]

The shipment information of the fulfillment.

pickup_info

Pickup

The pickup information of the fulfillment.

Auth

Parameters

Response Example

{
  "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"
    }
  }
}