Skip to content

Instantly share code, notes, and snippets.

@seandogg
Last active March 21, 2025 03:10
Show Gist options
  • Save seandogg/58d462de97bd2a54dce1f24262913a30 to your computer and use it in GitHub Desktop.
Save seandogg/58d462de97bd2a54dce1f24262913a30 to your computer and use it in GitHub Desktop.
sample json
// order.attributes.job_status [string]
// order.attributes.job_code [string]
// order.attributes.job_history [array]
// example:
[
  {
    "updated_at": "2025-03-19T12:00:00Z",
    "code": "12345",
    "label": "Label for Customer",
    "status": "pending",
    "currrent": true,
    "required_customer_actions": [
      {
        "label": "Confirm your service",
        "status": "pending",
        "url": "https://signet-jewelery-services.myshopify.com/pages/custom-page-here",
        "action_code": "1234"
      }
    ]
  },
  {
    "updated_at": "2025-03-19T12:00:00Z",
    "code": "12345",
    "label": "Label for Customer",
    "status": "completed",
    "currrent": false,
    "required_customer_actions": []
  }
]
// sample JSON schema for job_history array
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "updated_at": {
        "type": "string",
        "format": "date-time",
        "description": "Timestamp when the record was last updated"
      },
      "code": {
        "type": "string",
        "description": "Unique identifier code"
      },
      "label": {
        "type": "string",
        "description": "Display label for the customer"
      },
      "status": {
        "type": "string",
        "enum": ["pending", "completed"],
        "description": "Current status of the record"
      },
      "currrent": {
        "type": "boolean",
        "description": "Flag indicating if this is the current record"
      },
      "required_customer_actions": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "label": {
              "type": "string",
              "description": "Display label for the action"
            },
            "status": {
              "type": "string",
              "enum": ["pending", "completed"],
              "description": "Status of the customer action"
            },
            "url": {
              "type": "string",
              "format": "uri",
              "description": "URL where the action can be performed"
            },
            "action_code": {
              "type": "string",
              "description": "Unique identifier for the action"
            }
          },
          "required": ["label", "status", "action_code"]
        }
      }
    },
    "required": ["updated_at", "code", "label", "status", "currrent", "required_customer_actions"]
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment