Reservations endpoints

Get reservation

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reservationIdstringRequired

Responses

200

Reservation details

application/json

Reservation

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

idstringRequired

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

quantitynumberRequired

tenantArticleIdstringRequired

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

400

Invalid input. See response for details.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

get

/api/reservations/{reservationId}

HTTPcURLJavaScriptPython

GET /api/reservations/{reservationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "facilityRef": "text",
  "host": {
    "reference": "text",
    "type": "STOCK"
  },
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "quantity": 1,
  "relatedRefs": {
    "orderRefs": [
      "text"
    ],
    "pickJobRefs": [
      "text"
    ],
    "processRefs": [
      "text"
    ],
    "routingPlanRefs": [
      "text"
    ],
    "transferRefs": [
      "text"
    ]
  },
  "tenantArticleId": "text",
  "version": 42
}

List reservations (search)

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Search for Reservation

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ReservationSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

ReservationPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/reservations/search

HTTPcURLJavaScriptPython

POST /api/reservations/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2646

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "relatedRefs": {
              "orderRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "pickJobRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "routingPlanRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "transferRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              }
            },
            "tenantArticleId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "relatedRefs": {
              "orderRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "pickJobRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "routingPlanRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "transferRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              }
            },
            "tenantArticleId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "relatedRefs": {
          "orderRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "pickJobRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "routingPlanRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "transferRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          }
        },
        "tenantArticleId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "relatedRefs": {
          "orderRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "pickJobRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "routingPlanRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "transferRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          }
        },
        "tenantArticleId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "relatedRefs": {
      "orderRefs": {
        "contains": {
          "eq": "text",
          "notEq": "text"
        }
      },
      "pickJobRefs": {
        "contains": {
          "eq": "text",
          "notEq": "text"
        }
      },
      "routingPlanRefs": {
        "contains": {
          "eq": "text",
          "notEq": "text"
        }
      },
      "transferRefs": {
        "contains": {
          "eq": "text",
          "notEq": "text"
        }
      }
    },
    "tenantArticleId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "created": "ASC",
      "lastModified": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "reservations": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "customAttributes": {},
      "facilityRef": "text",
      "host": {
        "reference": "text",
        "type": "STOCK"
      },
      "id": "text",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "quantity": 1,
      "relatedRefs": {
        "orderRefs": [
          "text"
        ],
        "pickJobRefs": [
          "text"
        ],
        "processRefs": [
          "text"
        ],
        "routingPlanRefs": [
          "text"
        ],
        "transferRefs": [
          "text"
        ]
      },
      "tenantArticleId": "text",
      "version": 42
    }
  ],
  "total": 1
}

Call reservations action

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. REMOVE_RESERVATIONS_KEEP_STOCKS: Removes reservations without modifying stock levels.

  REMOVE_RESERVATIONS_AND_REDUCE_STOCKS:  Removes reservations and reduces stock levels accordingly.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ReservationAction

namestring · enumRequired

Which action to perform

Possible values:

Responses

200

List of reservation removal results with stock operations

application/json

ReservationActionResult

statusstring · enumRequiredPossible values:

400

Invalid input. See response for details.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/reservations/actions

HTTPcURLJavaScriptPython

POST /api/reservations/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1707

{
  "name": "REMOVE_RESERVATIONS_REDUCE_STOCKS",
  "reservationSelector": {
    "orderRefs": [
      "text"
    ],
    "reservationPredicate": {
      "and": [
        {
          "and": "[Circular Reference]",
          "facilityRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "id": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "or": "[Circular Reference]",
          "relatedRefs": {
            "orderRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "pickJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "routingPlanRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "transferRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            }
          },
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      ],
      "facilityRef": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "id": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "or": [
        {
          "and": "[Circular Reference]",
          "facilityRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "id": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "or": "[Circular Reference]",
          "relatedRefs": {
            "orderRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "pickJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "routingPlanRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "transferRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            }
          },
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      ],
      "relatedRefs": {
        "orderRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "pickJobRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "routingPlanRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "transferRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        }
      },
      "tenantArticleId": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "reservationRefs": [
      "text"
    ],
    "routingPlanRefs": [
      "text"
    ],
    "tenantOrderIds": [
      "text"
    ]
  }
}

[
  {
    "reservation": {
      "id": "text"
    },
    "status": "DELETED",
    "stockOperations": [
      {
        "status": "REDUCED",
        "stock": {
          "id": "text",
          "version": 1
        }
      }
    ]
  }
]

List reservations

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizenumber · min: 1 · max: 100OptionalDefault: 25

afterstringOptional

The cursor to start after. The value is provided in the pageInfo.endCursor field of the response.

Responses

200

Reservation details

application/json

ReservationsPaginatedResult

totalnumberRequired

400

Invalid input. See response for details.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

get

/api/reservations

HTTPcURLJavaScriptPython

GET /api/reservations HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "reservations": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "customAttributes": {},
      "facilityRef": "text",
      "host": {
        "reference": "text",
        "type": "STOCK"
      },
      "id": "text",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "quantity": 1,
      "relatedRefs": {
        "orderRefs": [
          "text"
        ],
        "pickJobRefs": [
          "text"
        ],
        "processRefs": [
          "text"
        ],
        "routingPlanRefs": [
          "text"
        ],
        "transferRefs": [
          "text"
        ]
      },
      "tenantArticleId": "text",
      "version": 42
    }
  ],
  "total": 1
}