Skip to content
On this page

Create Fulfillment

How to get orders by your account.

curl -X POST https://sync.wrkoutstore.com/api/v1/fulfillment \
  -H "username: YOUR_USERNAME" \
  -H "password: YOUR_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{
  "order_id": "STRING",
  "order_number": "STRING"
  "created_at": "DATE_TIME",
  "service": "SERVICE_TYPE",
  "tracking_company": "TRACKING_COMPANY",
  "email": "CUSTOMER_EMAIL",
  "destination": {
    "name": "RECIPIENT_NAME",
    "address1": "ADDRESS_LINE_1",
    "city": "CITY",
    "zip": "ZIP_CODE",
    "province": "PROVINCE",
    "country_code": "COUNTRY_CODE"
  },
  "line_items": [
    {
      "variant_id": VARIANT_ID,
      "name": "PRODUCT_NAME",
      "quantity": QUANTITY
    }
  ],
  "tracking_number": "TRACKING_NUMBER"
}'

Required headers:

  • username
  • password

Sample payload:

{
  "order_id": "123asdbc",
  "order_number": "1000-422",
  "created_at": "string (date-time format e.g., '2023-06-06T23:24:30-04:00')",
  "service": "string (e.g., 'manual')",
  "tracking_company": "string",
  "email": "string (valid email format)",
  "destination": {
    "name": "string",
    "address1": "string",
    "city": "string",
    "zip": "string (zip code format)",
    "province": "string",
    "country_code": "string (2 letter country code)"
  },
  "line_items": [
    {
      "variant_id": "number",
      "name": "string",
      "quantity": "number"
    }
  ],
  "tracking_number": "string"
}

Use this endpoint to send fulfillment information.

  • order_id: ID (from the original order)
  • order_number: Order number (from the original order)
  • created_at: The timestamp when the order was created.
  • service: The service used for the order.
  • tracking_company: The company responsible for tracking the order.
  • email: Email address of the customer.
  • destination: Address details where the order should be delivered.
  • name: Full name of the recipient.
  • address1: Street address of the recipient.
  • city: City of the recipient.
  • zip: Zip code of the recipient's address.
  • province: Province or state of the recipient.
  • country_code: Two-letter code representing the country of the recipient.
  • line_items: An array containing details of the items in the order.
  • variant_id: The variant ID of the product.
  • name: Name of the product.
  • quantity: Quantity of the product in the order.
  • tracking_number: The tracking number for the order.

Sample response:

{
	"statusCode": 200,
	"body": "Successfully created ship notification"
}