Sync recipes by store ID

Summary

• Source repository: jef-systems/jef-caferimo-backend

• Source SHA: 9a36b739b9d36644a4755661f84fd9219f6332cd

• Source run id: 29881756321

• Module: Caferimo

• Lambda function: jef-caferimo-sync-recipes-by-store-id

• HTTP method: GET

• Invocation mode: sync

• Package mode: no-package

• API category: Caferimo Complex Sync No Package GET APIs

• API path: /caferimo/complex-sync-no-packages/jef-caferimo-sync-recipes-by-store-id

• Endpoint URL: https://api.jefoffice.com/caferimo/complex-sync-no-packages/jef-caferimo-sync-recipes-by-store-id

• Documentation scope: lambda-complex-sync-no-packages

Synchronous Lambda Complex Rule

This API is documented as a synchronous Lambda complex no-package API. API Gateway waits for the Lambda result and returns the final Lambda response.

Description

Returns recipe summary changes and tombstones.

Payload Example

{
  "store_id": "11111111-1111-4111-8111-111111111111",
  "max_changes": 100,
  "sync_cursor": "",
  "include_capacity": false
}

Payload Schema

{
  "root": {
    "type": "M",
    "required": true,
    "additional_properties": false,
    "attributes": {
      "store_id": {
        "type": "S",
        "required": true,
        "format": "uuid",
        "regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
      },
      "max_changes": {
        "type": "N",
        "integer": true,
        "required": false,
        "minimum": 1,
        "maximum": 250,
        "default": 100
      },
      "sync_cursor": {
        "type": "S",
        "required": false,
        "max_length": 4096
      },
      "include_capacity": {
        "type": "BOOL",
        "required": false,
        "default": false
      }
    }
  }
}

Response Schema

{
  "root": {
    "type": "M",
    "required": true,
    "additional_properties": false,
    "attributes": {
      "contract_version": {
        "type": "N",
        "integer": true,
        "required": true
      },
      "request_id": {
        "type": "S",
        "required": true
      },
      "is_accepted": {
        "type": "BOOL",
        "required": true
      },
      "is_found": {
        "type": "BOOL",
        "required": true
      },
      "can_continue": {
        "type": "BOOL",
        "required": true
      },
      "is_complete": {
        "type": "BOOL",
        "required": true
      },
      "is_truncated": {
        "type": "BOOL",
        "required": true
      },
      "message_type": {
        "type": "S",
        "required": true,
        "enum": [
          "success",
          "info",
          "warning",
          "error"
        ]
      },
      "message": {
        "type": "S",
        "required": true
      },
      "next_action": {
        "type": "S",
        "required": true
      },
      "operation": {
        "type": "S",
        "required": true
      },
      "status_code": {
        "type": "N",
        "integer": true,
        "required": true
      },
      "store_id": {
        "type": "S",
        "required": true
      },
      "change_count": {
        "type": "N",
        "integer": true,
        "required": true
      },
      "changes": {
        "type": "L",
        "required": true,
        "items": {
          "type": "M",
          "required": true,
          "additional_properties": false,
          "attributes": {
            "recipe_id": {
              "type": "S",
              "required": true,
              "format": "uuid"
            },
            "store_id": {
              "type": "S",
              "required": true,
              "format": "uuid"
            },
            "recipe_number": {
              "type": "S",
              "required": true
            },
            "recipe_name": {
              "type": "S",
              "required": true
            },
            "family": {
              "type": "S",
              "required": true
            },
            "size_mode": {
              "type": "S",
              "required": true,
              "enum": [
                "fixed",
                "size_based"
              ]
            },
            "uses_milk": {
              "type": "BOOL",
              "required": true
            },
            "vessel": {
              "type": "S",
              "required": true
            },
            "is_active": {
              "type": "BOOL",
              "required": true
            },
            "is_deleted": {
              "type": "BOOL",
              "required": true
            },
            "version": {
              "type": "N",
              "integer": true,
              "required": true
            },
            "updated": {
              "type": "S",
              "required": true,
              "format": "date-time"
            },
            "content_hash": {
              "type": "S",
              "required": true
            },
            "formula_line_count": {
              "type": "N",
              "integer": true,
              "required": true,
              "minimum": 0
            },
            "layer_count": {
              "type": "N",
              "integer": true,
              "required": true,
              "minimum": 0
            },
            "process_step_count": {
              "type": "N",
              "integer": true,
              "required": true,
              "minimum": 0
            },
            "deleted": {
              "type": "S",
              "required": false,
              "format": "date-time"
            }
          }
        }
      },
      "sync_cursor": {
        "type": "S",
        "required": true,
        "nullable": true
      },
      "failure_code": {
        "type": "S",
        "required": false
      },
      "consumed_capacity": {
        "type": "M",
        "required": false,
        "additional_properties": true,
        "attributes": {}
      }
    }
  }
}

CMD curl

curl.exe -X GET "https://api.jefoffice.com/caferimo/complex-sync-no-packages/jef-caferimo-sync-recipes-by-store-id"

PowerShell curl

curl.exe -X GET "https://api.jefoffice.com/caferimo/complex-sync-no-packages/jef-caferimo-sync-recipes-by-store-id"