Get Fulfillment by Id

Select

SaaS

Get fulfillment details using metallic fulfillment id.

Path Variables

Field	Description	Type	Notes
fulfillmentId	Fulfillment metallic id	UUID

Response Body

Field	Description	Type	Notes
id	Fulfillment metallic id	UUID
status	Fulfillment status	String Enumeration - Fulfillment Status Enumeration	Refer to Fulfillment Status Enumeration.
accountId	Account metallic id	UUID	For 'New customer' fulfillment request, this field only present when fulfillment status is 'complete'.
insertTs	Fulfillment created time	Timestamp
updateTs	Fulfillment last updated time	Timestamp
requestData	Fulfillment request body	Submit Fulfillment - Request Body	See - Submit Fulfillment - Request Body

Path Parameters

• fulfillmentId string required

  Fulfillment metallic id

Responses

• 200
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Get fulfilment by Id - Success

---

Schema

• data object

  id string

  status string

  accountId string

  insertTs string

  updateTs string

  requestData object

  externalId string

  resellerId string

  account object

  externalId string

  name string

  website string

  provisionCountry string

  contacts object[]

  type string

  email string

  firstName string

  lastName string

  phone string

  address object

  addressLine1 string

  addressLine2 string

  city string

  state string

  country string

  postalCode string

  service object

  skus object[]

  sku string

{
  "data": {
    "id": "85ca70d8-fa75-40f1-b0c8-cb26a2dcda10",
    "status": "complete",
    "accountId": "29118811-96a9-492c-b096-7d8f5ff698b3",
    "insertTs": "2021-05-05T21:16:48",
    "updateTs": "2021-05-05T21:17:48",
    "requestData": {
      "externalId": "f43t3423g3",
      "resellerId": "fbdcafcc-d507-4e04-a7db-31bbb58a6699",
      "account": {
        "externalId": "ck6knzailz0",
        "name": "Example Customer",
        "website": "www.examplecustomer.com",
        "provisionCountry": "United States",
        "contacts": [
          {
            "type": "admin",
            "email": "tom@examplecustomer.com",
            "firstName": "Tom",
            "lastName": "Li",
            "phone": "+1 202 202 3030",
            "address": {
              "addressLine1": "1 Ave",
              "addressLine2": "Suite 204",
              "city": "Sunnyvale",
              "state": "California",
              "country": "United States",
              "postalCode": "94086"
            }
          }
        ]
      },
      "service": {
        "skus": [
          {
            "sku": "MTL-SF-USRO-NC"
          },
          {
            "sku": "MTL-FOB-FTO-NC"
          }
        ]
      }
    }
  }
}

{
  "data": {
    "id": "85ca70d8-fa75-40f1-b0c8-cb26a2dcda10",
    "status": "complete",
    "accountId": "29118811-96a9-492c-b096-7d8f5ff698b3",
    "insertTs": "2021-05-05T21:16:48",
    "updateTs": "2021-05-05T21:17:48",
    "requestData": {
      "externalId": "f43t3423g3",
      "resellerId": "fbdcafcc-d507-4e04-a7db-31bbb58a6699",
      "account": {
        "externalId": "ck6knzailz0",
        "name": "Example Customer",
        "website": "www.examplecustomer.com",
        "provisionCountry": "United States",
        "contacts": [
          {
            "type": "admin",
            "email": "tom@examplecustomer.com",
            "firstName": "Tom",
            "lastName": "Li",
            "phone": "+1 202 202 3030",
            "address": {
              "addressLine1": "1 Ave",
              "addressLine2": "Suite 204",
              "city": "Sunnyvale",
              "state": "California",
              "country": "United States",
              "postalCode": "94086"
            }
          }
        ]
      },
      "service": {
        "skus": [
          {
            "sku": "MTL-SF-USRO-NC"
          },
          {
            "sku": "MTL-FOB-FTO-NC"
          }
        ]
      }
    }
  }
}

Not Found

application/json

• Schema
• Record not found

---

Schema

{
  "error": {
    "code": 1006,
    "message": "Record not found"
  }
}

Loading...