{
  "opencollection": "1.0.0",
  "info": {
    "name": "Admin Account / Address Fulfillments API",
    "version": "v3"
  },
  "items": [
    {
      "info": {
        "name": "Fulfillments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List fulfillments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{defaultHost}/api/v3/admin/orders/:order_id/fulfillments",
            "headers": [
              {
                "name": "x-spree-api-key",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path",
                "description": "Order ID"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Comma-separated associations to expand (e.g., inventory_units, stock_location, shipping_rates). Use dot notation for nested expand (max 4 levels)."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to include (e.g., number,status,tracking,cost). id is always included."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-spree-api-key",
              "value": "{{x-spree-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Returns all shipments for an order.\n\n**Required scope:** `read_fulfillments` (for API-key authentication)."
        },
        {
          "info": {
            "name": "Show a shipment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{defaultHost}/api/v3/admin/orders/:order_id/fulfillments/:id",
            "headers": [
              {
                "name": "x-spree-api-key",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path",
                "description": "Order ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Fulfillment ID"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Comma-separated associations to expand (e.g., inventory_units, stock_location, shipping_rates). Use dot notation for nested expand (max 4 levels)."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to include (e.g., number,status,tracking,cost). id is always included."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-spree-api-key",
              "value": "{{x-spree-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Returns details of a specific shipment.\n\n**Required scope:** `read_fulfillments` (for API-key authentication)."
        },
        {
          "info": {
            "name": "Update a shipment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://{defaultHost}/api/v3/admin/orders/:order_id/fulfillments/:id",
            "headers": [
              {
                "name": "x-spree-api-key",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path",
                "description": "Order ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Fulfillment ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-spree-api-key",
              "value": "{{x-spree-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Updates a shipment (tracking, shipping rate).\n\n**Required scope:** `write_fulfillments` (for API-key authentication)."
        },
        {
          "info": {
            "name": "Fulfill a fulfillment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://{defaultHost}/api/v3/admin/orders/:order_id/fulfillments/:id/fulfill",
            "headers": [
              {
                "name": "x-spree-api-key",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path",
                "description": "Order ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Fulfillment ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-spree-api-key",
              "value": "{{x-spree-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Marks a fulfillment as fulfilled.\n\n**Required scope:** `write_fulfillments` (for API-key authentication)."
        },
        {
          "info": {
            "name": "Cancel a fulfillment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://{defaultHost}/api/v3/admin/orders/:order_id/fulfillments/:id/cancel",
            "headers": [
              {
                "name": "x-spree-api-key",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path",
                "description": "Order ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Fulfillment ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-spree-api-key",
              "value": "{{x-spree-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Cancels a fulfillment.\n\n**Required scope:** `write_fulfillments` (for API-key authentication)."
        },
        {
          "info": {
            "name": "Resume a fulfillment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://{defaultHost}/api/v3/admin/orders/:order_id/fulfillments/:id/resume",
            "headers": [
              {
                "name": "x-spree-api-key",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path",
                "description": "Order ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Fulfillment ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-spree-api-key",
              "value": "{{x-spree-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Resumes a canceled fulfillment.\n\n**Required scope:** `write_fulfillments` (for API-key authentication)."
        },
        {
          "info": {
            "name": "Split a fulfillment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://{defaultHost}/api/v3/admin/orders/:order_id/fulfillments/:id/split",
            "headers": [
              {
                "name": "x-spree-api-key",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path",
                "description": "Order ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Fulfillment ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-spree-api-key",
              "value": "{{x-spree-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Transfers items from this shipment to a new shipment at a different stock location.\n\n**Required scope:** `write_fulfillments` (for API-key authentication)."
        }
      ]
    }
  ],
  "bundled": true
}