hubvibe-io.com

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "The 200 body of every paid /work call. `result` is the worker's own output (its schema is per route); everything else is the same on every /work route. A receipt for the job is at `receipt_url`.",
  "properties": {
    "attribution": {
      "$ref": "#/components/schemas/Attribution"
    },
    "billing_warning": {
      "description": "Present only when the charge was recorded with a caveat.",
      "examples": [
        "settlement pending"
      ],
      "type": "string"
    },
    "price_usd": {
      "description": "What this call cost, in USD.",
      "examples": [
        0.02
      ],
      "type": "number"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    },
    "receipt_id": {
      "description": "Receipt id for this job.",
      "examples": [
        "rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "receipt_url": {
      "description": "Where to fetch the machine-readable receipt (free, no payment).",
      "examples": [
        "/work/receipts/rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "result": {
      "properties": {
        "cart": {
          "description": "The store's own cart totals; null when the item could not be added.",
          "properties": {
            "currency": {
              "description": "Currency.",
              "examples": [
                "USD"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "item_count": {
              "description": "Units.",
              "examples": [
                1
              ],
              "type": [
                "integer",
                "null"
              ]
            },
            "requires_shipping": {
              "description": "Cart needs shipping.",
              "examples": [
                true
              ],
              "type": [
                "boolean",
                "null"
              ]
            },
            "subtotal": {
              "description": "Items subtotal.",
              "examples": [
                110
              ],
              "type": [
                "number",
                "null"
              ]
            },
            "total": {
              "description": "Cart total before shipping and tax.",
              "examples": [
                110
              ],
              "type": [
                "number",
                "null"
              ]
            }
          },
          "required": [
            "subtotal",
            "total",
            "currency",
            "item_count",
            "requires_shipping"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "cheapest_shipping": {
          "description": "Cheapest option; null when none.",
          "properties": {
            "currency": {
              "description": "Currency.",
              "examples": [
                "USD"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "name": {
              "description": "Option.",
              "examples": [
                "Ground Shipping"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "price": {
              "description": "Price.",
              "examples": [
                0
              ],
              "type": [
                "number",
                "null"
              ]
            }
          },
          "required": [
            "name",
            "price",
            "currency"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "checked_at": {
          "description": "When this node read the source (UTC). Nothing here is cached.",
          "examples": [
            "2026-09-26T18:00:00Z"
          ],
          "format": "date-time",
          "type": "string"
        },
        "eligibility_reasons": {
          "description": "Why not eligible, or what is missing; empty when eligible.",
          "examples": [
            []
          ],
          "items": {
            "description": "The store's own words.",
            "examples": [
              "country: Country/region not supported"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "eligible": {
          "description": "True: the store offers shipping there. False: it will not (see reasons). Null: the store needs more address fields first.",
          "examples": [
            true
          ],
          "type": [
            "boolean",
            "null"
          ]
        },
        "estimated_total": {
          "description": "Estimated total before tax; null when not quotable.",
          "properties": {
            "amount": {
              "description": "Subtotal plus cheapest shipping.",
              "examples": [
                110
              ],
              "type": "number"
            },
            "currency": {
              "description": "Currency.",
              "examples": [
                "USD"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "includes_tax": {
              "description": "Always false: tax is computed at checkout.",
              "examples": [
                false
              ],
              "type": "boolean"
            }
          },
          "required": [
            "amount",
            "currency",
            "includes_tax"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "missing_fields": {
          "description": "Address fields to add and retry.",
          "examples": [
            []
          ],
          "items": {
            "description": "A ship_to field the store requires.",
            "examples": [
              "province"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "notes": {
          "description": "Caveats; empty when none.",
          "examples": [
            []
          ],
          "items": {
            "description": "A caveat.",
            "examples": [
              "No variant named; the first available option was quoted."
            ],
            "type": "string"
          },
          "type": "array"
        },
        "product": {
          "description": "The product.",
          "properties": {
            "handle": {
              "description": "Product handle.",
              "examples": [
                "mens-wool-runners"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "id": {
              "description": "Store product id.",
              "examples": [
                1234567890
              ],
              "type": [
                "integer",
                "null"
              ]
            },
            "title": {
              "description": "Product title.",
              "examples": [
                "Men's Wool Runners"
              ],
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "id",
            "title",
            "handle"
          ],
          "type": "object"
        },
        "quantity": {
          "description": "Units in the cart.",
          "examples": [
            1
          ],
          "type": "integer"
        },
        "ship_to": {
          "description": "Destination.",
          "properties": {
            "country": {
              "description": "Destination country as given.",
              "examples": [
                "US"
              ],
              "type": "string"
            },
            "postal_code": {
              "description": "Postal code.",
              "examples": [
                "10001"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "province": {
              "description": "State/province.",
              "examples": [
                "NY"
              ],
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "country",
            "province",
            "postal_code"
          ],
          "type": "object"
        },
        "shipping_options": {
          "description": "Options the store would show at checkout, cheapest first.",
          "examples": [
            []
          ],
          "items": {
            "description": "One shipping option.",
            "properties": {
              "carrier": {
                "description": "Carrier when named.",
                "examples": [
                  "ups"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "currency": {
                "description": "Currency.",
                "examples": [
                  "USD"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "delivery_days_max": {
                "description": "Latest delivery, days.",
                "examples": [
                  7
                ],
                "type": [
                  "integer",
                  "null"
                ]
              },
              "delivery_days_min": {
                "description": "Earliest delivery, days.",
                "examples": [
                  3
                ],
                "type": [
                  "integer",
                  "null"
                ]
              },
              "description": {
                "description": "Store's description.",
                "examples": [
                  "Arrives in 3-7 business days"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "name": {
                "description": "Option name.",
                "examples": [
                  "Ground Shipping"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "price": {
                "description": "Price.",
                "examples": [
                  0
                ],
                "type": [
                  "number",
                  "null"
                ]
              }
            },
            "required": [
              "name",
              "price",
              "currency",
              "delivery_days_min",
              "delivery_days_max",
              "description",
              "carrier"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "source": {
          "const": "shopify-cart-api",
          "description": "Data source.",
          "type": "string"
        },
        "store": {
          "description": "The store.",
          "properties": {
            "currency": {
              "description": "Cart currency.",
              "examples": [
                "USD"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "domain": {
              "description": "Store host.",
              "examples": [
                "www.allbirds.com"
              ],
              "type": "string"
            },
            "platform": {
              "const": "shopify",
              "description": "Storefront platform.",
              "type": "string"
            }
          },
          "required": [
            "platform",
            "domain",
            "currency"
          ],
          "type": "object"
        },
        "taxes_note": {
          "description": "Where tax comes from.",
          "examples": [
            "Sales tax or VAT is computed by the store at checkout and is not included here."
          ],
          "type": "string"
        },
        "url": {
          "description": "Product page as given.",
          "examples": [
            "https://www.allbirds.com/products/mens-wool-runners"
          ],
          "type": "string"
        },
        "variant": {
          "description": "The variant quoted.",
          "properties": {
            "available": {
              "description": "Store availability flag.",
              "examples": [
                true
              ],
              "type": [
                "boolean",
                "null"
              ]
            },
            "id": {
              "description": "Variant id placed in the cart.",
              "examples": [
                31330825109584
              ],
              "type": [
                "integer",
                "null"
              ]
            },
            "name": {
              "description": "Variant name.",
              "examples": [
                "9"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "price": {
              "description": "Unit price.",
              "examples": [
                110
              ],
              "type": [
                "number",
                "null"
              ]
            },
            "requires_shipping": {
              "description": "Physical item.",
              "examples": [
                true
              ],
              "type": [
                "boolean",
                "null"
              ]
            },
            "sku": {
              "description": "SKU.",
              "examples": [
                "WR3MNCW090"
              ],
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "sku",
            "price",
            "available",
            "requires_shipping"
          ],
          "type": "object"
        }
      },
      "required": [
        "url",
        "store",
        "product",
        "variant",
        "quantity",
        "ship_to",
        "cart",
        "eligible",
        "eligibility_reasons",
        "missing_fields",
        "shipping_options",
        "cheapest_shipping",
        "estimated_total",
        "taxes_note",
        "source",
        "notes",
        "checked_at"
      ],
      "type": "object"
    },
    "status": {
      "const": "ok",
      "description": "Present only on a delivered result.",
      "type": "string"
    },
    "worker": {
      "description": "Catalog name of the worker that ran.",
      "examples": [
        "market.quote"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "worker",
    "price_usd",
    "result",
    "provenance",
    "receipt_id",
    "receipt_url"
  ],
  "title": "commerce.shipping response",
  "type": "object"
}