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.

Body

title

string

The title of the product.

<= 1024 characters

Example:

Power Mobile Phone

slug

string

URL friendly unique identifier for the product.

<= 1024 characters

Example:

power-mobile-phone

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

Product

The Product model represents an individual item of your store. It includes essential attributes such as product title, price, variants, SKU, and so on. This model is crucial for cataloging and managing the store's inventory effectively.

Example:

{"id":"fbc7245f23494576829c4b00609cf1ab","source_id":"546735673","store":{"id":"0ecb8ff7efa84d7d8f763ed7b21851d1"},"title":"Power Mobile Phone","slug":"power-mobile-phone","categories":["mobile-phone"],"tags":["mobile-phone"],"image_urls":["https://example.com/product/image.png"],"url":"https://example.com/product/image.png","published":true,"description":"string","variants":[{"source_id":"5634477687","available_quantity":1,"sku":"SKU001","title":"Power Mobile Phone","price":"10","image_urls":["https://example.com/product/image.png"],"compare_at_price":"string","weight":{"unit":"kg","value":10},"allow_backorder":true,"options":[{"name":"color","value":"white"}]}],"source_created_at":"2021-04-15T20:02:09Z","source_updated_at":"2021-04-15T20:02:09Z","created_at":"2021-04-15T20:02:09Z","updated_at":"2021-04-15T20:02:09Z"}

string

Unique identifier generated by AfterShip.

Example:

fbc7245f23494576829c4b00609cf1ab

source_id

string

required

A unique identifier for the product in your system.

Example:

546735673

store

object

Indicate which store the product belongs to.

title

string

required

The title of the product.

Example:

Power Mobile Phone

slug

string

URL friendly unique identifier for the product.

Example:

power-mobile-phone

tags

array[string]

The tags associated with the product, used for filtering and search purposes.

image_urls

array[string]

required

URLs of the product images.

url

string

The URL of the product page in your online storefront.

Example:

https://example.com/product/image.png

published

boolean

To indicate whether the product has been published.

Default:

true

description

string

Description of the product.

variants

array[object]

required

Product variant information.

>= 1 items

source_created_at

string

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

Example:

2021-04-15T20:02:09Z

source_updated_at

string

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

Example:

2021-04-15T20:02:09Z

created_at

string

The date and time, formatted in ISO 8601, indicating when the product was created in AfterShip system.

Example:

2021-04-15T20:02:09Z

updated_at

string

The date and time, formatted in ISO 8601, indicating when the product was updated in AfterShip system.

Example:

2021-04-15T20:02:09Z

Auth

Parameters

Body

{
  "title": "Power Mobile Phone",
  "slug": "power-mobile-phone",
  "categories": [
    "mobile-phone"
  ],
  "tags": [
    "mobile-phone"
  ],
  "image_urls": [
    "https://example.com/product/image.png"
  ],
  "url": "https://example.com/product/",
  "published": true,
  "description": "string",
  "source_updated_at": "2021-04-15T20:02:09Z"
}

Response Example

{
  "meta": {
    "code": 20000,
    "type": "OK",
    "message": "The request was successfully processed by AfterShip."
  },
  "data": {
    "id": "fbc7245f23494576829c4b00609cf1ab",
    "source_id": "546735673",
    "store": {
      "id": "0ecb8ff7efa84d7d8f763ed7b21851d1"
    },
    "title": "Power Mobile Phone",
    "slug": "power-mobile-phone",
    "categories": [
      "mobile-phone"
    ],
    "tags": [
      "mobile-phone"
    ],
    "image_urls": [
      "https://example.com/product/image.png"
    ],
    "url": "https://example.com/product/image.png",
    "published": true,
    "description": "string",
    "variants": [
      {
        "source_id": "5634477687",
        "available_quantity": 1,
        "sku": "SKU001",
        "title": "Power Mobile Phone",
        "price": "10",
        "image_urls": [
          "https://example.com/product/image.png"
        ],
        "compare_at_price": "string",
        "weight": {
          "unit": "kg",
          "value": 10
        },
        "allow_backorder": true,
        "options": [
          {
            "name": "color",
            "value": "white"
          }
        ]
      }
    ],
    "source_created_at": "2021-04-15T20:02:09Z",
    "source_updated_at": "2021-04-15T20:02:09Z",
    "created_at": "2021-04-15T20:02:09Z",
    "updated_at": "2021-04-15T20:02:09Z"
  }
}

Update product by ID

Request

Path Parameters

Headers

Body

Responses

200

Body