api

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 12, 2026 License: MIT Imports: 16 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Package api contains the generated fulfillmenttools HTTP client and models, and the operation metadata that reaches the operations the client does not have.

Everything in this package with a .gen.go suffix is generated — do not edit it by hand. Two generators write here, and they cover different things:

  • fft.gen.go is oapi-codegen's typed client. It is filtered to eight tags (see api/openapi/oapi-codegen.yaml), which is 95 methods of the API's 568 operations.
  • opmeta.gen.go is tools/specgen's metadata table, and it covers all 568 — method, path, parameters (with the per-parameter explode that decides what a filter means), permissions, and a synthesized sample request body. It is what `fft api` and the generated commands build their requests from.

The hand-written wrapper the commands actually use lives in internal/client; the hand-written half of the metadata (the types, the lookups) is in opmeta.go.

Index

Constants

This section is empty.

Variables

View Source
var Tags = sync.OnceValue(func() []string {
	seen := make(map[string]bool)
	var out []string
	for _, op := range operations {
		for _, tag := range op.Tags {
			if !seen[tag] {
				seen[tag] = true
				out = append(out, tag)
			}
		}
	}
	sort.Strings(out)
	return out
})

Tags returns every tag in the spec, sorted.

Functions

func NewActionsRoutingStrategyRequest added in v0.6.0

func NewActionsRoutingStrategyRequest(server string, strategyId string, body ActionsRoutingStrategyJSONRequestBody) (*http.Request, error)

NewActionsRoutingStrategyRequest calls the generic ActionsRoutingStrategy builder with application/json body

func NewActionsRoutingStrategyRequestWithBody added in v0.6.0

func NewActionsRoutingStrategyRequestWithBody(server string, strategyId string, contentType string, body io.Reader) (*http.Request, error)

NewActionsRoutingStrategyRequestWithBody constructs an http.Request for the ActionsRoutingStrategy method, with any body, and a specified content type

func NewAddDiscountToFacilityRequest

func NewAddDiscountToFacilityRequest(server string, facilityRef string, body AddDiscountToFacilityJSONRequestBody) (*http.Request, error)

NewAddDiscountToFacilityRequest calls the generic AddDiscountToFacility builder with application/json body

func NewAddDiscountToFacilityRequestWithBody

func NewAddDiscountToFacilityRequestWithBody(server string, facilityRef string, contentType string, body io.Reader) (*http.Request, error)

NewAddDiscountToFacilityRequestWithBody constructs an http.Request for the AddDiscountToFacility method, with any body, and a specified content type

func NewAddFacilityRequest

func NewAddFacilityRequest(server string, body AddFacilityJSONRequestBody) (*http.Request, error)

NewAddFacilityRequest calls the generic AddFacility builder with application/json body

func NewAddFacilityRequestWithBody

func NewAddFacilityRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewAddFacilityRequestWithBody constructs an http.Request for the AddFacility method, with any body, and a specified content type

func NewAddOrderRequest added in v0.3.0

func NewAddOrderRequest(server string, body AddOrderJSONRequestBody) (*http.Request, error)

NewAddOrderRequest calls the generic AddOrder builder with application/json body

func NewAddOrderRequestWithBody added in v0.3.0

func NewAddOrderRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewAddOrderRequestWithBody constructs an http.Request for the AddOrder method, with any body, and a specified content type

func NewAssignFacilityRequest

func NewAssignFacilityRequest(server string, userId string, body AssignFacilityJSONRequestBody) (*http.Request, error)

NewAssignFacilityRequest calls the generic AssignFacility builder with application/json body

func NewAssignFacilityRequestWithBody

func NewAssignFacilityRequestWithBody(server string, userId string, contentType string, body io.Reader) (*http.Request, error)

NewAssignFacilityRequestWithBody constructs an http.Request for the AssignFacility method, with any body, and a specified content type

func NewBulkOrdersActionRequest added in v0.7.0

func NewBulkOrdersActionRequest(server string, body BulkOrdersActionJSONRequestBody) (*http.Request, error)

NewBulkOrdersActionRequest calls the generic BulkOrdersAction builder with application/json body

func NewBulkOrdersActionRequestWithBody added in v0.7.0

func NewBulkOrdersActionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewBulkOrdersActionRequestWithBody constructs an http.Request for the BulkOrdersAction method, with any body, and a specified content type

func NewBulkUpdateSafetyStockRequest

func NewBulkUpdateSafetyStockRequest(server string, body BulkUpdateSafetyStockJSONRequestBody) (*http.Request, error)

NewBulkUpdateSafetyStockRequest calls the generic BulkUpdateSafetyStock builder with application/json body

func NewBulkUpdateSafetyStockRequestWithBody

func NewBulkUpdateSafetyStockRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewBulkUpdateSafetyStockRequestWithBody constructs an http.Request for the BulkUpdateSafetyStock method, with any body, and a specified content type

func NewBulkUpsertListingsRequest

func NewBulkUpsertListingsRequest(server string, body BulkUpsertListingsJSONRequestBody) (*http.Request, error)

NewBulkUpsertListingsRequest calls the generic BulkUpsertListings builder with application/json body

func NewBulkUpsertListingsRequestWithBody

func NewBulkUpsertListingsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewBulkUpsertListingsRequestWithBody constructs an http.Request for the BulkUpsertListings method, with any body, and a specified content type

func NewCalculateBestCarrierRequest

func NewCalculateBestCarrierRequest(server string, facilityId string, body CalculateBestCarrierJSONRequestBody) (*http.Request, error)

NewCalculateBestCarrierRequest calls the generic CalculateBestCarrier builder with application/json body

func NewCalculateBestCarrierRequestWithBody

func NewCalculateBestCarrierRequestWithBody(server string, facilityId string, contentType string, body io.Reader) (*http.Request, error)

NewCalculateBestCarrierRequestWithBody constructs an http.Request for the CalculateBestCarrier method, with any body, and a specified content type

func NewChangeUserRequest

func NewChangeUserRequest(server string, userId string, body ChangeUserJSONRequestBody) (*http.Request, error)

NewChangeUserRequest calls the generic ChangeUser builder with application/json body

func NewChangeUserRequestWithBody

func NewChangeUserRequestWithBody(server string, userId string, contentType string, body io.Reader) (*http.Request, error)

NewChangeUserRequestWithBody constructs an http.Request for the ChangeUser method, with any body, and a specified content type

func NewConnectCarrierToFacilityRequest

func NewConnectCarrierToFacilityRequest(server string, facilityId string, carrierRef string, body ConnectCarrierToFacilityJSONRequestBody) (*http.Request, error)

NewConnectCarrierToFacilityRequest calls the generic ConnectCarrierToFacility builder with application/json body

func NewConnectCarrierToFacilityRequestWithBody

func NewConnectCarrierToFacilityRequestWithBody(server string, facilityId string, carrierRef string, contentType string, body io.Reader) (*http.Request, error)

NewConnectCarrierToFacilityRequestWithBody constructs an http.Request for the ConnectCarrierToFacility method, with any body, and a specified content type

func NewCreateCarrierToFacilityRequest

func NewCreateCarrierToFacilityRequest(server string, facilityId string, carrierRef string, body CreateCarrierToFacilityJSONRequestBody) (*http.Request, error)

NewCreateCarrierToFacilityRequest calls the generic CreateCarrierToFacility builder with application/json body

func NewCreateCarrierToFacilityRequestWithBody

func NewCreateCarrierToFacilityRequestWithBody(server string, facilityId string, carrierRef string, contentType string, body io.Reader) (*http.Request, error)

NewCreateCarrierToFacilityRequestWithBody constructs an http.Request for the CreateCarrierToFacility method, with any body, and a specified content type

func NewCreateConnectionToFacilityRequest

func NewCreateConnectionToFacilityRequest(server string, facilityId string, body CreateConnectionToFacilityJSONRequestBody) (*http.Request, error)

NewCreateConnectionToFacilityRequest calls the generic CreateConnectionToFacility builder with application/json body

func NewCreateConnectionToFacilityRequestWithBody

func NewCreateConnectionToFacilityRequestWithBody(server string, facilityId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateConnectionToFacilityRequestWithBody constructs an http.Request for the CreateConnectionToFacility method, with any body, and a specified content type

func NewCreateRoleRequest

func NewCreateRoleRequest(server string, body CreateRoleJSONRequestBody) (*http.Request, error)

NewCreateRoleRequest calls the generic CreateRole builder with application/json body

func NewCreateRoleRequestWithBody

func NewCreateRoleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateRoleRequestWithBody constructs an http.Request for the CreateRole method, with any body, and a specified content type

func NewCreateSourcingOptionsRequestRequest added in v0.2.0

func NewCreateSourcingOptionsRequestRequest(server string, body CreateSourcingOptionsRequestJSONRequestBody) (*http.Request, error)

NewCreateSourcingOptionsRequestRequest calls the generic CreateSourcingOptionsRequest builder with application/json body

func NewCreateSourcingOptionsRequestRequestWithBody added in v0.2.0

func NewCreateSourcingOptionsRequestRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateSourcingOptionsRequestRequestWithBody constructs an http.Request for the CreateSourcingOptionsRequest method, with any body, and a specified content type

func NewCreateStockRequest

func NewCreateStockRequest(server string, body CreateStockJSONRequestBody) (*http.Request, error)

NewCreateStockRequest calls the generic CreateStock builder with application/json body

func NewCreateStockRequestWithBody

func NewCreateStockRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateStockRequestWithBody constructs an http.Request for the CreateStock method, with any body, and a specified content type

func NewCreateUserRequest

func NewCreateUserRequest(server string, body CreateUserJSONRequestBody) (*http.Request, error)

NewCreateUserRequest calls the generic CreateUser builder with application/json body

func NewCreateUserRequestWithBody

func NewCreateUserRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateUserRequestWithBody constructs an http.Request for the CreateUser method, with any body, and a specified content type

func NewDeleteDiscountForFacilityRequest

func NewDeleteDiscountForFacilityRequest(server string, facilityRef string, facilityDiscountRef string) (*http.Request, error)

NewDeleteDiscountForFacilityRequest constructs an http.Request for the DeleteDiscountForFacility method

func NewDeleteFacilityConnectionRequest

func NewDeleteFacilityConnectionRequest(server string, facilityId string, connectionId string) (*http.Request, error)

NewDeleteFacilityConnectionRequest constructs an http.Request for the DeleteFacilityConnection method

func NewDeleteFacilityListingPartialStockRequest

func NewDeleteFacilityListingPartialStockRequest(server string, facilityId string, tenantArticleId string) (*http.Request, error)

NewDeleteFacilityListingPartialStockRequest constructs an http.Request for the DeleteFacilityListingPartialStock method

func NewDeleteFacilityListingRequest

func NewDeleteFacilityListingRequest(server string, facilityId string, tenantArticleId string) (*http.Request, error)

NewDeleteFacilityListingRequest constructs an http.Request for the DeleteFacilityListing method

func NewDeleteFacilityRequest

func NewDeleteFacilityRequest(server string, facilityId string, params *DeleteFacilityParams) (*http.Request, error)

NewDeleteFacilityRequest constructs an http.Request for the DeleteFacility method

func NewDeleteListingsOfFacilityRequest

func NewDeleteListingsOfFacilityRequest(server string, facilityId string) (*http.Request, error)

NewDeleteListingsOfFacilityRequest constructs an http.Request for the DeleteListingsOfFacility method

func NewDeleteRoleRequest

func NewDeleteRoleRequest(server string, name string) (*http.Request, error)

NewDeleteRoleRequest constructs an http.Request for the DeleteRole method

func NewDeleteRoutingStrategyNodeConfigCategoryRequest added in v0.6.0

func NewDeleteRoutingStrategyNodeConfigCategoryRequest(server string, categoryId string) (*http.Request, error)

NewDeleteRoutingStrategyNodeConfigCategoryRequest constructs an http.Request for the DeleteRoutingStrategyNodeConfigCategory method

func NewDeleteSafetyStockRequest

func NewDeleteSafetyStockRequest(server string, safetyStockId string) (*http.Request, error)

NewDeleteSafetyStockRequest constructs an http.Request for the DeleteSafetyStock method

func NewDeleteStockRequest

func NewDeleteStockRequest(server string, stockId string) (*http.Request, error)

NewDeleteStockRequest constructs an http.Request for the DeleteStock method

func NewDeleteUserRequest

func NewDeleteUserRequest(server string, userId string) (*http.Request, error)

NewDeleteUserRequest constructs an http.Request for the DeleteUser method

func NewEvaluateRoutingStrategyNodeRequest added in v0.6.0

func NewEvaluateRoutingStrategyNodeRequest(server string, strategyId string, nodeId string) (*http.Request, error)

NewEvaluateRoutingStrategyNodeRequest constructs an http.Request for the EvaluateRoutingStrategyNode method

func NewEvaluateRoutingStrategyRequest added in v0.6.0

func NewEvaluateRoutingStrategyRequest(server string, strategyId string, body EvaluateRoutingStrategyJSONRequestBody) (*http.Request, error)

NewEvaluateRoutingStrategyRequest calls the generic EvaluateRoutingStrategy builder with application/json body

func NewEvaluateRoutingStrategyRequestWithBody added in v0.6.0

func NewEvaluateRoutingStrategyRequestWithBody(server string, strategyId string, contentType string, body io.Reader) (*http.Request, error)

NewEvaluateRoutingStrategyRequestWithBody constructs an http.Request for the EvaluateRoutingStrategy method, with any body, and a specified content type

func NewExecuteMeActionRequest

func NewExecuteMeActionRequest(server string, body ExecuteMeActionJSONRequestBody) (*http.Request, error)

NewExecuteMeActionRequest calls the generic ExecuteMeAction builder with application/json body

func NewExecuteMeActionRequestWithBody

func NewExecuteMeActionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewExecuteMeActionRequestWithBody constructs an http.Request for the ExecuteMeAction method, with any body, and a specified content type

func NewFacilityActionRequest

func NewFacilityActionRequest(server string, facilityId string, body FacilityActionJSONRequestBody) (*http.Request, error)

NewFacilityActionRequest calls the generic FacilityAction builder with application/json body

func NewFacilityActionRequestWithBody

func NewFacilityActionRequestWithBody(server string, facilityId string, contentType string, body io.Reader) (*http.Request, error)

NewFacilityActionRequestWithBody constructs an http.Request for the FacilityAction method, with any body, and a specified content type

func NewGetAllFacilitiesRequest

func NewGetAllFacilitiesRequest(server string, params *GetAllFacilitiesParams) (*http.Request, error)

NewGetAllFacilitiesRequest constructs an http.Request for the GetAllFacilities method

func NewGetAllOrdersRequest added in v0.3.0

func NewGetAllOrdersRequest(server string, params *GetAllOrdersParams) (*http.Request, error)

NewGetAllOrdersRequest constructs an http.Request for the GetAllOrders method

func NewGetAllRolesRequest

func NewGetAllRolesRequest(server string) (*http.Request, error)

NewGetAllRolesRequest constructs an http.Request for the GetAllRoles method

func NewGetAllUsersRequest

func NewGetAllUsersRequest(server string, params *GetAllUsersParams) (*http.Request, error)

NewGetAllUsersRequest constructs an http.Request for the GetAllUsers method

func NewGetArticlesRequest

func NewGetArticlesRequest(server string, params *GetArticlesParams) (*http.Request, error)

NewGetArticlesRequest constructs an http.Request for the GetArticles method

func NewGetDiscountForFacilityRequest

func NewGetDiscountForFacilityRequest(server string, facilityRef string, facilityDiscountRef string) (*http.Request, error)

NewGetDiscountForFacilityRequest constructs an http.Request for the GetDiscountForFacility method

func NewGetDiscountsForFacilityRequest

func NewGetDiscountsForFacilityRequest(server string, facilityRef string, params *GetDiscountsForFacilityParams) (*http.Request, error)

NewGetDiscountsForFacilityRequest constructs an http.Request for the GetDiscountsForFacility method

func NewGetEffectivePermissionsRequest

func NewGetEffectivePermissionsRequest(server string) (*http.Request, error)

NewGetEffectivePermissionsRequest constructs an http.Request for the GetEffectivePermissions method

func NewGetFacilityCarrierRequest

func NewGetFacilityCarrierRequest(server string, facilityId string, carrierRef string) (*http.Request, error)

NewGetFacilityCarrierRequest constructs an http.Request for the GetFacilityCarrier method

func NewGetFacilityConnectionRequest

func NewGetFacilityConnectionRequest(server string, facilityId string, connectionId string, params *GetFacilityConnectionParams) (*http.Request, error)

NewGetFacilityConnectionRequest constructs an http.Request for the GetFacilityConnection method

func NewGetFacilityConnectionsRequest

func NewGetFacilityConnectionsRequest(server string, facilityId string, params *GetFacilityConnectionsParams) (*http.Request, error)

NewGetFacilityConnectionsRequest constructs an http.Request for the GetFacilityConnections method

func NewGetFacilityListingPartialStockRequest

func NewGetFacilityListingPartialStockRequest(server string, facilityId string, tenantArticleId string) (*http.Request, error)

NewGetFacilityListingPartialStockRequest constructs an http.Request for the GetFacilityListingPartialStock method

func NewGetFacilityListingRequest

func NewGetFacilityListingRequest(server string, facilityId string, params *GetFacilityListingParams) (*http.Request, error)

NewGetFacilityListingRequest constructs an http.Request for the GetFacilityListing method

func NewGetFacilityRequest

func NewGetFacilityRequest(server string, facilityId string) (*http.Request, error)

NewGetFacilityRequest constructs an http.Request for the GetFacility method

func NewGetForecastsForArticleRequest

func NewGetForecastsForArticleRequest(server string, tenantArticleId string, params *GetForecastsForArticleParams) (*http.Request, error)

NewGetForecastsForArticleRequest constructs an http.Request for the GetForecastsForArticle method

func NewGetListingRequest

func NewGetListingRequest(server string, facilityId string, tenantArticleId string, params *GetListingParams) (*http.Request, error)

NewGetListingRequest constructs an http.Request for the GetListing method

func NewGetOrderRequest added in v0.3.0

func NewGetOrderRequest(server string, orderId string) (*http.Request, error)

NewGetOrderRequest constructs an http.Request for the GetOrder method

func NewGetPermissionsRequest

func NewGetPermissionsRequest(server string, params *GetPermissionsParams) (*http.Request, error)

NewGetPermissionsRequest constructs an http.Request for the GetPermissions method

func NewGetRoleRequest

func NewGetRoleRequest(server string, name string) (*http.Request, error)

NewGetRoleRequest constructs an http.Request for the GetRole method

func NewGetRoutingDecisionLogsRequest added in v0.6.0

func NewGetRoutingDecisionLogsRequest(server string, params *GetRoutingDecisionLogsParams) (*http.Request, error)

NewGetRoutingDecisionLogsRequest constructs an http.Request for the GetRoutingDecisionLogs method

func NewGetRoutingStrategiesRequest added in v0.6.0

func NewGetRoutingStrategiesRequest(server string, params *GetRoutingStrategiesParams) (*http.Request, error)

NewGetRoutingStrategiesRequest constructs an http.Request for the GetRoutingStrategies method

func NewGetRoutingStrategyNodeConfigCategoriesRequest added in v0.6.0

func NewGetRoutingStrategyNodeConfigCategoriesRequest(server string, params *GetRoutingStrategyNodeConfigCategoriesParams) (*http.Request, error)

NewGetRoutingStrategyNodeConfigCategoriesRequest constructs an http.Request for the GetRoutingStrategyNodeConfigCategories method

func NewGetRoutingStrategyNodeConfigCategoryRequest added in v0.6.0

func NewGetRoutingStrategyNodeConfigCategoryRequest(server string, categoryId string) (*http.Request, error)

NewGetRoutingStrategyNodeConfigCategoryRequest constructs an http.Request for the GetRoutingStrategyNodeConfigCategory method

func NewGetRoutingStrategyRequest added in v0.6.0

func NewGetRoutingStrategyRequest(server string, strategyId string) (*http.Request, error)

NewGetRoutingStrategyRequest constructs an http.Request for the GetRoutingStrategy method

func NewGetSafetyStocksRequest

func NewGetSafetyStocksRequest(server string, params *GetSafetyStocksParams) (*http.Request, error)

NewGetSafetyStocksRequest constructs an http.Request for the GetSafetyStocks method

func NewGetSourcingOptionRequest added in v0.2.0

func NewGetSourcingOptionRequest(server string, sourcingOptionsRequestId string) (*http.Request, error)

NewGetSourcingOptionRequest constructs an http.Request for the GetSourcingOption method

func NewGetStockDistributionRequest

func NewGetStockDistributionRequest(server string, tenantArticleId string, params *GetStockDistributionParams) (*http.Request, error)

NewGetStockDistributionRequest constructs an http.Request for the GetStockDistribution method

func NewGetStockRequest

func NewGetStockRequest(server string, stockId string) (*http.Request, error)

NewGetStockRequest constructs an http.Request for the GetStock method

func NewGetStockSummariesRequest

func NewGetStockSummariesRequest(server string, params *GetStockSummariesParams) (*http.Request, error)

NewGetStockSummariesRequest constructs an http.Request for the GetStockSummaries method

func NewGetStocksRequest

func NewGetStocksRequest(server string, params *GetStocksParams) (*http.Request, error)

NewGetStocksRequest constructs an http.Request for the GetStocks method

func NewGetUserRequest

func NewGetUserRequest(server string, userId string) (*http.Request, error)

NewGetUserRequest constructs an http.Request for the GetUser method

func NewGetUserRolesRequest

func NewGetUserRolesRequest(server string, userId string) (*http.Request, error)

NewGetUserRolesRequest constructs an http.Request for the GetUserRoles method

func NewHealthCheckRequest

func NewHealthCheckRequest(server string) (*http.Request, error)

NewHealthCheckRequest constructs an http.Request for the HealthCheck method

func NewListFacilityCarriersRequest

func NewListFacilityCarriersRequest(server string, facilityId string) (*http.Request, error)

NewListFacilityCarriersRequest constructs an http.Request for the ListFacilityCarriers method

func NewOrderActionRequest added in v0.3.0

func NewOrderActionRequest(server string, orderId string, body OrderActionJSONRequestBody) (*http.Request, error)

NewOrderActionRequest calls the generic OrderAction builder with application/json body

func NewOrderActionRequestWithBody added in v0.3.0

func NewOrderActionRequestWithBody(server string, orderId string, contentType string, body io.Reader) (*http.Request, error)

NewOrderActionRequestWithBody constructs an http.Request for the OrderAction method, with any body, and a specified content type

func NewOrderLineItemActionRequest added in v0.3.0

func NewOrderLineItemActionRequest(server string, orderId string, orderLineItemId string, body OrderLineItemActionJSONRequestBody) (*http.Request, error)

NewOrderLineItemActionRequest calls the generic OrderLineItemAction builder with application/json body

func NewOrderLineItemActionRequestWithBody added in v0.3.0

func NewOrderLineItemActionRequestWithBody(server string, orderId string, orderLineItemId string, contentType string, body io.Reader) (*http.Request, error)

NewOrderLineItemActionRequestWithBody constructs an http.Request for the OrderLineItemAction method, with any body, and a specified content type

func NewPatchFacilityListingPartialStockRequest

func NewPatchFacilityListingPartialStockRequest(server string, facilityId string, tenantArticleId string, body PatchFacilityListingPartialStockJSONRequestBody) (*http.Request, error)

NewPatchFacilityListingPartialStockRequest calls the generic PatchFacilityListingPartialStock builder with application/json body

func NewPatchFacilityListingPartialStockRequestWithBody

func NewPatchFacilityListingPartialStockRequestWithBody(server string, facilityId string, tenantArticleId string, contentType string, body io.Reader) (*http.Request, error)

NewPatchFacilityListingPartialStockRequestWithBody constructs an http.Request for the PatchFacilityListingPartialStock method, with any body, and a specified content type

func NewPatchFacilityListingRequest

func NewPatchFacilityListingRequest(server string, facilityId string, tenantArticleId string, body PatchFacilityListingJSONRequestBody) (*http.Request, error)

NewPatchFacilityListingRequest calls the generic PatchFacilityListing builder with application/json body

func NewPatchFacilityListingRequestWithBody

func NewPatchFacilityListingRequestWithBody(server string, facilityId string, tenantArticleId string, contentType string, body io.Reader) (*http.Request, error)

NewPatchFacilityListingRequestWithBody constructs an http.Request for the PatchFacilityListing method, with any body, and a specified content type

func NewPatchFacilityRequest

func NewPatchFacilityRequest(server string, facilityId string, body PatchFacilityJSONRequestBody) (*http.Request, error)

NewPatchFacilityRequest calls the generic PatchFacility builder with application/json body

func NewPatchFacilityRequestWithBody

func NewPatchFacilityRequestWithBody(server string, facilityId string, contentType string, body io.Reader) (*http.Request, error)

NewPatchFacilityRequestWithBody constructs an http.Request for the PatchFacility method, with any body, and a specified content type

func NewPatchRoleRequest

func NewPatchRoleRequest(server string, name string, body PatchRoleJSONRequestBody) (*http.Request, error)

NewPatchRoleRequest calls the generic PatchRole builder with application/json body

func NewPatchRoleRequestWithBody

func NewPatchRoleRequestWithBody(server string, name string, contentType string, body io.Reader) (*http.Request, error)

NewPatchRoleRequestWithBody constructs an http.Request for the PatchRole method, with any body, and a specified content type

func NewPerformStocksActionsRequest

func NewPerformStocksActionsRequest(server string, body PerformStocksActionsJSONRequestBody) (*http.Request, error)

NewPerformStocksActionsRequest calls the generic PerformStocksActions builder with application/json body

func NewPerformStocksActionsRequestWithBody

func NewPerformStocksActionsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPerformStocksActionsRequestWithBody constructs an http.Request for the PerformStocksActions method, with any body, and a specified content type

func NewPostDeliveryPromiseRequest added in v0.3.0

func NewPostDeliveryPromiseRequest(server string, body PostDeliveryPromiseJSONRequestBody) (*http.Request, error)

NewPostDeliveryPromiseRequest calls the generic PostDeliveryPromise builder with application/json body

func NewPostDeliveryPromiseRequestWithBody added in v0.3.0

func NewPostDeliveryPromiseRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostDeliveryPromiseRequestWithBody constructs an http.Request for the PostDeliveryPromise method, with any body, and a specified content type

func NewPostRoutingStrategyNodeConfigCategoryRequest added in v0.6.0

func NewPostRoutingStrategyNodeConfigCategoryRequest(server string, body PostRoutingStrategyNodeConfigCategoryJSONRequestBody) (*http.Request, error)

NewPostRoutingStrategyNodeConfigCategoryRequest calls the generic PostRoutingStrategyNodeConfigCategory builder with application/json body

func NewPostRoutingStrategyNodeConfigCategoryRequestWithBody added in v0.6.0

func NewPostRoutingStrategyNodeConfigCategoryRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostRoutingStrategyNodeConfigCategoryRequestWithBody constructs an http.Request for the PostRoutingStrategyNodeConfigCategory method, with any body, and a specified content type

func NewPostRoutingStrategyRequest added in v0.6.0

func NewPostRoutingStrategyRequest(server string, body PostRoutingStrategyJSONRequestBody) (*http.Request, error)

NewPostRoutingStrategyRequest calls the generic PostRoutingStrategy builder with application/json body

func NewPostRoutingStrategyRequestWithBody added in v0.6.0

func NewPostRoutingStrategyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostRoutingStrategyRequestWithBody constructs an http.Request for the PostRoutingStrategy method, with any body, and a specified content type

func NewPutFacilityListingPartialStockRequest

func NewPutFacilityListingPartialStockRequest(server string, facilityId string, tenantArticleId string, body PutFacilityListingPartialStockJSONRequestBody) (*http.Request, error)

NewPutFacilityListingPartialStockRequest calls the generic PutFacilityListingPartialStock builder with application/json body

func NewPutFacilityListingPartialStockRequestWithBody

func NewPutFacilityListingPartialStockRequestWithBody(server string, facilityId string, tenantArticleId string, contentType string, body io.Reader) (*http.Request, error)

NewPutFacilityListingPartialStockRequestWithBody constructs an http.Request for the PutFacilityListingPartialStock method, with any body, and a specified content type

func NewPutFacilityListingRequest

func NewPutFacilityListingRequest(server string, facilityId string, body PutFacilityListingJSONRequestBody) (*http.Request, error)

NewPutFacilityListingRequest calls the generic PutFacilityListing builder with application/json body

func NewPutFacilityListingRequestWithBody

func NewPutFacilityListingRequestWithBody(server string, facilityId string, contentType string, body io.Reader) (*http.Request, error)

NewPutFacilityListingRequestWithBody constructs an http.Request for the PutFacilityListing method, with any body, and a specified content type

func NewPutRoutingStrategyNodeConfigCategoryRequest added in v0.6.0

func NewPutRoutingStrategyNodeConfigCategoryRequest(server string, categoryId string, body PutRoutingStrategyNodeConfigCategoryJSONRequestBody) (*http.Request, error)

NewPutRoutingStrategyNodeConfigCategoryRequest calls the generic PutRoutingStrategyNodeConfigCategory builder with application/json body

func NewPutRoutingStrategyNodeConfigCategoryRequestWithBody added in v0.6.0

func NewPutRoutingStrategyNodeConfigCategoryRequestWithBody(server string, categoryId string, contentType string, body io.Reader) (*http.Request, error)

NewPutRoutingStrategyNodeConfigCategoryRequestWithBody constructs an http.Request for the PutRoutingStrategyNodeConfigCategory method, with any body, and a specified content type

func NewPutRoutingStrategyRequest added in v0.6.0

func NewPutRoutingStrategyRequest(server string, strategyId string, body PutRoutingStrategyJSONRequestBody) (*http.Request, error)

NewPutRoutingStrategyRequest calls the generic PutRoutingStrategy builder with application/json body

func NewPutRoutingStrategyRequestWithBody added in v0.6.0

func NewPutRoutingStrategyRequestWithBody(server string, strategyId string, contentType string, body io.Reader) (*http.Request, error)

NewPutRoutingStrategyRequestWithBody constructs an http.Request for the PutRoutingStrategy method, with any body, and a specified content type

func NewReplaceFacilityRequest

func NewReplaceFacilityRequest(server string, facilityId string, body ReplaceFacilityJSONRequestBody) (*http.Request, error)

NewReplaceFacilityRequest calls the generic ReplaceFacility builder with application/json body

func NewReplaceFacilityRequestWithBody

func NewReplaceFacilityRequestWithBody(server string, facilityId string, contentType string, body io.Reader) (*http.Request, error)

NewReplaceFacilityRequestWithBody constructs an http.Request for the ReplaceFacility method, with any body, and a specified content type

func NewSearchFacilityRequest

func NewSearchFacilityRequest(server string, body SearchFacilityJSONRequestBody) (*http.Request, error)

NewSearchFacilityRequest calls the generic SearchFacility builder with application/json body

func NewSearchFacilityRequestWithBody

func NewSearchFacilityRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSearchFacilityRequestWithBody constructs an http.Request for the SearchFacility method, with any body, and a specified content type

func NewSearchListingRequest

func NewSearchListingRequest(server string, body SearchListingJSONRequestBody) (*http.Request, error)

NewSearchListingRequest calls the generic SearchListing builder with application/json body

func NewSearchListingRequestWithBody

func NewSearchListingRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSearchListingRequestWithBody constructs an http.Request for the SearchListing method, with any body, and a specified content type

func NewSearchOrderRequest added in v0.3.0

func NewSearchOrderRequest(server string, body SearchOrderJSONRequestBody) (*http.Request, error)

NewSearchOrderRequest calls the generic SearchOrder builder with application/json body

func NewSearchOrderRequestWithBody added in v0.3.0

func NewSearchOrderRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSearchOrderRequestWithBody constructs an http.Request for the SearchOrder method, with any body, and a specified content type

func NewSearchRoleRequest

func NewSearchRoleRequest(server string, body SearchRoleJSONRequestBody) (*http.Request, error)

NewSearchRoleRequest calls the generic SearchRole builder with application/json body

func NewSearchRoleRequestWithBody

func NewSearchRoleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSearchRoleRequestWithBody constructs an http.Request for the SearchRole method, with any body, and a specified content type

func NewSearchStockRequest

func NewSearchStockRequest(server string, body SearchStockJSONRequestBody) (*http.Request, error)

NewSearchStockRequest calls the generic SearchStock builder with application/json body

func NewSearchStockRequestWithBody

func NewSearchStockRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSearchStockRequestWithBody constructs an http.Request for the SearchStock method, with any body, and a specified content type

func NewSearchUserRequest

func NewSearchUserRequest(server string, body SearchUserJSONRequestBody) (*http.Request, error)

NewSearchUserRequest calls the generic SearchUser builder with application/json body

func NewSearchUserRequestWithBody

func NewSearchUserRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSearchUserRequestWithBody constructs an http.Request for the SearchUser method, with any body, and a specified content type

func NewStatusRequest

func NewStatusRequest(server string) (*http.Request, error)

NewStatusRequest constructs an http.Request for the Status method

func NewUpdateDiscountForFacilityRequest

func NewUpdateDiscountForFacilityRequest(server string, facilityRef string, facilityDiscountRef string, body UpdateDiscountForFacilityJSONRequestBody) (*http.Request, error)

NewUpdateDiscountForFacilityRequest calls the generic UpdateDiscountForFacility builder with application/json body

func NewUpdateDiscountForFacilityRequestWithBody

func NewUpdateDiscountForFacilityRequestWithBody(server string, facilityRef string, facilityDiscountRef string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDiscountForFacilityRequestWithBody constructs an http.Request for the UpdateDiscountForFacility method, with any body, and a specified content type

func NewUpdateFacilityConnectionRequest

func NewUpdateFacilityConnectionRequest(server string, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, body UpdateFacilityConnectionJSONRequestBody) (*http.Request, error)

NewUpdateFacilityConnectionRequest calls the generic UpdateFacilityConnection builder with application/json body

func NewUpdateFacilityConnectionRequestWithBody

func NewUpdateFacilityConnectionRequestWithBody(server string, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateFacilityConnectionRequestWithBody constructs an http.Request for the UpdateFacilityConnection method, with any body, and a specified content type

func NewUpdateMeRequest

func NewUpdateMeRequest(server string, body UpdateMeJSONRequestBody) (*http.Request, error)

NewUpdateMeRequest calls the generic UpdateMe builder with application/json body

func NewUpdateMeRequestWithBody

func NewUpdateMeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateMeRequestWithBody constructs an http.Request for the UpdateMe method, with any body, and a specified content type

func NewUpdateOrderRequest added in v0.3.0

func NewUpdateOrderRequest(server string, orderId string, body UpdateOrderJSONRequestBody) (*http.Request, error)

NewUpdateOrderRequest calls the generic UpdateOrder builder with application/json body

func NewUpdateOrderRequestWithBody added in v0.3.0

func NewUpdateOrderRequestWithBody(server string, orderId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateOrderRequestWithBody constructs an http.Request for the UpdateOrder method, with any body, and a specified content type

func NewUpdateRoleRequest

func NewUpdateRoleRequest(server string, name string, body UpdateRoleJSONRequestBody) (*http.Request, error)

NewUpdateRoleRequest calls the generic UpdateRole builder with application/json body

func NewUpdateRoleRequestWithBody

func NewUpdateRoleRequestWithBody(server string, name string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateRoleRequestWithBody constructs an http.Request for the UpdateRole method, with any body, and a specified content type

func NewUpdateStockRequest

func NewUpdateStockRequest(server string, stockId string, body UpdateStockJSONRequestBody) (*http.Request, error)

NewUpdateStockRequest calls the generic UpdateStock builder with application/json body

func NewUpdateStockRequestWithBody

func NewUpdateStockRequestWithBody(server string, stockId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateStockRequestWithBody constructs an http.Request for the UpdateStock method, with any body, and a specified content type

func NewUpsertStocksRequest

func NewUpsertStocksRequest(server string, body UpsertStocksJSONRequestBody) (*http.Request, error)

NewUpsertStocksRequest calls the generic UpsertStocks builder with application/json body

func NewUpsertStocksRequestWithBody

func NewUpsertStocksRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpsertStocksRequestWithBody constructs an http.Request for the UpsertStocks method, with any body, and a specified content type

func SuggestOperations

func SuggestOperations(id string) []string

SuggestOperations returns the operationIds closest to id, best first — what `fft api getPickjob` should be told when it meant getPickJob.

Ranking is: a case-insensitive exact match, then a substring match, then edit distance. Candidates further than a third of the name away are dropped: a suggestion nobody meant is worse than none.

Types

type AbsoluteSurchargeCostDetail added in v0.8.0

type AbsoluteSurchargeCostDetail struct {
	// Amount Money
	Amount Money `json:"amount"`

	// Id Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds
	//
	// Example: 0
	Id string `json:"id"`

	// TenantSurchargeType The tenant surcharge id
	//
	// Example: island
	TenantSurchargeType string                          `json:"tenantSurchargeType"`
	Type                AbsoluteSurchargeCostDetailType `json:"type"`
}

AbsoluteSurchargeCostDetail A fixed surcharge, charged as the tenant configured it.

type AbsoluteSurchargeCostDetailType added in v0.8.0

type AbsoluteSurchargeCostDetailType string

AbsoluteSurchargeCostDetailType defines model for AbsoluteSurchargeCostDetail.Type.

const (
	ABSOLUTESURCHARGE AbsoluteSurchargeCostDetailType = "ABSOLUTE_SURCHARGE"
)

Defines values for AbsoluteSurchargeCostDetailType.

func (AbsoluteSurchargeCostDetailType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the AbsoluteSurchargeCostDetailType enum.

type AbstractArticle added in v0.2.0

type AbstractArticle struct {
	// CustomAttributes 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.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// ImageUrl A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.
	//
	// Example: https://example.com/resource
	ImageUrl *string `json:"imageUrl,omitempty"`

	// TenantArticleId This is a reference to an article number
	//
	// Example: 4711
	TenantArticleId string `json:"tenantArticleId"`

	// Title The title of the product
	//
	// Example: Cologne Water
	Title string `json:"title"`

	// TitleLocalized The translations for the title of the product
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Weight Weight value is in gram
	Weight *float32 `json:"weight,omitempty"`
}

AbstractArticle AbstractArticle

type AbstractArticleForCreation added in v0.3.0

type AbstractArticleForCreation struct {
	// CustomAttributes 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.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// ImageUrl A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.
	//
	// Example: https://example.com/resource
	ImageUrl *string `json:"imageUrl,omitempty"`

	// TenantArticleId This is a reference to an article number
	//
	// Example: 4711
	TenantArticleId *string `json:"tenantArticleId,omitempty"`

	// Title The title of the product
	//
	// Example: Cologne Water
	Title string `json:"title"`

	// TitleLocalized The translations for the title of the product
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Weight Weight value is in gram
	Weight *float32 `json:"weight,omitempty"`
}

AbstractArticleForCreation AbstractArticleForCreation

type AbstractCarrierCredentials

type AbstractCarrierCredentials struct {
	// Key The key identifying the carrier credentials type
	Key string `json:"key"`
}

AbstractCarrierCredentials AbstractCarrierCredentials

type AbstractCostDetail added in v0.8.0

type AbstractCostDetail struct {
	// Amount Money
	Amount Money `json:"amount"`

	// Id Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds
	//
	// Example: 0
	Id   string `json:"id"`
	Type string `json:"type"`
}

AbstractCostDetail One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.

type AbstractFacilityActionsParameter

type AbstractFacilityActionsParameter struct {
	Name string `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

AbstractFacilityActionsParameter AbstractFacilityActionsParameter

type AbstractModificationAction

type AbstractModificationAction struct {
	// Action Example: <Use the corresponding action, see documentation>
	Action AbstractModificationActionAction `json:"action"`
}

AbstractModificationAction AbstractModificationAction

type AbstractModificationActionAction

type AbstractModificationActionAction string

AbstractModificationActionAction Example: <Use the corresponding action, see documentation>

const (
	AbstractModificationActionActionAddAllowedValueToTag             AbstractModificationActionAction = "AddAllowedValueToTag"
	AbstractModificationActionActionAddTagsToProcess                 AbstractModificationActionAction = "AddTagsToProcess"
	AbstractModificationActionActionAssignFacilityToProcess          AbstractModificationActionAction = "AssignFacilityToProcess"
	AbstractModificationActionActionModifyCarrier                    AbstractModificationActionAction = "ModifyCarrier"
	AbstractModificationActionActionModifyFacility                   AbstractModificationActionAction = "ModifyFacility"
	AbstractModificationActionActionModifyFeature                    AbstractModificationActionAction = "ModifyFeature"
	AbstractModificationActionActionModifyFence                      AbstractModificationActionAction = "ModifyFence"
	AbstractModificationActionActionModifyGlobalRoutingConfiguration AbstractModificationActionAction = "ModifyGlobalRoutingConfiguration"
	AbstractModificationActionActionModifyListing                    AbstractModificationActionAction = "ModifyListing"
	AbstractModificationActionActionModifyListingReactivationAfter   AbstractModificationActionAction = "ModifyListingReactivationAfter"
	AbstractModificationActionActionModifyOrderSplit                 AbstractModificationActionAction = "ModifyOrderSplit"
	AbstractModificationActionActionModifyPartialStock               AbstractModificationActionAction = "ModifyPartialStock"
	AbstractModificationActionActionModifyPrioritization             AbstractModificationActionAction = "ModifyPrioritization"
	AbstractModificationActionActionModifyRating                     AbstractModificationActionAction = "ModifyRating"
	AbstractModificationActionActionModifyRetainedOfflineStock       AbstractModificationActionAction = "ModifyRetainedOfflineStock"
	AbstractModificationActionActionModifyRoutingPlan                AbstractModificationActionAction = "ModifyRoutingPlan"
	AbstractModificationActionActionModifyShortpick                  AbstractModificationActionAction = "ModifyShortpick"
	AbstractModificationActionActionModifyStorageLocation            AbstractModificationActionAction = "ModifyStorageLocation"
	AbstractModificationActionActionModifyTimingMode                 AbstractModificationActionAction = "ModifyTimingMode"
	AbstractModificationActionActionModifyUser                       AbstractModificationActionAction = "ModifyUser"
	AbstractModificationActionActionUnlockOrder                      AbstractModificationActionAction = "UnlockOrder"
	AbstractModificationActionActionUpdateGdprCleanupDateAction      AbstractModificationActionAction = "UpdateGdprCleanupDateAction"
)

Defines values for AbstractModificationActionAction.

func (AbstractModificationActionAction) Valid

Valid indicates whether the value is a known member of the AbstractModificationActionAction enum.

type AbstractOrderActionsParameter added in v0.3.0

type AbstractOrderActionsParameter struct {
	Name string `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

AbstractOrderActionsParameter AbstractOrderActionsParameter

type AbstractOrderLineItemActionsParameter added in v0.3.0

type AbstractOrderLineItemActionsParameter struct {
	Name string `json:"name"`

	// Version Version of the order to be changed
	Version int `json:"version"`
}

AbstractOrderLineItemActionsParameter AbstractOrderLineItemActionsParameter

type AbstractRatingConfiguration

type AbstractRatingConfiguration struct {
	// Type This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.
	Type *RatingConfigurationType `json:"type,omitempty"`
}

AbstractRatingConfiguration Base configuration for ratings. See documentation for details.

type AbstractReason added in v0.3.0

type AbstractReason struct {
	// Action The action this reason can be attached to.
	Action string `json:"action"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// Id The id of the Reason
	Id string `json:"id"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Reason Text explaining the reason for a supported action.
	//
	// Example: Rerouted because of an issue in the Facility.
	Reason string `json:"reason"`

	// ReasonLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	ReasonLocalized LocaleString `json:"reasonLocalized"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

AbstractReason AbstractReason

type AbstractReasonForCreation added in v0.3.0

type AbstractReasonForCreation struct {
	// Reason Text explaining the reason for a supported action.
	//
	// Example: Rerouted because of an issue in the Facility.
	Reason string `json:"reason"`

	// ReasonLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	ReasonLocalized LocaleString `json:"reasonLocalized"`
}

AbstractReasonForCreation AbstractReasonForCreation

type AbstractRoutingStrategyActionsParameter added in v0.6.0

type AbstractRoutingStrategyActionsParameter struct {
	Name string `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

AbstractRoutingStrategyActionsParameter AbstractRoutingStrategyActionsParameter

type ActionsRoutingStrategyJSONRequestBody added in v0.6.0

type ActionsRoutingStrategyJSONRequestBody = RoutingStrategyActionsParameter

ActionsRoutingStrategyJSONRequestBody defines body for ActionsRoutingStrategy for application/json ContentType.

type ActionsRoutingStrategyResponse added in v0.6.0

type ActionsRoutingStrategyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingStrategy
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseActionsRoutingStrategyResponse added in v0.6.0

func ParseActionsRoutingStrategyResponse(rsp *http.Response) (*ActionsRoutingStrategyResponse, error)

ParseActionsRoutingStrategyResponse parses an HTTP response from a ActionsRoutingStrategyWithResponse call

func (ActionsRoutingStrategyResponse) ContentType added in v0.6.0

func (r ActionsRoutingStrategyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ActionsRoutingStrategyResponse) GetBody added in v0.8.0

func (r ActionsRoutingStrategyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ActionsRoutingStrategyResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ActionsRoutingStrategyResponse) GetJSON400 added in v0.8.0

func (r ActionsRoutingStrategyResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ActionsRoutingStrategyResponse) GetJSON401 added in v0.8.0

func (r ActionsRoutingStrategyResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ActionsRoutingStrategyResponse) GetJSON403 added in v0.8.0

func (r ActionsRoutingStrategyResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ActionsRoutingStrategyResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (ActionsRoutingStrategyResponse) StatusCode added in v0.6.0

func (r ActionsRoutingStrategyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ActivationTimeFrame

type ActivationTimeFrame struct {
	// ActiveFrom Sets a date before which the associated entity does not become active
	ActiveFrom *time.Time `json:"activeFrom,omitempty"`

	// ActiveUntil Sets a date after which the associated entity becomes active
	ActiveUntil *time.Time `json:"activeUntil,omitempty"`

	// Recurrence ActivationTimeFrameRecurrenceType
	Recurrence ActivationTimeFrameRecurrenceType `json:"recurrence"`
}

ActivationTimeFrame ActivationTimeFrame

type ActivationTimeFrameRecurrenceType

type ActivationTimeFrameRecurrenceType string

ActivationTimeFrameRecurrenceType ActivationTimeFrameRecurrenceType

const (
	ActivationTimeFrameRecurrenceTypeNONRECURRING ActivationTimeFrameRecurrenceType = "NONRECURRING"
	ActivationTimeFrameRecurrenceTypeYEARLY       ActivationTimeFrameRecurrenceType = "YEARLY"
)

Defines values for ActivationTimeFrameRecurrenceType.

func (ActivationTimeFrameRecurrenceType) Valid

Valid indicates whether the value is a known member of the ActivationTimeFrameRecurrenceType enum.

type AddDiscountToFacilityJSONRequestBody

type AddDiscountToFacilityJSONRequestBody = FacilityDiscountForCreation

AddDiscountToFacilityJSONRequestBody defines body for AddDiscountToFacility for application/json ContentType.

type AddDiscountToFacilityResponse

type AddDiscountToFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *FacilityDiscount
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseAddDiscountToFacilityResponse

func ParseAddDiscountToFacilityResponse(rsp *http.Response) (*AddDiscountToFacilityResponse, error)

ParseAddDiscountToFacilityResponse parses an HTTP response from a AddDiscountToFacilityWithResponse call

func (AddDiscountToFacilityResponse) ContentType

func (r AddDiscountToFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AddDiscountToFacilityResponse) GetBody added in v0.8.0

func (r AddDiscountToFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AddDiscountToFacilityResponse) GetJSON201 added in v0.8.0

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (AddDiscountToFacilityResponse) GetJSON400 added in v0.8.0

func (r AddDiscountToFacilityResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (AddDiscountToFacilityResponse) GetJSON401 added in v0.8.0

func (r AddDiscountToFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (AddDiscountToFacilityResponse) GetJSON403 added in v0.8.0

func (r AddDiscountToFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (AddDiscountToFacilityResponse) GetJSON404 added in v0.8.0

func (r AddDiscountToFacilityResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (AddDiscountToFacilityResponse) Status

Status returns HTTPResponse.Status

func (AddDiscountToFacilityResponse) StatusCode

func (r AddDiscountToFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AddFacility201JSONResponseBody

type AddFacility201JSONResponseBody struct {
	// contains filtered or unexported fields
}

AddFacility201JSONResponseBody defines parameters for AddFacility.

func (AddFacility201JSONResponseBody) AsManagedFacility

func (t AddFacility201JSONResponseBody) AsManagedFacility() (ManagedFacility, error)

AsManagedFacility returns the union data inside the AddFacility201JSONResponseBody as a ManagedFacility

func (AddFacility201JSONResponseBody) AsSupplier

func (t AddFacility201JSONResponseBody) AsSupplier() (Supplier, error)

AsSupplier returns the union data inside the AddFacility201JSONResponseBody as a Supplier

func (*AddFacility201JSONResponseBody) FromManagedFacility

func (t *AddFacility201JSONResponseBody) FromManagedFacility(v ManagedFacility) error

FromManagedFacility overwrites any union data inside the AddFacility201JSONResponseBody as the provided ManagedFacility

func (*AddFacility201JSONResponseBody) FromSupplier

func (t *AddFacility201JSONResponseBody) FromSupplier(v Supplier) error

FromSupplier overwrites any union data inside the AddFacility201JSONResponseBody as the provided Supplier

func (AddFacility201JSONResponseBody) MarshalJSON

func (t AddFacility201JSONResponseBody) MarshalJSON() ([]byte, error)

func (*AddFacility201JSONResponseBody) MergeManagedFacility

func (t *AddFacility201JSONResponseBody) MergeManagedFacility(v ManagedFacility) error

MergeManagedFacility performs a merge with any union data inside the AddFacility201JSONResponseBody, using the provided ManagedFacility

func (*AddFacility201JSONResponseBody) MergeSupplier

func (t *AddFacility201JSONResponseBody) MergeSupplier(v Supplier) error

MergeSupplier performs a merge with any union data inside the AddFacility201JSONResponseBody, using the provided Supplier

func (*AddFacility201JSONResponseBody) UnmarshalJSON

func (t *AddFacility201JSONResponseBody) UnmarshalJSON(b []byte) error

type AddFacilityJSONBody

type AddFacilityJSONBody struct {
	// contains filtered or unexported fields
}

AddFacilityJSONBody defines parameters for AddFacility.

func (AddFacilityJSONBody) AsManagedFacilityForCreation

func (t AddFacilityJSONBody) AsManagedFacilityForCreation() (ManagedFacilityForCreation, error)

AsManagedFacilityForCreation returns the union data inside the AddFacilityJSONBody as a ManagedFacilityForCreation

func (AddFacilityJSONBody) AsSupplierForCreation

func (t AddFacilityJSONBody) AsSupplierForCreation() (SupplierForCreation, error)

AsSupplierForCreation returns the union data inside the AddFacilityJSONBody as a SupplierForCreation

func (*AddFacilityJSONBody) FromManagedFacilityForCreation

func (t *AddFacilityJSONBody) FromManagedFacilityForCreation(v ManagedFacilityForCreation) error

FromManagedFacilityForCreation overwrites any union data inside the AddFacilityJSONBody as the provided ManagedFacilityForCreation

func (*AddFacilityJSONBody) FromSupplierForCreation

func (t *AddFacilityJSONBody) FromSupplierForCreation(v SupplierForCreation) error

FromSupplierForCreation overwrites any union data inside the AddFacilityJSONBody as the provided SupplierForCreation

func (AddFacilityJSONBody) MarshalJSON

func (t AddFacilityJSONBody) MarshalJSON() ([]byte, error)

func (*AddFacilityJSONBody) MergeManagedFacilityForCreation

func (t *AddFacilityJSONBody) MergeManagedFacilityForCreation(v ManagedFacilityForCreation) error

MergeManagedFacilityForCreation performs a merge with any union data inside the AddFacilityJSONBody, using the provided ManagedFacilityForCreation

func (*AddFacilityJSONBody) MergeSupplierForCreation

func (t *AddFacilityJSONBody) MergeSupplierForCreation(v SupplierForCreation) error

MergeSupplierForCreation performs a merge with any union data inside the AddFacilityJSONBody, using the provided SupplierForCreation

func (*AddFacilityJSONBody) UnmarshalJSON

func (t *AddFacilityJSONBody) UnmarshalJSON(b []byte) error

type AddFacilityJSONRequestBody

type AddFacilityJSONRequestBody AddFacilityJSONBody

AddFacilityJSONRequestBody defines body for AddFacility for application/json ContentType.

type AddFacilityResponse

type AddFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *AddFacility201JSONResponseBody
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseAddFacilityResponse

func ParseAddFacilityResponse(rsp *http.Response) (*AddFacilityResponse, error)

ParseAddFacilityResponse parses an HTTP response from a AddFacilityWithResponse call

func (AddFacilityResponse) ContentType

func (r AddFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AddFacilityResponse) GetBody added in v0.8.0

func (r AddFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AddFacilityResponse) GetJSON201 added in v0.8.0

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (AddFacilityResponse) GetJSON400 added in v0.8.0

func (r AddFacilityResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (AddFacilityResponse) GetJSON401 added in v0.8.0

func (r AddFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (AddFacilityResponse) GetJSON403 added in v0.8.0

func (r AddFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (AddFacilityResponse) Status

func (r AddFacilityResponse) Status() string

Status returns HTTPResponse.Status

func (AddFacilityResponse) StatusCode

func (r AddFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AddOrderJSONRequestBody added in v0.3.0

type AddOrderJSONRequestBody = OrderForCreation

AddOrderJSONRequestBody defines body for AddOrder for application/json ContentType.

type AddOrderResponse added in v0.3.0

type AddOrderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *Order
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseAddOrderResponse added in v0.3.0

func ParseAddOrderResponse(rsp *http.Response) (*AddOrderResponse, error)

ParseAddOrderResponse parses an HTTP response from a AddOrderWithResponse call

func (AddOrderResponse) ContentType added in v0.3.0

func (r AddOrderResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AddOrderResponse) GetBody added in v0.8.0

func (r AddOrderResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AddOrderResponse) GetJSON201 added in v0.8.0

func (r AddOrderResponse) GetJSON201() *Order

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (AddOrderResponse) GetJSON400 added in v0.8.0

func (r AddOrderResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (AddOrderResponse) GetJSON401 added in v0.8.0

func (r AddOrderResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (AddOrderResponse) GetJSON403 added in v0.8.0

func (r AddOrderResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (AddOrderResponse) Status added in v0.3.0

func (r AddOrderResponse) Status() string

Status returns HTTPResponse.Status

func (AddOrderResponse) StatusCode added in v0.3.0

func (r AddOrderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Address

type Address struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// City Example: Langenfeld
	City string `json:"city"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country string `json:"country"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber  *string `json:"houseNumber,omitempty"`
	PhoneNumbers *[]struct {
		// CustomAttributes Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
		CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

		// Label Can be used to give a description for the number, like "private", "business number", etc.
		Label *string                 `json:"label,omitempty"`
		Type  AddressPhoneNumbersType `json:"type"`

		// Value The number itself. We do not enforce any format (yet).
		Value string `json:"value"`
	} `json:"phoneNumbers,omitempty"`

	// PostalCode Example: 40764
	PostalCode string `json:"postalCode"`

	// Province Example: NRW
	Province *string `json:"province,omitempty"`

	// Street Example: Hauptstr.
	Street string `json:"street"`
}

Address Address

type AddressPhoneNumbersType

type AddressPhoneNumbersType string

AddressPhoneNumbersType defines model for Address.PhoneNumbers.Type.

const (
	AddressPhoneNumbersTypeMOBILE AddressPhoneNumbersType = "MOBILE"
	AddressPhoneNumbersTypePHONE  AddressPhoneNumbersType = "PHONE"
)

Defines values for AddressPhoneNumbersType.

func (AddressPhoneNumbersType) Valid

func (e AddressPhoneNumbersType) Valid() bool

Valid indicates whether the value is a known member of the AddressPhoneNumbersType enum.

type AddressType added in v0.2.0

type AddressType string

AddressType Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.

const (
	AddressTypeINVOICEADDRESS AddressType = "INVOICE_ADDRESS"
	AddressTypePARCELLOCKER   AddressType = "PARCEL_LOCKER"
	AddressTypePOSTALADDRESS  AddressType = "POSTAL_ADDRESS"
)

Defines values for AddressType.

func (AddressType) Valid added in v0.2.0

func (e AddressType) Valid() bool

Valid indicates whether the value is a known member of the AddressType enum.

type ApiError

type ApiError = []ErrorInner

ApiError ApiError

type ArticleAttributeItem

type ArticleAttributeItem struct {
	// Category This category is used by fulfillmenttools to customize implemented processes.
	// Categorized attributes are used by various processes and tools
	// throughout fulfillmenttools. For a complete list of possible categories
	// and their correct use, refer to the documentation.
	// Default value: miscellaneous
	Category *ArticleAttributeItemCategory `json:"category,omitempty"`

	// Context Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints.
	Context *ArticleAttributeItemContext `json:"context,omitempty"`

	// Key Providing the key %%subtitle%% (see example) here will cause the
	// value to appear, for example, in the App.
	// With all other attributes also the key will be displayed in the
	//  clients.
	//
	// Example: %%subtitle%%
	Key ArticleAttributeItem_Key `json:"key"`

	// KeyLocalized The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%
	KeyLocalized *LocaleString `json:"keyLocalized,omitempty"`

	// Priority This value gives the priority in the respective attribute category.
	// The lower the value the higher is the priority, for example, priority 1 is
	// higher than priority 10. Attributes that have the highest priority
	// might be selected for display in different articles of fulfillmenttools. Default
	// value is 1001. For details please contact the product owners.
	//
	// Example: 100
	Priority *int64 `json:"priority,omitempty"`

	// Type The type of the attribute.
	//
	// Example: STRING
	Type *ArticleAttributeItemType `json:"type,omitempty"`

	// Value Example: 585er Gold
	Value string `json:"value"`

	// ValueLocalized The translations for the key of the attribute. This can be only filled with a descriptive category
	ValueLocalized *LocaleString `json:"valueLocalized,omitempty"`
}

ArticleAttributeItem ArticleAttributeItem

type ArticleAttributeItemCategory

type ArticleAttributeItemCategory string

ArticleAttributeItemCategory This category is used by fulfillmenttools to customize implemented processes. Categorized attributes are used by various processes and tools throughout fulfillmenttools. For a complete list of possible categories and their correct use, refer to the documentation. Default value: miscellaneous

const (
	ArticleAttributeItemCategoryBasePrice               ArticleAttributeItemCategory = "basePrice"
	ArticleAttributeItemCategoryCarrierService          ArticleAttributeItemCategory = "carrierService"
	ArticleAttributeItemCategoryCustoms                 ArticleAttributeItemCategory = "customs"
	ArticleAttributeItemCategoryDescriptive             ArticleAttributeItemCategory = "descriptive"
	ArticleAttributeItemCategoryDimensions              ArticleAttributeItemCategory = "dimensions"
	ArticleAttributeItemCategoryDiscount                ArticleAttributeItemCategory = "discount"
	ArticleAttributeItemCategoryFinalLineItemPrice      ArticleAttributeItemCategory = "finalLineItemPrice"
	ArticleAttributeItemCategoryFinalUnitPrice          ArticleAttributeItemCategory = "finalUnitPrice"
	ArticleAttributeItemCategoryInsurance               ArticleAttributeItemCategory = "insurance"
	ArticleAttributeItemCategoryMiscellaneous           ArticleAttributeItemCategory = "miscellaneous"
	ArticleAttributeItemCategoryPickingSequence         ArticleAttributeItemCategory = "pickingSequence"
	ArticleAttributeItemCategorySalesPrice              ArticleAttributeItemCategory = "salesPrice"
	ArticleAttributeItemCategoryShop                    ArticleAttributeItemCategory = "shop"
	ArticleAttributeItemCategorySubtotalAfterDiscounts  ArticleAttributeItemCategory = "subtotalAfterDiscounts"
	ArticleAttributeItemCategorySubtotalBeforeDiscounts ArticleAttributeItemCategory = "subtotalBeforeDiscounts"
	ArticleAttributeItemCategorySurcharge               ArticleAttributeItemCategory = "surcharge"
	ArticleAttributeItemCategoryTax                     ArticleAttributeItemCategory = "tax"
)

Defines values for ArticleAttributeItemCategory.

func (ArticleAttributeItemCategory) Valid

Valid indicates whether the value is a known member of the ArticleAttributeItemCategory enum.

type ArticleAttributeItemContext

type ArticleAttributeItemContext struct {
	// Type Indicates the entity type the value refers to.
	Type ArticleAttributeItemContextType `json:"type"`

	// Value Holds the reference to the entity the attribute refers to.
	Value string `json:"value"`
}

ArticleAttributeItemContext ArticleAttributeItemContext

type ArticleAttributeItemContextType

type ArticleAttributeItemContextType string

ArticleAttributeItemContextType Indicates the entity type the value refers to.

const (
	ArticleAttributeItemContextTypeFACILITY      ArticleAttributeItemContextType = "FACILITY"
	ArticleAttributeItemContextTypeFACILITYGROUP ArticleAttributeItemContextType = "FACILITY_GROUP"
	ArticleAttributeItemContextTypeTAGREFERENCE  ArticleAttributeItemContextType = "TAG_REFERENCE"
)

Defines values for ArticleAttributeItemContextType.

func (ArticleAttributeItemContextType) Valid

Valid indicates whether the value is a known member of the ArticleAttributeItemContextType enum.

type ArticleAttributeItemForUpsert added in v0.9.0

type ArticleAttributeItemForUpsert struct {
	// Category This category is used by fulfillmenttools to customize implemented processes.
	// Categorized attributes are used by various processes and tools
	// throughout fulfillmenttools. For a complete list of possible categories
	// and their correct use, refer to the documentation.
	// Default value: miscellaneous
	Category *ArticleAttributeItemForUpsertCategory `json:"category,omitempty"`

	// Context Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints.
	Context *ArticleAttributeItemContext `json:"context,omitempty"`

	// Key Providing the key %%subtitle%% (see example) here will cause the
	// value to appear, for example, in the App.
	// With all other attributes also the key will be displayed in the
	//  clients.
	//
	// Example: %%subtitle%%
	Key ArticleAttributeItemForUpsert_Key `json:"key"`

	// KeyLocalized The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%
	KeyLocalized *LocaleString `json:"keyLocalized,omitempty"`

	// Priority This value gives the priority in the respective attribute category.
	// The lower the value the higher is the priority, for example, priority 1 is
	// higher than priority 10. Attributes that have the highest priority
	// might be selected for display in different articles of fulfillmenttools. Default
	// value is 1001. For details please contact the product owners.
	//
	// Example: 100
	Priority *int64 `json:"priority,omitempty"`

	// Type The type of the attribute.
	//
	// Example: STRING
	Type *ArticleAttributeItemForUpsertType `json:"type,omitempty"`

	// Value Example: 585er Gold
	Value string `json:"value"`

	// ValueLocalized The translations for the key of the attribute. This can be only filled with a descriptive category
	ValueLocalized *LocaleString `json:"valueLocalized,omitempty"`
}

ArticleAttributeItemForUpsert ArticleAttributeItemForUpsert

type ArticleAttributeItemForUpsertCategory added in v0.9.0

type ArticleAttributeItemForUpsertCategory string

ArticleAttributeItemForUpsertCategory This category is used by fulfillmenttools to customize implemented processes. Categorized attributes are used by various processes and tools throughout fulfillmenttools. For a complete list of possible categories and their correct use, refer to the documentation. Default value: miscellaneous

const (
	ArticleAttributeItemForUpsertCategoryBasePrice       ArticleAttributeItemForUpsertCategory = "basePrice"
	ArticleAttributeItemForUpsertCategoryCarrierService  ArticleAttributeItemForUpsertCategory = "carrierService"
	ArticleAttributeItemForUpsertCategoryCustoms         ArticleAttributeItemForUpsertCategory = "customs"
	ArticleAttributeItemForUpsertCategoryDescriptive     ArticleAttributeItemForUpsertCategory = "descriptive"
	ArticleAttributeItemForUpsertCategoryDimensions      ArticleAttributeItemForUpsertCategory = "dimensions"
	ArticleAttributeItemForUpsertCategoryDiscount        ArticleAttributeItemForUpsertCategory = "discount"
	ArticleAttributeItemForUpsertCategoryInsurance       ArticleAttributeItemForUpsertCategory = "insurance"
	ArticleAttributeItemForUpsertCategoryMiscellaneous   ArticleAttributeItemForUpsertCategory = "miscellaneous"
	ArticleAttributeItemForUpsertCategoryPickingSequence ArticleAttributeItemForUpsertCategory = "pickingSequence"
	ArticleAttributeItemForUpsertCategorySalesPrice      ArticleAttributeItemForUpsertCategory = "salesPrice"
	ArticleAttributeItemForUpsertCategoryShop            ArticleAttributeItemForUpsertCategory = "shop"
	ArticleAttributeItemForUpsertCategorySurcharge       ArticleAttributeItemForUpsertCategory = "surcharge"
	ArticleAttributeItemForUpsertCategoryTax             ArticleAttributeItemForUpsertCategory = "tax"
)

Defines values for ArticleAttributeItemForUpsertCategory.

func (ArticleAttributeItemForUpsertCategory) Valid added in v0.9.0

Valid indicates whether the value is a known member of the ArticleAttributeItemForUpsertCategory enum.

type ArticleAttributeItemForUpsertKey0 added in v0.9.0

type ArticleAttributeItemForUpsertKey0 = string

ArticleAttributeItemForUpsertKey0 defines model for ArticleAttributeItemForUpsert.Key.0.

type ArticleAttributeItemForUpsertKey1 added in v0.9.0

type ArticleAttributeItemForUpsertKey1 = interface{}

ArticleAttributeItemForUpsertKey1 defines model for ArticleAttributeItemForUpsert.Key.1.

type ArticleAttributeItemForUpsertType added in v0.9.0

type ArticleAttributeItemForUpsertType string

ArticleAttributeItemForUpsertType The type of the attribute.

Example: STRING

const (
	ArticleAttributeItemForUpsertTypeBOOLEAN  ArticleAttributeItemForUpsertType = "BOOLEAN"
	ArticleAttributeItemForUpsertTypeCURRENCY ArticleAttributeItemForUpsertType = "CURRENCY"
	ArticleAttributeItemForUpsertTypeNUMBER   ArticleAttributeItemForUpsertType = "NUMBER"
	ArticleAttributeItemForUpsertTypeSTRING   ArticleAttributeItemForUpsertType = "STRING"
)

Defines values for ArticleAttributeItemForUpsertType.

func (ArticleAttributeItemForUpsertType) Valid added in v0.9.0

Valid indicates whether the value is a known member of the ArticleAttributeItemForUpsertType enum.

type ArticleAttributeItemForUpsert_Key added in v0.9.0

type ArticleAttributeItemForUpsert_Key struct {
	// contains filtered or unexported fields
}

ArticleAttributeItemForUpsert_Key Providing the key %%subtitle%% (see example) here will cause the value to appear, for example, in the App. With all other attributes also the key will be displayed in the

clients.

Example: %%subtitle%%

func (ArticleAttributeItemForUpsert_Key) AsArticleAttributeItemForUpsertKey0 added in v0.9.0

func (t ArticleAttributeItemForUpsert_Key) AsArticleAttributeItemForUpsertKey0() (ArticleAttributeItemForUpsertKey0, error)

AsArticleAttributeItemForUpsertKey0 returns the union data inside the ArticleAttributeItemForUpsert_Key as a ArticleAttributeItemForUpsertKey0

func (ArticleAttributeItemForUpsert_Key) AsArticleAttributeItemForUpsertKey1 added in v0.9.0

func (t ArticleAttributeItemForUpsert_Key) AsArticleAttributeItemForUpsertKey1() (ArticleAttributeItemForUpsertKey1, error)

AsArticleAttributeItemForUpsertKey1 returns the union data inside the ArticleAttributeItemForUpsert_Key as a ArticleAttributeItemForUpsertKey1

func (*ArticleAttributeItemForUpsert_Key) FromArticleAttributeItemForUpsertKey0 added in v0.9.0

func (t *ArticleAttributeItemForUpsert_Key) FromArticleAttributeItemForUpsertKey0(v ArticleAttributeItemForUpsertKey0) error

FromArticleAttributeItemForUpsertKey0 overwrites any union data inside the ArticleAttributeItemForUpsert_Key as the provided ArticleAttributeItemForUpsertKey0

func (*ArticleAttributeItemForUpsert_Key) FromArticleAttributeItemForUpsertKey1 added in v0.9.0

func (t *ArticleAttributeItemForUpsert_Key) FromArticleAttributeItemForUpsertKey1(v ArticleAttributeItemForUpsertKey1) error

FromArticleAttributeItemForUpsertKey1 overwrites any union data inside the ArticleAttributeItemForUpsert_Key as the provided ArticleAttributeItemForUpsertKey1

func (ArticleAttributeItemForUpsert_Key) MarshalJSON added in v0.9.0

func (t ArticleAttributeItemForUpsert_Key) MarshalJSON() ([]byte, error)

func (*ArticleAttributeItemForUpsert_Key) MergeArticleAttributeItemForUpsertKey0 added in v0.9.0

func (t *ArticleAttributeItemForUpsert_Key) MergeArticleAttributeItemForUpsertKey0(v ArticleAttributeItemForUpsertKey0) error

MergeArticleAttributeItemForUpsertKey0 performs a merge with any union data inside the ArticleAttributeItemForUpsert_Key, using the provided ArticleAttributeItemForUpsertKey0

func (*ArticleAttributeItemForUpsert_Key) MergeArticleAttributeItemForUpsertKey1 added in v0.9.0

func (t *ArticleAttributeItemForUpsert_Key) MergeArticleAttributeItemForUpsertKey1(v ArticleAttributeItemForUpsertKey1) error

MergeArticleAttributeItemForUpsertKey1 performs a merge with any union data inside the ArticleAttributeItemForUpsert_Key, using the provided ArticleAttributeItemForUpsertKey1

func (*ArticleAttributeItemForUpsert_Key) UnmarshalJSON added in v0.9.0

func (t *ArticleAttributeItemForUpsert_Key) UnmarshalJSON(b []byte) error

type ArticleAttributeItemKey0 added in v0.9.0

type ArticleAttributeItemKey0 = string

ArticleAttributeItemKey0 defines model for ArticleAttributeItem.Key.0.

type ArticleAttributeItemKey1 added in v0.9.0

type ArticleAttributeItemKey1 = interface{}

ArticleAttributeItemKey1 defines model for ArticleAttributeItem.Key.1.

type ArticleAttributeItemType

type ArticleAttributeItemType string

ArticleAttributeItemType The type of the attribute.

Example: STRING

const (
	ArticleAttributeItemTypeBOOLEAN  ArticleAttributeItemType = "BOOLEAN"
	ArticleAttributeItemTypeCURRENCY ArticleAttributeItemType = "CURRENCY"
	ArticleAttributeItemTypeNUMBER   ArticleAttributeItemType = "NUMBER"
	ArticleAttributeItemTypeSTRING   ArticleAttributeItemType = "STRING"
)

Defines values for ArticleAttributeItemType.

func (ArticleAttributeItemType) Valid

func (e ArticleAttributeItemType) Valid() bool

Valid indicates whether the value is a known member of the ArticleAttributeItemType enum.

type ArticleAttributeItem_Key added in v0.9.0

type ArticleAttributeItem_Key struct {
	// contains filtered or unexported fields
}

ArticleAttributeItem_Key Providing the key %%subtitle%% (see example) here will cause the value to appear, for example, in the App. With all other attributes also the key will be displayed in the

clients.

Example: %%subtitle%%

func (ArticleAttributeItem_Key) AsArticleAttributeItemKey0 added in v0.9.0

func (t ArticleAttributeItem_Key) AsArticleAttributeItemKey0() (ArticleAttributeItemKey0, error)

AsArticleAttributeItemKey0 returns the union data inside the ArticleAttributeItem_Key as a ArticleAttributeItemKey0

func (ArticleAttributeItem_Key) AsArticleAttributeItemKey1 added in v0.9.0

func (t ArticleAttributeItem_Key) AsArticleAttributeItemKey1() (ArticleAttributeItemKey1, error)

AsArticleAttributeItemKey1 returns the union data inside the ArticleAttributeItem_Key as a ArticleAttributeItemKey1

func (*ArticleAttributeItem_Key) FromArticleAttributeItemKey0 added in v0.9.0

func (t *ArticleAttributeItem_Key) FromArticleAttributeItemKey0(v ArticleAttributeItemKey0) error

FromArticleAttributeItemKey0 overwrites any union data inside the ArticleAttributeItem_Key as the provided ArticleAttributeItemKey0

func (*ArticleAttributeItem_Key) FromArticleAttributeItemKey1 added in v0.9.0

func (t *ArticleAttributeItem_Key) FromArticleAttributeItemKey1(v ArticleAttributeItemKey1) error

FromArticleAttributeItemKey1 overwrites any union data inside the ArticleAttributeItem_Key as the provided ArticleAttributeItemKey1

func (ArticleAttributeItem_Key) MarshalJSON added in v0.9.0

func (t ArticleAttributeItem_Key) MarshalJSON() ([]byte, error)

func (*ArticleAttributeItem_Key) MergeArticleAttributeItemKey0 added in v0.9.0

func (t *ArticleAttributeItem_Key) MergeArticleAttributeItemKey0(v ArticleAttributeItemKey0) error

MergeArticleAttributeItemKey0 performs a merge with any union data inside the ArticleAttributeItem_Key, using the provided ArticleAttributeItemKey0

func (*ArticleAttributeItem_Key) MergeArticleAttributeItemKey1 added in v0.9.0

func (t *ArticleAttributeItem_Key) MergeArticleAttributeItemKey1(v ArticleAttributeItemKey1) error

MergeArticleAttributeItemKey1 performs a merge with any union data inside the ArticleAttributeItem_Key, using the provided ArticleAttributeItemKey1

func (*ArticleAttributeItem_Key) UnmarshalJSON added in v0.9.0

func (t *ArticleAttributeItem_Key) UnmarshalJSON(b []byte) error

type ArticleItem

type ArticleItem struct {
	Quantity         float32 `json:"quantity"`
	TenantArticleRef string  `json:"tenantArticleRef"`
}

ArticleItem ArticleItem

type ArticleStockForecast

type ArticleStockForecast struct {
	Created              time.Time                  `json:"created"`
	Cumulated            float32                    `json:"cumulated"`
	CumulatedLowerBounds []float32                  `json:"cumulatedLowerBounds"`
	CumulatedUpperBounds []float32                  `json:"cumulatedUpperBounds"`
	Id                   string                     `json:"id"`
	LastModified         time.Time                  `json:"lastModified"`
	LoadTime             time.Time                  `json:"loadTime"`
	LowerBounds          []float32                  `json:"lowerBounds"`
	Period               ArticleStockForecastPeriod `json:"period"`
	Point                float32                    `json:"point"`
	SourceDate           time.Time                  `json:"sourceDate"`
	TargetDate           time.Time                  `json:"targetDate"`
	TenantArticleId      string                     `json:"tenantArticleId"`
	UpperBounds          []float32                  `json:"upperBounds"`
}

ArticleStockForecast ArticleStockForecast

type ArticleStockForecastPeriod

type ArticleStockForecastPeriod string

ArticleStockForecastPeriod defines model for ArticleStockForecast.Period.

const (
	ArticleStockForecastPeriodDAILY ArticleStockForecastPeriod = "DAILY"
)

Defines values for ArticleStockForecastPeriod.

func (ArticleStockForecastPeriod) Valid

func (e ArticleStockForecastPeriod) Valid() bool

Valid indicates whether the value is a known member of the ArticleStockForecastPeriod enum.

type AssignFacilityJSONRequestBody

type AssignFacilityJSONRequestBody = UserAssignedFacilityForCreation

AssignFacilityJSONRequestBody defines body for AssignFacility for application/json ContentType.

type AssignFacilityResponse

type AssignFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseAssignFacilityResponse

func ParseAssignFacilityResponse(rsp *http.Response) (*AssignFacilityResponse, error)

ParseAssignFacilityResponse parses an HTTP response from a AssignFacilityWithResponse call

func (AssignFacilityResponse) ContentType

func (r AssignFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AssignFacilityResponse) GetBody added in v0.8.0

func (r AssignFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AssignFacilityResponse) GetJSON401 added in v0.8.0

func (r AssignFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (AssignFacilityResponse) GetJSON403 added in v0.8.0

func (r AssignFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (AssignFacilityResponse) GetJSON404 added in v0.8.0

func (r AssignFacilityResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (AssignFacilityResponse) Status

func (r AssignFacilityResponse) Status() string

Status returns HTTPResponse.Status

func (AssignFacilityResponse) StatusCode

func (r AssignFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AssignedRoles

type AssignedRoles struct {
	// Context The context limitations of the assigned role
	Context *[]ContextLimitation `json:"context,omitempty"`

	// ContextLimitations The context limitations of the assigned role (deprecated)
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ContextLimitations *[]ContextLimitation `json:"contextLimitations,omitempty"`

	// Ref The id of the assigned role
	Ref string `json:"ref"`
}

AssignedRoles AssignedRoles

type AuthenticationProvider

type AuthenticationProvider struct {
	// Id The id of the authentication provider
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *string `json:"id,omitempty"`

	// Type The type of the authentication provider
	Type AuthenticationProviderTypeEnum `json:"type"`
}

AuthenticationProvider AuthenticationProvider

type AuthenticationProviderTypeEnum

type AuthenticationProviderTypeEnum string

AuthenticationProviderTypeEnum The type of the authentication provider

const (
	AuthenticationProviderTypeEnumEMAILPASSWORD AuthenticationProviderTypeEnum = "EMAIL_PASSWORD"
	AuthenticationProviderTypeEnumOIDC          AuthenticationProviderTypeEnum = "OIDC"
	AuthenticationProviderTypeEnumSUPPORTACCESS AuthenticationProviderTypeEnum = "SUPPORT_ACCESS"
)

Defines values for AuthenticationProviderTypeEnum.

func (AuthenticationProviderTypeEnum) Valid

Valid indicates whether the value is a known member of the AuthenticationProviderTypeEnum enum.

type AvailabilityTimeframe

type AvailabilityTimeframe struct {
	// Start Example: 2020-02-03T08:45:50.525Z
	Start *time.Time `json:"start,omitempty"`
}

AvailabilityTimeframe AvailabilityTimeframe

type AvailabilityTimeframe2

type AvailabilityTimeframe2 struct {
	Start string `json:"start"`
}

AvailabilityTimeframe2 AvailabilityTimeframe2

type AvailableUntilCalculationBase

type AvailableUntilCalculationBase string

AvailableUntilCalculationBase The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined "availableUntil" is the result

const (
	AvailableUntilCalculationBaseCREATION AvailableUntilCalculationBase = "CREATION"
	AvailableUntilCalculationBaseEXPIRY   AvailableUntilCalculationBase = "EXPIRY"
)

Defines values for AvailableUntilCalculationBase.

func (AvailableUntilCalculationBase) Valid

Valid indicates whether the value is a known member of the AvailableUntilCalculationBase enum.

type AvailableUntilDefinition

type AvailableUntilDefinition struct {
	// CalculationBase The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined "availableUntil" is the result
	CalculationBase AvailableUntilCalculationBase `json:"calculationBase"`

	// Modifier Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: "-P30D" places the "availableUntil" value 30 days before the calculated date.
	//
	// Example: -P30D
	Modifier *string `json:"modifier,omitempty"`
}

AvailableUntilDefinition AvailableUntilDefinition

type Backordered added in v0.3.0

type Backordered struct {
	LineItems []DeliveryPromiseLineItem `json:"lineItems"`
}

Backordered Backordered

type BasePriceCostDetail added in v0.8.0

type BasePriceCostDetail struct {
	// Amount Money
	Amount Money `json:"amount"`

	// Id Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds
	//
	// Example: 0
	Id string `json:"id"`

	// MatchedThreshold The resolved weight or volume tier
	//
	// Example: 5000
	MatchedThreshold *int64                  `json:"matchedThreshold,omitempty"`
	Type             BasePriceCostDetailType `json:"type"`
}

BasePriceCostDetail The price the tariff charges for the weight or volume tier the goods fell into.

type BasePriceCostDetailType added in v0.8.0

type BasePriceCostDetailType string

BasePriceCostDetailType defines model for BasePriceCostDetail.Type.

const (
	BasePriceCostDetailTypeBASEPRICE BasePriceCostDetailType = "BASE_PRICE"
)

Defines values for BasePriceCostDetailType.

func (BasePriceCostDetailType) Valid added in v0.8.0

func (e BasePriceCostDetailType) Valid() bool

Valid indicates whether the value is a known member of the BasePriceCostDetailType enum.

type BasicDeliveryPromiseShipment added in v0.3.0

type BasicDeliveryPromiseShipment struct {
	// Facility BasicDeliveryPromiseShipmentFacility
	Facility  BasicDeliveryPromiseShipmentFacility `json:"facility"`
	LineItems []DeliveryPromiseLineItem            `json:"lineItems"`
}

BasicDeliveryPromiseShipment BasicDeliveryPromiseShipment

type BasicDeliveryPromiseShipmentFacility added in v0.3.0

type BasicDeliveryPromiseShipmentFacility struct {
	FacilityName     string  `json:"facilityName"`
	FacilityRef      string  `json:"facilityRef"`
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`
}

BasicDeliveryPromiseShipmentFacility BasicDeliveryPromiseShipmentFacility

type BooleanFilter

type BooleanFilter struct {
	Eq    *bool `json:"eq,omitempty"`
	NotEq *bool `json:"notEq,omitempty"`
}

BooleanFilter BooleanFilter

type BulkCancelOrderParameter added in v0.8.0

type BulkCancelOrderParameter struct {
	// CancelationReasonId ID of the cancellation reason
	CancelationReasonId *string `json:"cancelationReasonId,omitempty"`
	OrderId             string  `json:"orderId"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

BulkCancelOrderParameter BulkCancelOrderParameter

type BulkForceCancelOrderParameter added in v0.7.0

type BulkForceCancelOrderParameter struct {
	// CancelationReasonId ID of the cancellation reason
	CancelationReasonId *string `json:"cancelationReasonId,omitempty"`
	OrderId             string  `json:"orderId"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

BulkForceCancelOrderParameter BulkForceCancelOrderParameter

type BulkInvalidatePromiseOrderActionParameter added in v0.8.0

type BulkInvalidatePromiseOrderActionParameter struct {
	Name   BulkInvalidatePromiseOrderActionParameterName `json:"name"`
	Orders []BulkPromiseOrderParameter                   `json:"orders"`
}

BulkInvalidatePromiseOrderActionParameter Action to invalidate promise orders.

type BulkInvalidatePromiseOrderActionParameterName added in v0.8.0

type BulkInvalidatePromiseOrderActionParameterName string

BulkInvalidatePromiseOrderActionParameterName defines model for BulkInvalidatePromiseOrderActionParameter.Name.

const (
	BULKINVALIDATEPROMISE BulkInvalidatePromiseOrderActionParameterName = "BULK_INVALIDATE_PROMISE"
)

Defines values for BulkInvalidatePromiseOrderActionParameterName.

func (BulkInvalidatePromiseOrderActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the BulkInvalidatePromiseOrderActionParameterName enum.

type BulkOperationError

type BulkOperationError struct {
	Message string                 `json:"message"`
	Type    BulkOperationErrorType `json:"type"`
}

BulkOperationError BulkOperationError

type BulkOperationErrorType

type BulkOperationErrorType string

BulkOperationErrorType defines model for BulkOperationError.Type.

const (
	BulkOperationErrorTypeNOTALLOWED BulkOperationErrorType = "NOT_ALLOWED"
	BulkOperationErrorTypeNOTFOUND   BulkOperationErrorType = "NOT_FOUND"
	BulkOperationErrorTypeUNKNOWN    BulkOperationErrorType = "UNKNOWN"
	BulkOperationErrorTypeVALIDATION BulkOperationErrorType = "VALIDATION"
)

Defines values for BulkOperationErrorType.

func (BulkOperationErrorType) Valid

func (e BulkOperationErrorType) Valid() bool

Valid indicates whether the value is a known member of the BulkOperationErrorType enum.

type BulkOperationResultStatus

type BulkOperationResultStatus string

BulkOperationResultStatus BulkOperationResultStatus

const (
	BulkOperationResultStatusCREATED   BulkOperationResultStatus = "CREATED"
	BulkOperationResultStatusFAILED    BulkOperationResultStatus = "FAILED"
	BulkOperationResultStatusUNCHANGED BulkOperationResultStatus = "UNCHANGED"
	BulkOperationResultStatusUPDATED   BulkOperationResultStatus = "UPDATED"
)

Defines values for BulkOperationResultStatus.

func (BulkOperationResultStatus) Valid

func (e BulkOperationResultStatus) Valid() bool

Valid indicates whether the value is a known member of the BulkOperationResultStatus enum.

type BulkOrderActionResult added in v0.7.0

type BulkOrderActionResult struct {
	OrderId string `json:"orderId"`

	// Status BulkOperationResultStatus
	Status  BulkOperationResultStatus `json:"status"`
	Summary *string                   `json:"summary,omitempty"`
}

BulkOrderActionResult BulkOrderActionResult

type BulkOrderActionsParameter added in v0.7.0

type BulkOrderActionsParameter struct {
	// contains filtered or unexported fields
}

BulkOrderActionsParameter BulkOrderActionsParameter

func (BulkOrderActionsParameter) AsBulkInvalidatePromiseOrderActionParameter added in v0.8.0

func (t BulkOrderActionsParameter) AsBulkInvalidatePromiseOrderActionParameter() (BulkInvalidatePromiseOrderActionParameter, error)

AsBulkInvalidatePromiseOrderActionParameter returns the union data inside the BulkOrderActionsParameter as a BulkInvalidatePromiseOrderActionParameter

func (BulkOrderActionsParameter) AsBulkOrderCancelActionParameter added in v0.8.0

func (t BulkOrderActionsParameter) AsBulkOrderCancelActionParameter() (BulkOrderCancelActionParameter, error)

AsBulkOrderCancelActionParameter returns the union data inside the BulkOrderActionsParameter as a BulkOrderCancelActionParameter

func (BulkOrderActionsParameter) AsBulkOrderForceCancelActionParameter added in v0.7.0

func (t BulkOrderActionsParameter) AsBulkOrderForceCancelActionParameter() (BulkOrderForceCancelActionParameter, error)

AsBulkOrderForceCancelActionParameter returns the union data inside the BulkOrderActionsParameter as a BulkOrderForceCancelActionParameter

func (BulkOrderActionsParameter) AsBulkOrderUnlockActionParameter added in v0.8.0

func (t BulkOrderActionsParameter) AsBulkOrderUnlockActionParameter() (BulkOrderUnlockActionParameter, error)

AsBulkOrderUnlockActionParameter returns the union data inside the BulkOrderActionsParameter as a BulkOrderUnlockActionParameter

func (*BulkOrderActionsParameter) FromBulkInvalidatePromiseOrderActionParameter added in v0.8.0

func (t *BulkOrderActionsParameter) FromBulkInvalidatePromiseOrderActionParameter(v BulkInvalidatePromiseOrderActionParameter) error

FromBulkInvalidatePromiseOrderActionParameter overwrites any union data inside the BulkOrderActionsParameter as the provided BulkInvalidatePromiseOrderActionParameter

func (*BulkOrderActionsParameter) FromBulkOrderCancelActionParameter added in v0.8.0

func (t *BulkOrderActionsParameter) FromBulkOrderCancelActionParameter(v BulkOrderCancelActionParameter) error

FromBulkOrderCancelActionParameter overwrites any union data inside the BulkOrderActionsParameter as the provided BulkOrderCancelActionParameter

func (*BulkOrderActionsParameter) FromBulkOrderForceCancelActionParameter added in v0.7.0

func (t *BulkOrderActionsParameter) FromBulkOrderForceCancelActionParameter(v BulkOrderForceCancelActionParameter) error

FromBulkOrderForceCancelActionParameter overwrites any union data inside the BulkOrderActionsParameter as the provided BulkOrderForceCancelActionParameter

func (*BulkOrderActionsParameter) FromBulkOrderUnlockActionParameter added in v0.8.0

func (t *BulkOrderActionsParameter) FromBulkOrderUnlockActionParameter(v BulkOrderUnlockActionParameter) error

FromBulkOrderUnlockActionParameter overwrites any union data inside the BulkOrderActionsParameter as the provided BulkOrderUnlockActionParameter

func (BulkOrderActionsParameter) MarshalJSON added in v0.7.0

func (t BulkOrderActionsParameter) MarshalJSON() ([]byte, error)

func (*BulkOrderActionsParameter) MergeBulkInvalidatePromiseOrderActionParameter added in v0.8.0

func (t *BulkOrderActionsParameter) MergeBulkInvalidatePromiseOrderActionParameter(v BulkInvalidatePromiseOrderActionParameter) error

MergeBulkInvalidatePromiseOrderActionParameter performs a merge with any union data inside the BulkOrderActionsParameter, using the provided BulkInvalidatePromiseOrderActionParameter

func (*BulkOrderActionsParameter) MergeBulkOrderCancelActionParameter added in v0.8.0

func (t *BulkOrderActionsParameter) MergeBulkOrderCancelActionParameter(v BulkOrderCancelActionParameter) error

MergeBulkOrderCancelActionParameter performs a merge with any union data inside the BulkOrderActionsParameter, using the provided BulkOrderCancelActionParameter

func (*BulkOrderActionsParameter) MergeBulkOrderForceCancelActionParameter added in v0.7.0

func (t *BulkOrderActionsParameter) MergeBulkOrderForceCancelActionParameter(v BulkOrderForceCancelActionParameter) error

MergeBulkOrderForceCancelActionParameter performs a merge with any union data inside the BulkOrderActionsParameter, using the provided BulkOrderForceCancelActionParameter

func (*BulkOrderActionsParameter) MergeBulkOrderUnlockActionParameter added in v0.8.0

func (t *BulkOrderActionsParameter) MergeBulkOrderUnlockActionParameter(v BulkOrderUnlockActionParameter) error

MergeBulkOrderUnlockActionParameter performs a merge with any union data inside the BulkOrderActionsParameter, using the provided BulkOrderUnlockActionParameter

func (*BulkOrderActionsParameter) UnmarshalJSON added in v0.7.0

func (t *BulkOrderActionsParameter) UnmarshalJSON(b []byte) error

type BulkOrderCancelActionParameter added in v0.8.0

type BulkOrderCancelActionParameter struct {
	Name   BulkOrderCancelActionParameterName `json:"name"`
	Orders []BulkCancelOrderParameter         `json:"orders"`
}

BulkOrderCancelActionParameter Action to cancel orders.

type BulkOrderCancelActionParameterName added in v0.8.0

type BulkOrderCancelActionParameterName string

BulkOrderCancelActionParameterName defines model for BulkOrderCancelActionParameter.Name.

const (
	BULKCANCEL BulkOrderCancelActionParameterName = "BULK_CANCEL"
)

Defines values for BulkOrderCancelActionParameterName.

func (BulkOrderCancelActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the BulkOrderCancelActionParameterName enum.

type BulkOrderForceCancelActionParameter added in v0.7.0

type BulkOrderForceCancelActionParameter struct {
	Name   BulkOrderForceCancelActionParameterName `json:"name"`
	Orders []BulkForceCancelOrderParameter         `json:"orders"`
}

BulkOrderForceCancelActionParameter Action to force cancel orders.

type BulkOrderForceCancelActionParameterName added in v0.7.0

type BulkOrderForceCancelActionParameterName string

BulkOrderForceCancelActionParameterName defines model for BulkOrderForceCancelActionParameter.Name.

const (
	BULKFORCECANCEL BulkOrderForceCancelActionParameterName = "BULK_FORCE_CANCEL"
)

Defines values for BulkOrderForceCancelActionParameterName.

func (BulkOrderForceCancelActionParameterName) Valid added in v0.7.0

Valid indicates whether the value is a known member of the BulkOrderForceCancelActionParameterName enum.

type BulkOrderUnlockActionParameter added in v0.8.0

type BulkOrderUnlockActionParameter struct {
	Name   BulkOrderUnlockActionParameterName `json:"name"`
	Orders []BulkUnlockOrderParameter         `json:"orders"`
}

BulkOrderUnlockActionParameter Action to unlock orders.

type BulkOrderUnlockActionParameterName added in v0.8.0

type BulkOrderUnlockActionParameterName string

BulkOrderUnlockActionParameterName defines model for BulkOrderUnlockActionParameter.Name.

const (
	BULKUNLOCK BulkOrderUnlockActionParameterName = "BULK_UNLOCK"
)

Defines values for BulkOrderUnlockActionParameterName.

func (BulkOrderUnlockActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the BulkOrderUnlockActionParameterName enum.

type BulkOrdersActionJSONRequestBody added in v0.7.0

type BulkOrdersActionJSONRequestBody = BulkOrderActionsParameter

BulkOrdersActionJSONRequestBody defines body for BulkOrdersAction for application/json ContentType.

type BulkOrdersActionResponse added in v0.7.0

type BulkOrdersActionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]BulkOrderActionResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseBulkOrdersActionResponse added in v0.7.0

func ParseBulkOrdersActionResponse(rsp *http.Response) (*BulkOrdersActionResponse, error)

ParseBulkOrdersActionResponse parses an HTTP response from a BulkOrdersActionWithResponse call

func (BulkOrdersActionResponse) ContentType added in v0.7.0

func (r BulkOrdersActionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BulkOrdersActionResponse) GetBody added in v0.8.0

func (r BulkOrdersActionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BulkOrdersActionResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BulkOrdersActionResponse) GetJSON401 added in v0.8.0

func (r BulkOrdersActionResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (BulkOrdersActionResponse) GetJSON403 added in v0.8.0

func (r BulkOrdersActionResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (BulkOrdersActionResponse) GetJSON404 added in v0.8.0

func (r BulkOrdersActionResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (BulkOrdersActionResponse) Status added in v0.7.0

func (r BulkOrdersActionResponse) Status() string

Status returns HTTPResponse.Status

func (BulkOrdersActionResponse) StatusCode added in v0.7.0

func (r BulkOrdersActionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BulkPromiseOrderParameter added in v0.8.0

type BulkPromiseOrderParameter struct {
	OrderId string `json:"orderId"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

BulkPromiseOrderParameter BulkPromiseOrderParameter

type BulkUnlockOrderParameter added in v0.8.0

type BulkUnlockOrderParameter struct {
	OrderId string `json:"orderId"`

	// TargetTime Time to be set as a targetTime for the delivery preferences.
	//
	// Example: 2025-01-15T00:00:00.000Z
	TargetTime *time.Time `json:"targetTime,omitempty"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

BulkUnlockOrderParameter BulkUnlockOrderParameter

type BulkUpdateSafetyStockJSONRequestBody

type BulkUpdateSafetyStockJSONRequestBody = SafetyStockBulkOperations

BulkUpdateSafetyStockJSONRequestBody defines body for BulkUpdateSafetyStock for application/json ContentType.

type BulkUpdateSafetyStockResponse

type BulkUpdateSafetyStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON207 the response for an HTTP 207 `application/json` response
	JSON207 *SafetyStockBulkOperationResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseBulkUpdateSafetyStockResponse

func ParseBulkUpdateSafetyStockResponse(rsp *http.Response) (*BulkUpdateSafetyStockResponse, error)

ParseBulkUpdateSafetyStockResponse parses an HTTP response from a BulkUpdateSafetyStockWithResponse call

func (BulkUpdateSafetyStockResponse) ContentType

func (r BulkUpdateSafetyStockResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BulkUpdateSafetyStockResponse) GetBody added in v0.8.0

func (r BulkUpdateSafetyStockResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BulkUpdateSafetyStockResponse) GetJSON207 added in v0.8.0

GetJSON207 returns the response for an HTTP 207 `application/json` response

func (BulkUpdateSafetyStockResponse) GetJSON401 added in v0.8.0

func (r BulkUpdateSafetyStockResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (BulkUpdateSafetyStockResponse) GetJSON403 added in v0.8.0

func (r BulkUpdateSafetyStockResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (BulkUpdateSafetyStockResponse) Status

Status returns HTTPResponse.Status

func (BulkUpdateSafetyStockResponse) StatusCode

func (r BulkUpdateSafetyStockResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BulkUpsertListingsJSONRequestBody

type BulkUpsertListingsJSONRequestBody = ListingBulkUpsertPayload

BulkUpsertListingsJSONRequestBody defines body for BulkUpsertListings for application/json ContentType.

type BulkUpsertListingsResponse

type BulkUpsertListingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ListingBulkUpsertResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ApiError
}

func ParseBulkUpsertListingsResponse

func ParseBulkUpsertListingsResponse(rsp *http.Response) (*BulkUpsertListingsResponse, error)

ParseBulkUpsertListingsResponse parses an HTTP response from a BulkUpsertListingsWithResponse call

func (BulkUpsertListingsResponse) ContentType

func (r BulkUpsertListingsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BulkUpsertListingsResponse) GetBody added in v0.8.0

func (r BulkUpsertListingsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BulkUpsertListingsResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BulkUpsertListingsResponse) GetJSON400 added in v0.8.0

func (r BulkUpsertListingsResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (BulkUpsertListingsResponse) GetJSON401 added in v0.8.0

func (r BulkUpsertListingsResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (BulkUpsertListingsResponse) GetJSON403 added in v0.8.0

func (r BulkUpsertListingsResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (BulkUpsertListingsResponse) GetJSON404 added in v0.8.0

func (r BulkUpsertListingsResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (BulkUpsertListingsResponse) GetJSON409 added in v0.8.0

func (r BulkUpsertListingsResponse) GetJSON409() *ApiError

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (BulkUpsertListingsResponse) Status

Status returns HTTPResponse.Status

func (BulkUpsertListingsResponse) StatusCode

func (r BulkUpsertListingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BulkUpsertSummary

type BulkUpsertSummary struct {
	// Created The number of operations that led to an insertion
	Created float32 `json:"created"`

	// Unchanged The number of operations that led to no change
	Unchanged float32 `json:"unchanged"`

	// Updated The number of operations that led to an update
	//
	// Example: 2026-06-17T12:00:00.000Z
	Updated float32 `json:"updated"`
}

BulkUpsertSummary BulkUpsertSummary

type ByTrait

type ByTrait struct {
	ACCESSIBLE float32 `json:"ACCESSIBLE"`
	PICKABLE   float32 `json:"PICKABLE"`
}

ByTrait ByTrait

type CalculateBestCarrierJSONRequestBody

type CalculateBestCarrierJSONRequestBody = CarrierPriorityCalculationRequest

CalculateBestCarrierJSONRequestBody defines body for CalculateBestCarrier for application/json ContentType.

type CalculateBestCarrierResponse

type CalculateBestCarrierResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *CarrierPriorityResult
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseCalculateBestCarrierResponse

func ParseCalculateBestCarrierResponse(rsp *http.Response) (*CalculateBestCarrierResponse, error)

ParseCalculateBestCarrierResponse parses an HTTP response from a CalculateBestCarrierWithResponse call

func (CalculateBestCarrierResponse) ContentType

func (r CalculateBestCarrierResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CalculateBestCarrierResponse) GetBody added in v0.8.0

func (r CalculateBestCarrierResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CalculateBestCarrierResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CalculateBestCarrierResponse) GetJSON400 added in v0.8.0

func (r CalculateBestCarrierResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CalculateBestCarrierResponse) GetJSON401 added in v0.8.0

func (r CalculateBestCarrierResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CalculateBestCarrierResponse) GetJSON403 added in v0.8.0

func (r CalculateBestCarrierResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CalculateBestCarrierResponse) Status

Status returns HTTPResponse.Status

func (CalculateBestCarrierResponse) StatusCode

func (r CalculateBestCarrierResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CancelationReason added in v0.3.0

type CancelationReason struct {
	Action CancelationReasonAction `json:"action"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Reason Text explaining the reason for a supported action.
	//
	// Example: Rerouted because of an issue in the Facility.
	Reason string `json:"reason"`

	// ReasonLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	ReasonLocalized LocaleString `json:"reasonLocalized"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

CancelationReason CancelationReason

type CancelationReasonAction added in v0.8.0

type CancelationReasonAction string

CancelationReasonAction defines model for CancelationReason.Action.

const (
	CANCELATION CancelationReasonAction = "CANCELATION"
)

Defines values for CancelationReasonAction.

func (CancelationReasonAction) Valid added in v0.8.0

func (e CancelationReasonAction) Valid() bool

Valid indicates whether the value is a known member of the CancelationReasonAction enum.

type Carrier

type Carrier struct {
	// Created The date this entity was created at the platform. This value is generated by the service.
	Created *time.Time `json:"created,omitempty"`

	// Credentials Credentials for the carrier
	Credentials *AbstractCarrierCredentials `json:"credentials,omitempty"`

	// DefaultParcelHeightInCm Default height in cm
	//
	// Example: 10
	DefaultParcelHeightInCm float32 `json:"defaultParcelHeightInCm"`

	// DefaultParcelLengthInCm Default length in cm
	//
	// Example: 25
	DefaultParcelLengthInCm float32 `json:"defaultParcelLengthInCm"`

	// DefaultParcelWeightInGram Default weight for a parcel in gram
	//
	// Example: 1000
	DefaultParcelWeightInGram *float32 `json:"defaultParcelWeightInGram,omitempty"`

	// DefaultParcelWidthInCm Default width in cm
	//
	// Example: 35
	DefaultParcelWidthInCm float32 `json:"defaultParcelWidthInCm"`

	// DeliveryType Provided delivery of this CEP. Default: DELIVERY
	DeliveryType *CarrierDeliveryType `json:"deliveryType,omitempty"`

	// Id The id of the carrier
	//
	// Example: LGMl2DuvPnfPoSHhYFOm
	Id string `json:"id"`

	// Key References the KEP. Currently allowed values are DHL_V2, DPD_CH, DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.
	//
	// Example: DHL_V2
	Key string `json:"key"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Lifecycle Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet. Default: GA
	Lifecycle *CarrierLifecycle `json:"lifecycle,omitempty"`

	// LogoUrl URL of the carrier logo
	//
	// Example: https://example.com/resource
	LogoUrl *string `json:"logoUrl,omitempty"`

	// Name This is the well known name for a supported CEP partner. Can be adapted to the clients needs.
	//
	// Example: DHL Köln
	Name string `json:"name"`

	// ParcelLabelClassifications Parcel label classifications for this carrier
	ParcelLabelClassifications *[]ParcelLabelClassification `json:"parcelLabelClassifications,omitempty"`

	// ProductValueNeeded Setting to enable the Client to ask for the parcel product value while ordering a label. This information is mandatory for sending parcels between different countries (customs declaration)
	//
	// Example: true
	ProductValueNeeded *bool `json:"productValueNeeded,omitempty"`

	// Status It is taken into consideration for all carriers. Default: INACTIVE
	Status *CarrierStatus `json:"status,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int `json:"version"`
}

Carrier Carrier

type CarrierCutoffConfiguration

type CarrierCutoffConfiguration struct {
	Capacity *float32 `json:"capacity,omitempty"`

	// Time Example: 12:00
	Time string `json:"time"`
}

CarrierCutoffConfiguration CarrierCutoffConfiguration

type CarrierCutoffTimes

type CarrierCutoffTimes struct {
	Overwrites []CarrierCutoffTimesOverwrite `json:"overwrites"`
	Weekdays   []CarrierCutoffTimesWeekDay   `json:"weekdays"`
}

CarrierCutoffTimes CarrierCutoffTimes

type CarrierCutoffTimesOverwrite

type CarrierCutoffTimesOverwrite struct {
	CutoffConfigurations []CarrierCutoffConfiguration `json:"cutoffConfigurations"`

	// Date Example: 2020-02-03T00:00:00.000Z
	Date openapi_types.Date `json:"date"`
}

CarrierCutoffTimesOverwrite CarrierCutoffTimesOverwrite

type CarrierCutoffTimesWeekDay

type CarrierCutoffTimesWeekDay struct {
	CutoffConfigurations []CarrierCutoffConfiguration `json:"cutoffConfigurations"`

	// Day A weekday
	Day WeekDay `json:"day"`
}

CarrierCutoffTimesWeekDay CarrierCutoffTimesWeekDay

type CarrierDeliveryType

type CarrierDeliveryType string

CarrierDeliveryType Provided delivery of this CEP. Default: DELIVERY

const (
	CarrierDeliveryTypeDELIVERY CarrierDeliveryType = "DELIVERY"
	CarrierDeliveryTypeSAMEDAY  CarrierDeliveryType = "SAMEDAY"
)

Defines values for CarrierDeliveryType.

func (CarrierDeliveryType) Valid

func (e CarrierDeliveryType) Valid() bool

Valid indicates whether the value is a known member of the CarrierDeliveryType enum.

type CarrierLifecycle

type CarrierLifecycle string

CarrierLifecycle Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet. Default: GA

const (
	CarrierLifecycleALPHA CarrierLifecycle = "ALPHA"
	CarrierLifecycleBETA  CarrierLifecycle = "BETA"
	CarrierLifecycleGA    CarrierLifecycle = "GA"
)

Defines values for CarrierLifecycle.

func (CarrierLifecycle) Valid

func (e CarrierLifecycle) Valid() bool

Valid indicates whether the value is a known member of the CarrierLifecycle enum.

type CarrierPriorityCalculationRequest

type CarrierPriorityCalculationRequest struct {
	// ProductValue ParcelProductValue
	ProductValue *ParcelProductValue `json:"productValue,omitempty"`
}

CarrierPriorityCalculationRequest CarrierPriorityCalculationRequest

type CarrierPriorityResult

type CarrierPriorityResult struct {
	// OtherCarriers Other eligible carriers ordered by priority
	OtherCarriers []CarrierRecommendationResult `json:"otherCarriers"`

	// RecommendedCarriers Recommended carriers ordered by priority (best first)
	RecommendedCarriers []CarrierRecommendationResult `json:"recommendedCarriers"`
}

CarrierPriorityResult CarrierPriorityResult

type CarrierProductCategory added in v0.2.0

type CarrierProductCategory string

CarrierProductCategory CarrierProductCategory

const (
	CarrierProductCategoryEXPRESS    CarrierProductCategory = "EXPRESS"
	CarrierProductCategoryFORWARDING CarrierProductCategory = "FORWARDING"
	CarrierProductCategorySTANDARD   CarrierProductCategory = "STANDARD"
	CarrierProductCategoryVALUE      CarrierProductCategory = "VALUE"
)

Defines values for CarrierProductCategory.

func (CarrierProductCategory) Valid added in v0.2.0

func (e CarrierProductCategory) Valid() bool

Valid indicates whether the value is a known member of the CarrierProductCategory enum.

type CarrierRecommendationResult

type CarrierRecommendationResult struct {
	// Carrier Carrier
	Carrier Carrier `json:"carrier"`

	// Priority Calculated priority value (lower typically indicates a better match)
	//
	// Example: 42
	Priority float32 `json:"priority"`

	// Threshold PriceRange
	Threshold *PriceRange `json:"threshold,omitempty"`
}

CarrierRecommendationResult CarrierRecommendationResult

type CarrierServices added in v0.2.0

type CarrierServices string

CarrierServices CarrierServices

const (
	ADDITIONALTRANSPORTATIONINSURANCE CarrierServices = "ADDITIONAL_TRANSPORTATION_INSURANCE"
	ADULTSIGNATURE                    CarrierServices = "ADULT_SIGNATURE"
	CUSTOMERSIGNATURE                 CarrierServices = "CUSTOMER_SIGNATURE"
	HANDOVERTORECIPIENTONLY           CarrierServices = "HANDOVER_TO_RECIPIENT_ONLY"
	IDENTITYAGECHECK18                CarrierServices = "IDENTITY_AGE_CHECK_18"
	IDENTITYCHECKCOMPANY              CarrierServices = "IDENTITY_CHECK_COMPANY"
	IDENTITYCHECKPRIVATE              CarrierServices = "IDENTITY_CHECK_PRIVATE"
	NONEIGHBORDELIVERY                CarrierServices = "NO_NEIGHBOR_DELIVERY"
	SATURDAYDELIVERY                  CarrierServices = "SATURDAY_DELIVERY"
	SIGNATURE                         CarrierServices = "SIGNATURE"
)

Defines values for CarrierServices.

func (CarrierServices) Valid added in v0.2.0

func (e CarrierServices) Valid() bool

Valid indicates whether the value is a known member of the CarrierServices enum.

type CarrierStatus

type CarrierStatus string

CarrierStatus It is taken into consideration for all carriers. Default: INACTIVE

const (
	CarrierStatusACTIVE   CarrierStatus = "ACTIVE"
	CarrierStatusINACTIVE CarrierStatus = "INACTIVE"
)

Defines values for CarrierStatus.

func (CarrierStatus) Valid

func (e CarrierStatus) Valid() bool

Valid indicates whether the value is a known member of the CarrierStatus enum.

type CarrierTransitTime

type CarrierTransitTime struct {
	// MaxTransitDays Maximum days a carrier needs for transit
	//
	// Example: 3
	MaxTransitDays float32 `json:"maxTransitDays"`

	// MinTransitDays Minimum days a carrier needs for transit
	//
	// Example: 1
	MinTransitDays float32 `json:"minTransitDays"`
}

CarrierTransitTime CarrierTransitTime

type CategorySearchQuery

type CategorySearchQuery struct {
	And *[]CategorySearchQuery `json:"and,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]CategorySearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Name Search by name
	Name *LocalizedStringSearchFilter `json:"name,omitempty"`

	// NameLocalized Search by nameLocalized
	NameLocalized *map[string]CategorySearchQuery_NameLocalized_AdditionalProperties `json:"nameLocalized,omitempty"`
	Or            *[]CategorySearchQuery                                             `json:"or,omitempty"`

	// TenantCategoryId Search by tenantCategoryId
	//
	// Example: MY_CATEGORY_ID
	TenantCategoryId *StringSearchFilter `json:"tenantCategoryId,omitempty"`
}

CategorySearchQuery CategorySearchQuery

type CategorySearchQuery_CustomAttributes_AdditionalProperties

type CategorySearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

CategorySearchQuery_CustomAttributes_AdditionalProperties defines model for CategorySearchQuery.customAttributes.AdditionalProperties.

func (CategorySearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (CategorySearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (CategorySearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (CategorySearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*CategorySearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*CategorySearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*CategorySearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*CategorySearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (CategorySearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*CategorySearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*CategorySearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*CategorySearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*CategorySearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the CategorySearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*CategorySearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type CategorySearchQuery_NameLocalized_AdditionalProperties

type CategorySearchQuery_NameLocalized_AdditionalProperties struct {
	// contains filtered or unexported fields
}

CategorySearchQuery_NameLocalized_AdditionalProperties defines model for CategorySearchQuery.nameLocalized.AdditionalProperties.

func (CategorySearchQuery_NameLocalized_AdditionalProperties) AsKeyExistsFilter

AsKeyExistsFilter returns the union data inside the CategorySearchQuery_NameLocalized_AdditionalProperties as a KeyExistsFilter

func (CategorySearchQuery_NameLocalized_AdditionalProperties) AsStringFilter

AsStringFilter returns the union data inside the CategorySearchQuery_NameLocalized_AdditionalProperties as a StringFilter

func (*CategorySearchQuery_NameLocalized_AdditionalProperties) FromKeyExistsFilter

FromKeyExistsFilter overwrites any union data inside the CategorySearchQuery_NameLocalized_AdditionalProperties as the provided KeyExistsFilter

func (*CategorySearchQuery_NameLocalized_AdditionalProperties) FromStringFilter

FromStringFilter overwrites any union data inside the CategorySearchQuery_NameLocalized_AdditionalProperties as the provided StringFilter

func (CategorySearchQuery_NameLocalized_AdditionalProperties) MarshalJSON

func (*CategorySearchQuery_NameLocalized_AdditionalProperties) MergeKeyExistsFilter

MergeKeyExistsFilter performs a merge with any union data inside the CategorySearchQuery_NameLocalized_AdditionalProperties, using the provided KeyExistsFilter

func (*CategorySearchQuery_NameLocalized_AdditionalProperties) MergeStringFilter

MergeStringFilter performs a merge with any union data inside the CategorySearchQuery_NameLocalized_AdditionalProperties, using the provided StringFilter

func (*CategorySearchQuery_NameLocalized_AdditionalProperties) UnmarshalJSON

type ChangeUserJSONRequestBody

type ChangeUserJSONRequestBody = UserPatchActions

ChangeUserJSONRequestBody defines body for ChangeUser for application/json ContentType.

type ChangeUserResponse

type ChangeUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *User
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseChangeUserResponse

func ParseChangeUserResponse(rsp *http.Response) (*ChangeUserResponse, error)

ParseChangeUserResponse parses an HTTP response from a ChangeUserWithResponse call

func (ChangeUserResponse) ContentType

func (r ChangeUserResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ChangeUserResponse) GetBody added in v0.8.0

func (r ChangeUserResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ChangeUserResponse) GetJSON200 added in v0.8.0

func (r ChangeUserResponse) GetJSON200() *User

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ChangeUserResponse) GetJSON401 added in v0.8.0

func (r ChangeUserResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ChangeUserResponse) GetJSON403 added in v0.8.0

func (r ChangeUserResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ChangeUserResponse) GetJSON404 added in v0.8.0

func (r ChangeUserResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ChangeUserResponse) Status

func (r ChangeUserResponse) Status() string

Status returns HTTPResponse.Status

func (ChangeUserResponse) StatusCode

func (r ChangeUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ChannelStockAvailability

type ChannelStockAvailability struct {
	AvailableForPicking float32 `json:"availableForPicking"`
	AvailableOnStock    float32 `json:"availableOnStock"`
	ChannelRef          string  `json:"channelRef"`
}

ChannelStockAvailability ChannelStockAvailability

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) ActionsRoutingStrategy added in v0.6.0

func (c *Client) ActionsRoutingStrategy(ctx context.Context, strategyId string, body ActionsRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ActionsRoutingStrategy Call routing strategy action

Performs an action on a routing strategy.

Takes a body of the `application/json` content type.

Corresponds with POST /api/routing/strategies/{strategyId}/actions (the `ActionsRoutingStrategy` operationId).

func (*Client) ActionsRoutingStrategyWithBody added in v0.6.0

func (c *Client) ActionsRoutingStrategyWithBody(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ActionsRoutingStrategyWithBody Call routing strategy action

Performs an action on a routing strategy.

Takes any type of body and a specified content type.

Corresponds with POST /api/routing/strategies/{strategyId}/actions (the `ActionsRoutingStrategy` operationId).

func (*Client) AddDiscountToFacility

func (c *Client) AddDiscountToFacility(ctx context.Context, facilityRef string, body AddDiscountToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AddDiscountToFacility Create facility discount

Takes a body of the `application/json` content type.

Corresponds with POST /api/facilities/{facilityRef}/discounts (the `AddDiscountToFacility` operationId).

func (*Client) AddDiscountToFacilityWithBody

func (c *Client) AddDiscountToFacilityWithBody(ctx context.Context, facilityRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AddDiscountToFacilityWithBody Create facility discount

Takes any type of body and a specified content type.

Corresponds with POST /api/facilities/{facilityRef}/discounts (the `AddDiscountToFacility` operationId).

func (*Client) AddFacility

func (c *Client) AddFacility(ctx context.Context, body AddFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AddFacility Create facility

Takes a body of the `application/json` content type.

Corresponds with POST /api/facilities (the `AddFacility` operationId).

func (*Client) AddFacilityWithBody

func (c *Client) AddFacilityWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AddFacilityWithBody Create facility

Takes any type of body and a specified content type.

Corresponds with POST /api/facilities (the `AddFacility` operationId).

func (*Client) AddOrder added in v0.3.0

func (c *Client) AddOrder(ctx context.Context, body AddOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AddOrder Create order

Create a new order.

Takes a body of the `application/json` content type.

Corresponds with POST /api/orders (the `AddOrder` operationId).

func (*Client) AddOrderWithBody added in v0.3.0

func (c *Client) AddOrderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AddOrderWithBody Create order

Create a new order.

Takes any type of body and a specified content type.

Corresponds with POST /api/orders (the `AddOrder` operationId).

func (*Client) AssignFacility

func (c *Client) AssignFacility(ctx context.Context, userId string, body AssignFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AssignFacility Create facility assignment

Takes a body of the `application/json` content type.

Corresponds with POST /api/users/{userId}/assignedFacilities (the `AssignFacility` operationId).

func (*Client) AssignFacilityWithBody

func (c *Client) AssignFacilityWithBody(ctx context.Context, userId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AssignFacilityWithBody Create facility assignment

Takes any type of body and a specified content type.

Corresponds with POST /api/users/{userId}/assignedFacilities (the `AssignFacility` operationId).

func (*Client) BulkOrdersAction added in v0.7.0

func (c *Client) BulkOrdersAction(ctx context.Context, body BulkOrdersActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

BulkOrdersAction Call bulk orders action

Bulk action of orders.

Takes a body of the `application/json` content type.

Corresponds with POST /api/orders/actions (the `BulkOrdersAction` operationId).

func (*Client) BulkOrdersActionWithBody added in v0.7.0

func (c *Client) BulkOrdersActionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

BulkOrdersActionWithBody Call bulk orders action

Bulk action of orders.

Takes any type of body and a specified content type.

Corresponds with POST /api/orders/actions (the `BulkOrdersAction` operationId).

func (*Client) BulkUpdateSafetyStock

func (c *Client) BulkUpdateSafetyStock(ctx context.Context, body BulkUpdateSafetyStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

BulkUpdateSafetyStock Update safety stocks

Takes a body of the `application/json` content type.

Corresponds with PUT /api/safetystocks (the `BulkUpdateSafetyStock` operationId).

func (*Client) BulkUpdateSafetyStockWithBody

func (c *Client) BulkUpdateSafetyStockWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

BulkUpdateSafetyStockWithBody Update safety stocks

Takes any type of body and a specified content type.

Corresponds with PUT /api/safetystocks (the `BulkUpdateSafetyStock` operationId).

func (*Client) BulkUpsertListings

func (c *Client) BulkUpsertListings(ctx context.Context, body BulkUpsertListingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

BulkUpsertListings Create and update listings

Bulk upsert listings independently of their facility.

Takes a body of the `application/json` content type.

Corresponds with PUT /api/listings (the `BulkUpsertListings` operationId).

func (*Client) BulkUpsertListingsWithBody

func (c *Client) BulkUpsertListingsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

BulkUpsertListingsWithBody Create and update listings

Bulk upsert listings independently of their facility.

Takes any type of body and a specified content type.

Corresponds with PUT /api/listings (the `BulkUpsertListings` operationId).

func (*Client) CalculateBestCarrier

func (c *Client) CalculateBestCarrier(ctx context.Context, facilityId string, body CalculateBestCarrierJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CalculateBestCarrier Calculate best carriers

Calculate prioritized list of recommended carriers for the given facility and input parameters.

Takes a body of the `application/json` content type.

Corresponds with POST /api/facilities/{facilityId}/carriers/prioritization (the `CalculateBestCarrier` operationId).

func (*Client) CalculateBestCarrierWithBody

func (c *Client) CalculateBestCarrierWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CalculateBestCarrierWithBody Calculate best carriers

Calculate prioritized list of recommended carriers for the given facility and input parameters.

Takes any type of body and a specified content type.

Corresponds with POST /api/facilities/{facilityId}/carriers/prioritization (the `CalculateBestCarrier` operationId).

func (*Client) ChangeUser

func (c *Client) ChangeUser(ctx context.Context, userId string, body ChangeUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ChangeUser Update user

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/users/{userId} (the `ChangeUser` operationId).

func (*Client) ChangeUserWithBody

func (c *Client) ChangeUserWithBody(ctx context.Context, userId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ChangeUserWithBody Update user

Takes any type of body and a specified content type.

Corresponds with PATCH /api/users/{userId} (the `ChangeUser` operationId).

func (*Client) ConnectCarrierToFacility

func (c *Client) ConnectCarrierToFacility(ctx context.Context, facilityId string, carrierRef string, body ConnectCarrierToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ConnectCarrierToFacility Update facility carrier connection

Connect a configured carrier to the facility with given ID.

Takes a body of the `application/json` content type.

Corresponds with PUT /api/facilities/{facilityId}/carriers/{carrierRef} (the `ConnectCarrierToFacility` operationId).

func (*Client) ConnectCarrierToFacilityWithBody

func (c *Client) ConnectCarrierToFacilityWithBody(ctx context.Context, facilityId string, carrierRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ConnectCarrierToFacilityWithBody Update facility carrier connection

Connect a configured carrier to the facility with given ID.

Takes any type of body and a specified content type.

Corresponds with PUT /api/facilities/{facilityId}/carriers/{carrierRef} (the `ConnectCarrierToFacility` operationId).

func (*Client) CreateCarrierToFacility

func (c *Client) CreateCarrierToFacility(ctx context.Context, facilityId string, carrierRef string, body CreateCarrierToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateCarrierToFacility Create facility carrier connection

Create a connection of a configured carrier to the facility with given ID.

Takes a body of the `application/json` content type.

Corresponds with POST /api/facilities/{facilityId}/carriers/{carrierRef} (the `CreateCarrierToFacility` operationId).

func (*Client) CreateCarrierToFacilityWithBody

func (c *Client) CreateCarrierToFacilityWithBody(ctx context.Context, facilityId string, carrierRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateCarrierToFacilityWithBody Create facility carrier connection

Create a connection of a configured carrier to the facility with given ID.

Takes any type of body and a specified content type.

Corresponds with POST /api/facilities/{facilityId}/carriers/{carrierRef} (the `CreateCarrierToFacility` operationId).

func (*Client) CreateConnectionToFacility

func (c *Client) CreateConnectionToFacility(ctx context.Context, facilityId string, body CreateConnectionToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateConnectionToFacility Create facility connection

Create a connections for a supplier facility with given ID.

Takes a body of the `application/json` content type.

Corresponds with POST /api/facilities/{facilityId}/connections (the `CreateConnectionToFacility` operationId).

func (*Client) CreateConnectionToFacilityWithBody

func (c *Client) CreateConnectionToFacilityWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateConnectionToFacilityWithBody Create facility connection

Create a connections for a supplier facility with given ID.

Takes any type of body and a specified content type.

Corresponds with POST /api/facilities/{facilityId}/connections (the `CreateConnectionToFacility` operationId).

func (*Client) CreateRole

func (c *Client) CreateRole(ctx context.Context, body CreateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateRole Create role

Creates a new custom role.

Takes a body of the `application/json` content type.

Corresponds with POST /api/roles (the `CreateRole` operationId).

func (*Client) CreateRoleWithBody

func (c *Client) CreateRoleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateRoleWithBody Create role

Creates a new custom role.

Takes any type of body and a specified content type.

Corresponds with POST /api/roles (the `CreateRole` operationId).

func (*Client) CreateSourcingOptionsRequest added in v0.2.0

func (c *Client) CreateSourcingOptionsRequest(ctx context.Context, body CreateSourcingOptionsRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateSourcingOptionsRequest Create sourcing option

Takes a body of the `application/json` content type.

Corresponds with POST /api/routing/sourcingoptions (the `CreateSourcingOptionsRequest` operationId).

func (*Client) CreateSourcingOptionsRequestWithBody added in v0.2.0

func (c *Client) CreateSourcingOptionsRequestWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateSourcingOptionsRequestWithBody Create sourcing option

Takes any type of body and a specified content type.

Corresponds with POST /api/routing/sourcingoptions (the `CreateSourcingOptionsRequest` operationId).

func (*Client) CreateStock

func (c *Client) CreateStock(ctx context.Context, body CreateStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateStock Create stock

Takes a body of the `application/json` content type.

Corresponds with POST /api/stocks (the `CreateStock` operationId).

func (*Client) CreateStockWithBody

func (c *Client) CreateStockWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateStockWithBody Create stock

Takes any type of body and a specified content type.

Corresponds with POST /api/stocks (the `CreateStock` operationId).

func (*Client) CreateUser

func (c *Client) CreateUser(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateUser Creates user

Takes a body of the `application/json` content type.

Corresponds with POST /api/users (the `CreateUser` operationId).

func (*Client) CreateUserWithBody

func (c *Client) CreateUserWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateUserWithBody Creates user

Takes any type of body and a specified content type.

Corresponds with POST /api/users (the `CreateUser` operationId).

func (*Client) DeleteDiscountForFacility

func (c *Client) DeleteDiscountForFacility(ctx context.Context, facilityRef string, facilityDiscountRef string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteDiscountForFacility Delete facility discount

Corresponds with DELETE /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `DeleteDiscountForFacility` operationId).

func (*Client) DeleteFacility

func (c *Client) DeleteFacility(ctx context.Context, facilityId string, params *DeleteFacilityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteFacility Delete facility

Corresponds with DELETE /api/facilities/{facilityId} (the `DeleteFacility` operationId).

func (*Client) DeleteFacilityConnection

func (c *Client) DeleteFacilityConnection(ctx context.Context, facilityId string, connectionId string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteFacilityConnection Delete facility connection

Delete the connection for facility with the given ID.

Corresponds with DELETE /api/facilities/{facilityId}/connections/{connectionId} (the `DeleteFacilityConnection` operationId).

func (*Client) DeleteFacilityListing

func (c *Client) DeleteFacilityListing(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteFacilityListing Delete listing

Corresponds with DELETE /api/facilities/{facilityId}/listings/{tenantArticleId} (the `DeleteFacilityListing` operationId).

func (*Client) DeleteFacilityListingPartialStock

func (c *Client) DeleteFacilityListingPartialStock(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteFacilityListingPartialStock Delete listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.

Corresponds with DELETE /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `DeleteFacilityListingPartialStock` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) DeleteListingsOfFacility

func (c *Client) DeleteListingsOfFacility(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteListingsOfFacility Delete listings

Corresponds with DELETE /api/facilities/{facilityId}/listings (the `DeleteListingsOfFacility` operationId).

func (*Client) DeleteRole

func (c *Client) DeleteRole(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteRole Delete role

Deletes an existing role.

Corresponds with DELETE /api/roles/{name} (the `DeleteRole` operationId).

func (*Client) DeleteRoutingStrategyNodeConfigCategory added in v0.6.0

func (c *Client) DeleteRoutingStrategyNodeConfigCategory(ctx context.Context, categoryId string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteRoutingStrategyNodeConfigCategory Delete category node configuration

Deletes the category.

Corresponds with DELETE /api/routing/nodeconfigcategories/{categoryId} (the `DeleteRoutingStrategyNodeConfigCategory` operationId).

func (*Client) DeleteSafetyStock

func (c *Client) DeleteSafetyStock(ctx context.Context, safetyStockId string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteSafetyStock Delete safety stock

Corresponds with DELETE /api/safetystocks/{safetyStockId} (the `DeleteSafetyStock` operationId).

func (*Client) DeleteStock

func (c *Client) DeleteStock(ctx context.Context, stockId string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteStock Delete stock

Corresponds with DELETE /api/stocks/{stockId} (the `DeleteStock` operationId).

func (*Client) DeleteUser

func (c *Client) DeleteUser(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteUser Delete user

Corresponds with DELETE /api/users/{userId} (the `DeleteUser` operationId).

func (*Client) EvaluateRoutingStrategy added in v0.6.0

func (c *Client) EvaluateRoutingStrategy(ctx context.Context, strategyId string, body EvaluateRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

EvaluateRoutingStrategy Evaluate routing strategy

Evaluates a routing strategy against a given order.

Takes a body of the `application/json` content type.

Corresponds with POST /api/routing/strategies/{strategyId}/evaluation (the `EvaluateRoutingStrategy` operationId).

func (*Client) EvaluateRoutingStrategyNode added in v0.6.0

func (c *Client) EvaluateRoutingStrategyNode(ctx context.Context, strategyId string, nodeId string, reqEditors ...RequestEditorFn) (*http.Response, error)

EvaluateRoutingStrategyNode Evaluate routing strategy node

Evaluates a routing strategy node and return the path.

Corresponds with POST /api/routing/strategies/{strategyId}/nodes/{nodeId}/evaluation (the `EvaluateRoutingStrategyNode` operationId).

func (*Client) EvaluateRoutingStrategyWithBody added in v0.6.0

func (c *Client) EvaluateRoutingStrategyWithBody(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

EvaluateRoutingStrategyWithBody Evaluate routing strategy

Evaluates a routing strategy against a given order.

Takes any type of body and a specified content type.

Corresponds with POST /api/routing/strategies/{strategyId}/evaluation (the `EvaluateRoutingStrategy` operationId).

func (*Client) ExecuteMeAction

func (c *Client) ExecuteMeAction(ctx context.Context, body ExecuteMeActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ExecuteMeAction Call user action

Executes an action to manipulate my user.

Takes a body of the `application/json` content type.

Corresponds with POST /api/users/me/actions (the `ExecuteMeAction` operationId).

func (*Client) ExecuteMeActionWithBody

func (c *Client) ExecuteMeActionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ExecuteMeActionWithBody Call user action

Executes an action to manipulate my user.

Takes any type of body and a specified content type.

Corresponds with POST /api/users/me/actions (the `ExecuteMeAction` operationId).

func (*Client) FacilityAction

func (c *Client) FacilityAction(ctx context.Context, facilityId string, body FacilityActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

FacilityAction Call facility action

Takes a body of the `application/json` content type.

Corresponds with POST /api/facilities/{facilityId}/actions (the `FacilityAction` operationId).

func (*Client) FacilityActionWithBody

func (c *Client) FacilityActionWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

FacilityActionWithBody Call facility action

Takes any type of body and a specified content type.

Corresponds with POST /api/facilities/{facilityId}/actions (the `FacilityAction` operationId).

func (*Client) GetAllFacilities

func (c *Client) GetAllFacilities(ctx context.Context, params *GetAllFacilitiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetAllFacilities List facilities

Corresponds with GET /api/facilities (the `GetAllFacilities` operationId).

func (*Client) GetAllOrders added in v0.3.0

func (c *Client) GetAllOrders(ctx context.Context, params *GetAllOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetAllOrders List orders

List orders with optional filtering by tenant order ID or consumer ID.

Corresponds with GET /api/orders (the `GetAllOrders` operationId).

func (*Client) GetAllRoles

func (c *Client) GetAllRoles(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetAllRoles List roles

Returns all existing roles, including their permissions and context ceilings.

Corresponds with GET /api/roles (the `GetAllRoles` operationId).

func (*Client) GetAllUsers

func (c *Client) GetAllUsers(ctx context.Context, params *GetAllUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetAllUsers List users

Corresponds with GET /api/users (the `GetAllUsers` operationId).

func (*Client) GetArticles

func (c *Client) GetArticles(ctx context.Context, params *GetArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetArticles List articles

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search articles tenant-wide based on title or tenantArticleId

Corresponds with GET /api/articles (the `GetArticles` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) GetDiscountForFacility

func (c *Client) GetDiscountForFacility(ctx context.Context, facilityRef string, facilityDiscountRef string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetDiscountForFacility Get facility discount

Corresponds with GET /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `GetDiscountForFacility` operationId).

func (*Client) GetDiscountsForFacility

func (c *Client) GetDiscountsForFacility(ctx context.Context, facilityRef string, params *GetDiscountsForFacilityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetDiscountsForFacility List facility discounts

Corresponds with GET /api/facilities/{facilityRef}/discounts (the `GetDiscountsForFacility` operationId).

func (*Client) GetEffectivePermissions

func (c *Client) GetEffectivePermissions(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetEffectivePermissions Return effective permissions

Returns the effective permissions of the user.

Corresponds with GET /api/users/me/effectivepermissions (the `GetEffectivePermissions` operationId).

func (*Client) GetFacility

func (c *Client) GetFacility(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetFacility Get facility

Corresponds with GET /api/facilities/{facilityId} (the `GetFacility` operationId).

func (*Client) GetFacilityCarrier

func (c *Client) GetFacilityCarrier(ctx context.Context, facilityId string, carrierRef string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetFacilityCarrier Get facility carrier connection

Get the details for a carrier related to the facility with the given ID.

Corresponds with GET /api/facilities/{facilityId}/carriers/{carrierRef} (the `GetFacilityCarrier` operationId).

func (*Client) GetFacilityConnection

func (c *Client) GetFacilityConnection(ctx context.Context, facilityId string, connectionId string, params *GetFacilityConnectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetFacilityConnection Get facility connection

Get the details for a facility connection related to the facility with the given ID.

Corresponds with GET /api/facilities/{facilityId}/connections/{connectionId} (the `GetFacilityConnection` operationId).

func (*Client) GetFacilityConnections

func (c *Client) GetFacilityConnections(ctx context.Context, facilityId string, params *GetFacilityConnectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetFacilityConnections List facility connections

Get the details for all connections related to the facility with the given ID.

Corresponds with GET /api/facilities/{facilityId}/connections (the `GetFacilityConnections` operationId).

func (*Client) GetFacilityListing

func (c *Client) GetFacilityListing(ctx context.Context, facilityId string, params *GetFacilityListingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetFacilityListing List listings

Corresponds with GET /api/facilities/{facilityId}/listings (the `GetFacilityListing` operationId).

func (*Client) GetFacilityListingPartialStock

func (c *Client) GetFacilityListingPartialStock(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetFacilityListingPartialStock List listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.

Corresponds with GET /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `GetFacilityListingPartialStock` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) GetForecastsForArticle

func (c *Client) GetForecastsForArticle(ctx context.Context, tenantArticleId string, params *GetForecastsForArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetForecastsForArticle Get article forecast

This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Get the forecast for a specific tenantArticleId

Corresponds with GET /api/articles/{tenantArticleId}/forecasts (the `GetForecastsForArticle` operationId).

func (*Client) GetListing

func (c *Client) GetListing(ctx context.Context, facilityId string, tenantArticleId string, params *GetListingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetListing Get listing

Corresponds with GET /api/facilities/{facilityId}/listings/{tenantArticleId} (the `GetListing` operationId).

func (*Client) GetOrder added in v0.3.0

func (c *Client) GetOrder(ctx context.Context, orderId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetOrder Get order

Get a specific order by ID.

Corresponds with GET /api/orders/{orderId} (the `GetOrder` operationId).

func (*Client) GetPermissions

func (c *Client) GetPermissions(ctx context.Context, params *GetPermissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetPermissions List permissions

This endpoint returns all available permissions in the FFT platform.

Corresponds with GET /api/permissions (the `GetPermissions` operationId).

func (*Client) GetRole

func (c *Client) GetRole(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetRole Return role

Returns a role requested by its name.

Corresponds with GET /api/roles/{name} (the `GetRole` operationId).

func (*Client) GetRoutingDecisionLogs added in v0.6.0

func (c *Client) GetRoutingDecisionLogs(ctx context.Context, params *GetRoutingDecisionLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetRoutingDecisionLogs Get routing decision logs

This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Retrieves in-depth information about the complex routing with combinatorics

Corresponds with GET /api/routing/decisionlogs (the `GetRoutingDecisionLogs` operationId).

func (*Client) GetRoutingStrategies added in v0.6.0

func (c *Client) GetRoutingStrategies(ctx context.Context, params *GetRoutingStrategiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetRoutingStrategies List routing strategies

List all existing routing strategies.

Corresponds with GET /api/routing/strategies (the `GetRoutingStrategies` operationId).

func (*Client) GetRoutingStrategy added in v0.6.0

func (c *Client) GetRoutingStrategy(ctx context.Context, strategyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetRoutingStrategy Get routing strategy

Returns the routing strategy.

Corresponds with GET /api/routing/strategies/{strategyId} (the `GetRoutingStrategy` operationId).

func (*Client) GetRoutingStrategyNodeConfigCategories added in v0.6.0

func (c *Client) GetRoutingStrategyNodeConfigCategories(ctx context.Context, params *GetRoutingStrategyNodeConfigCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetRoutingStrategyNodeConfigCategories List category node configuration

List all the categories for node configurations.

Corresponds with GET /api/routing/nodeconfigcategories (the `GetRoutingStrategyNodeConfigCategories` operationId).

func (*Client) GetRoutingStrategyNodeConfigCategory added in v0.6.0

func (c *Client) GetRoutingStrategyNodeConfigCategory(ctx context.Context, categoryId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetRoutingStrategyNodeConfigCategory Returns category node configuration

Returns the category.

Corresponds with GET /api/routing/nodeconfigcategories/{categoryId} (the `GetRoutingStrategyNodeConfigCategory` operationId).

func (*Client) GetSafetyStocks

func (c *Client) GetSafetyStocks(ctx context.Context, params *GetSafetyStocksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSafetyStocks List safety stocks

Corresponds with GET /api/safetystocks (the `GetSafetyStocks` operationId).

func (*Client) GetSourcingOption added in v0.2.0

func (c *Client) GetSourcingOption(ctx context.Context, sourcingOptionsRequestId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSourcingOption Get sourcing option

Corresponds with GET /api/routing/sourcingoptions/{sourcingOptionsRequestId} (the `GetSourcingOption` operationId).

func (*Client) GetStock

func (c *Client) GetStock(ctx context.Context, stockId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetStock Get stock

Corresponds with GET /api/stocks/{stockId} (the `GetStock` operationId).

func (*Client) GetStockDistribution

func (c *Client) GetStockDistribution(ctx context.Context, tenantArticleId string, params *GetStockDistributionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetStockDistribution Get article stock distribution

Stock per Facility for a specific tenantArticleId, also includes the Tenant-Wide Summary

Corresponds with GET /api/articles/{tenantArticleId}/stockdistribution (the `GetStockDistribution` operationId).

func (*Client) GetStockSummaries

func (c *Client) GetStockSummaries(ctx context.Context, params *GetStockSummariesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetStockSummaries List stock summaries

Get the accumulated Stock for each Article.

Corresponds with GET /api/stocks/summaries (the `GetStockSummaries` operationId).

func (*Client) GetStocks

func (c *Client) GetStocks(ctx context.Context, params *GetStocksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetStocks List stocks

Corresponds with GET /api/stocks (the `GetStocks` operationId).

func (*Client) GetUser

func (c *Client) GetUser(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetUser Return user

Corresponds with GET /api/users/{userId} (the `GetUser` operationId).

func (*Client) GetUserRoles

func (c *Client) GetUserRoles(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetUserRoles Get user roles

Returns the roles of a user.

Corresponds with GET /api/users/{userId}/permissions (the `GetUserRoles` operationId).

func (*Client) HealthCheck

func (c *Client) HealthCheck(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

HealthCheck Health check

Corresponds with GET /api/health (the `HealthCheck` operationId).

func (*Client) ListFacilityCarriers

func (c *Client) ListFacilityCarriers(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*http.Response, error)

ListFacilityCarriers List facility carrier connections

List all carrier connections configured for the given facility.

Corresponds with GET /api/facilities/{facilityId}/carriers (the `ListFacilityCarriers` operationId).

func (*Client) OrderAction added in v0.3.0

func (c *Client) OrderAction(ctx context.Context, orderId string, body OrderActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

OrderAction Call order action

Takes a body of the `application/json` content type.

Corresponds with POST /api/orders/{orderId}/actions (the `OrderAction` operationId).

func (*Client) OrderActionWithBody added in v0.3.0

func (c *Client) OrderActionWithBody(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

OrderActionWithBody Call order action

Takes any type of body and a specified content type.

Corresponds with POST /api/orders/{orderId}/actions (the `OrderAction` operationId).

func (*Client) OrderLineItemAction added in v0.3.0

func (c *Client) OrderLineItemAction(ctx context.Context, orderId string, orderLineItemId string, body OrderLineItemActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

OrderLineItemAction Call order line item action

Takes a body of the `application/json` content type.

Corresponds with POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions (the `OrderLineItemAction` operationId).

func (*Client) OrderLineItemActionWithBody added in v0.3.0

func (c *Client) OrderLineItemActionWithBody(ctx context.Context, orderId string, orderLineItemId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

OrderLineItemActionWithBody Call order line item action

Takes any type of body and a specified content type.

Corresponds with POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions (the `OrderLineItemAction` operationId).

func (*Client) PatchFacility

func (c *Client) PatchFacility(ctx context.Context, facilityId string, body PatchFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchFacility Update facility

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/facilities/{facilityId} (the `PatchFacility` operationId).

func (*Client) PatchFacilityListing

func (c *Client) PatchFacilityListing(ctx context.Context, facilityId string, tenantArticleId string, body PatchFacilityListingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchFacilityListing Update listing

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId} (the `PatchFacilityListing` operationId).

func (*Client) PatchFacilityListingPartialStock

func (c *Client) PatchFacilityListingPartialStock(ctx context.Context, facilityId string, tenantArticleId string, body PatchFacilityListingPartialStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchFacilityListingPartialStock Update listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead. Adds new partial stocks, updates existing partial stocks and keeps stocks that are previously present in the database.

1. If a stock exists in the patch action but not in the database it is added. 2. If a stock exists both in the patch action and in the database it is updated and the contents are merged. 3. If a stock exists only in the database, it is left untouched.

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PatchFacilityListingPartialStock` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) PatchFacilityListingPartialStockWithBody

func (c *Client) PatchFacilityListingPartialStockWithBody(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchFacilityListingPartialStockWithBody Update listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead. Adds new partial stocks, updates existing partial stocks and keeps stocks that are previously present in the database.

1. If a stock exists in the patch action but not in the database it is added. 2. If a stock exists both in the patch action and in the database it is updated and the contents are merged. 3. If a stock exists only in the database, it is left untouched.

Takes any type of body and a specified content type.

Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PatchFacilityListingPartialStock` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) PatchFacilityListingWithBody

func (c *Client) PatchFacilityListingWithBody(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchFacilityListingWithBody Update listing

Takes any type of body and a specified content type.

Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId} (the `PatchFacilityListing` operationId).

func (*Client) PatchFacilityWithBody

func (c *Client) PatchFacilityWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchFacilityWithBody Update facility

Takes any type of body and a specified content type.

Corresponds with PATCH /api/facilities/{facilityId} (the `PatchFacility` operationId).

func (*Client) PatchRole

func (c *Client) PatchRole(ctx context.Context, name string, body PatchRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchRole Update role

Updates an existing role (partial update).

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/roles/{name} (the `PatchRole` operationId).

func (*Client) PatchRoleWithBody

func (c *Client) PatchRoleWithBody(ctx context.Context, name string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchRoleWithBody Update role

Updates an existing role (partial update).

Takes any type of body and a specified content type.

Corresponds with PATCH /api/roles/{name} (the `PatchRole` operationId).

func (*Client) PerformStocksActions

func (c *Client) PerformStocksActions(ctx context.Context, body PerformStocksActionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PerformStocksActions Call stock action

Takes a body of the `application/json` content type.

Corresponds with POST /api/stocks/actions (the `PerformStocksActions` operationId).

func (*Client) PerformStocksActionsWithBody

func (c *Client) PerformStocksActionsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PerformStocksActionsWithBody Call stock action

Takes any type of body and a specified content type.

Corresponds with POST /api/stocks/actions (the `PerformStocksActions` operationId).

func (*Client) PostDeliveryPromise added in v0.3.0

func (c *Client) PostDeliveryPromise(ctx context.Context, body PostDeliveryPromiseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PostDeliveryPromise Create promise order

Endpoint to create a promise order.

Takes a body of the `application/json` content type.

Corresponds with POST /api/promises/deliverypromise (the `PostDeliveryPromise` operationId).

func (*Client) PostDeliveryPromiseWithBody added in v0.3.0

func (c *Client) PostDeliveryPromiseWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostDeliveryPromiseWithBody Create promise order

Endpoint to create a promise order.

Takes any type of body and a specified content type.

Corresponds with POST /api/promises/deliverypromise (the `PostDeliveryPromise` operationId).

func (*Client) PostRoutingStrategy added in v0.6.0

func (c *Client) PostRoutingStrategy(ctx context.Context, body PostRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PostRoutingStrategy Create routing strategy

Creates a new revision of the routing strategy.

Takes a body of the `application/json` content type.

Corresponds with POST /api/routing/strategies (the `PostRoutingStrategy` operationId).

func (*Client) PostRoutingStrategyNodeConfigCategory added in v0.6.0

func (c *Client) PostRoutingStrategyNodeConfigCategory(ctx context.Context, body PostRoutingStrategyNodeConfigCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PostRoutingStrategyNodeConfigCategory Create category node configuration

Creates a new category for a routing strategies node config.

Takes a body of the `application/json` content type.

Corresponds with POST /api/routing/nodeconfigcategories (the `PostRoutingStrategyNodeConfigCategory` operationId).

func (*Client) PostRoutingStrategyNodeConfigCategoryWithBody added in v0.6.0

func (c *Client) PostRoutingStrategyNodeConfigCategoryWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostRoutingStrategyNodeConfigCategoryWithBody Create category node configuration

Creates a new category for a routing strategies node config.

Takes any type of body and a specified content type.

Corresponds with POST /api/routing/nodeconfigcategories (the `PostRoutingStrategyNodeConfigCategory` operationId).

func (*Client) PostRoutingStrategyWithBody added in v0.6.0

func (c *Client) PostRoutingStrategyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostRoutingStrategyWithBody Create routing strategy

Creates a new revision of the routing strategy.

Takes any type of body and a specified content type.

Corresponds with POST /api/routing/strategies (the `PostRoutingStrategy` operationId).

func (*Client) PutFacilityListing

func (c *Client) PutFacilityListing(ctx context.Context, facilityId string, body PutFacilityListingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutFacilityListing Create and update listings per facility

Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.

Takes a body of the `application/json` content type.

Corresponds with PUT /api/facilities/{facilityId}/listings (the `PutFacilityListing` operationId).

func (*Client) PutFacilityListingPartialStock

func (c *Client) PutFacilityListingPartialStock(ctx context.Context, facilityId string, tenantArticleId string, body PutFacilityListingPartialStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutFacilityListingPartialStock Update listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead. Replaces the current partial stock object related to its listing

Takes a body of the `application/json` content type.

Corresponds with PUT /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PutFacilityListingPartialStock` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) PutFacilityListingPartialStockWithBody

func (c *Client) PutFacilityListingPartialStockWithBody(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutFacilityListingPartialStockWithBody Update listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead. Replaces the current partial stock object related to its listing

Takes any type of body and a specified content type.

Corresponds with PUT /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PutFacilityListingPartialStock` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) PutFacilityListingWithBody

func (c *Client) PutFacilityListingWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutFacilityListingWithBody Create and update listings per facility

Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.

Takes any type of body and a specified content type.

Corresponds with PUT /api/facilities/{facilityId}/listings (the `PutFacilityListing` operationId).

func (*Client) PutRoutingStrategy added in v0.6.0

func (c *Client) PutRoutingStrategy(ctx context.Context, strategyId string, body PutRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutRoutingStrategy Update routing strategy

Updates a routing strategy.

Takes a body of the `application/json` content type.

Corresponds with PUT /api/routing/strategies/{strategyId} (the `PutRoutingStrategy` operationId).

func (*Client) PutRoutingStrategyNodeConfigCategory added in v0.6.0

func (c *Client) PutRoutingStrategyNodeConfigCategory(ctx context.Context, categoryId string, body PutRoutingStrategyNodeConfigCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutRoutingStrategyNodeConfigCategory Updates category node configuration

Updates a category.

Takes a body of the `application/json` content type.

Corresponds with PUT /api/routing/nodeconfigcategories/{categoryId} (the `PutRoutingStrategyNodeConfigCategory` operationId).

func (*Client) PutRoutingStrategyNodeConfigCategoryWithBody added in v0.6.0

func (c *Client) PutRoutingStrategyNodeConfigCategoryWithBody(ctx context.Context, categoryId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutRoutingStrategyNodeConfigCategoryWithBody Updates category node configuration

Updates a category.

Takes any type of body and a specified content type.

Corresponds with PUT /api/routing/nodeconfigcategories/{categoryId} (the `PutRoutingStrategyNodeConfigCategory` operationId).

func (*Client) PutRoutingStrategyWithBody added in v0.6.0

func (c *Client) PutRoutingStrategyWithBody(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutRoutingStrategyWithBody Update routing strategy

Updates a routing strategy.

Takes any type of body and a specified content type.

Corresponds with PUT /api/routing/strategies/{strategyId} (the `PutRoutingStrategy` operationId).

func (*Client) ReplaceFacility

func (c *Client) ReplaceFacility(ctx context.Context, facilityId string, body ReplaceFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ReplaceFacility Update facility

Takes a body of the `application/json` content type.

Corresponds with PUT /api/facilities/{facilityId} (the `ReplaceFacility` operationId).

func (*Client) ReplaceFacilityWithBody

func (c *Client) ReplaceFacilityWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ReplaceFacilityWithBody Update facility

Takes any type of body and a specified content type.

Corresponds with PUT /api/facilities/{facilityId} (the `ReplaceFacility` operationId).

func (*Client) SearchFacility

func (c *Client) SearchFacility(ctx context.Context, body SearchFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchFacility List facilities (search)

This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for Facility

Takes a body of the `application/json` content type.

Corresponds with POST /api/facilities/search (the `SearchFacility` operationId).

func (*Client) SearchFacilityWithBody

func (c *Client) SearchFacilityWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchFacilityWithBody List facilities (search)

This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for Facility

Takes any type of body and a specified content type.

Corresponds with POST /api/facilities/search (the `SearchFacility` operationId).

func (*Client) SearchListing

func (c *Client) SearchListing(ctx context.Context, body SearchListingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchListing List listings (search)

Search for Listing.

Takes a body of the `application/json` content type.

Corresponds with POST /api/listings/search (the `SearchListing` operationId).

func (*Client) SearchListingWithBody

func (c *Client) SearchListingWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchListingWithBody List listings (search)

Search for Listing.

Takes any type of body and a specified content type.

Corresponds with POST /api/listings/search (the `SearchListing` operationId).

func (*Client) SearchOrder added in v0.3.0

func (c *Client) SearchOrder(ctx context.Context, body SearchOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchOrder List orders (search)

Search for Order.

Takes a body of the `application/json` content type.

Corresponds with POST /api/orders/search (the `SearchOrder` operationId).

func (*Client) SearchOrderWithBody added in v0.3.0

func (c *Client) SearchOrderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchOrderWithBody List orders (search)

Search for Order.

Takes any type of body and a specified content type.

Corresponds with POST /api/orders/search (the `SearchOrder` operationId).

func (*Client) SearchRole

func (c *Client) SearchRole(ctx context.Context, body SearchRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchRole List roles (search)

Search for Role.

Takes a body of the `application/json` content type.

Corresponds with POST /api/roles/search (the `SearchRole` operationId).

func (*Client) SearchRoleWithBody

func (c *Client) SearchRoleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchRoleWithBody List roles (search)

Search for Role.

Takes any type of body and a specified content type.

Corresponds with POST /api/roles/search (the `SearchRole` operationId).

func (*Client) SearchStock

func (c *Client) SearchStock(ctx context.Context, body SearchStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchStock List stocks (search)

Search for Stock.

Takes a body of the `application/json` content type.

Corresponds with POST /api/stocks/search (the `SearchStock` operationId).

func (*Client) SearchStockWithBody

func (c *Client) SearchStockWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchStockWithBody List stocks (search)

Search for Stock.

Takes any type of body and a specified content type.

Corresponds with POST /api/stocks/search (the `SearchStock` operationId).

func (*Client) SearchUser

func (c *Client) SearchUser(ctx context.Context, body SearchUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchUser List users (search)

This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for User

Takes a body of the `application/json` content type.

Corresponds with POST /api/users/search (the `SearchUser` operationId).

func (*Client) SearchUserWithBody

func (c *Client) SearchUserWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchUserWithBody List users (search)

This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for User

Takes any type of body and a specified content type.

Corresponds with POST /api/users/search (the `SearchUser` operationId).

func (*Client) Status

func (c *Client) Status(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

Status Get status

Returns the platform status.

Corresponds with GET /api/status (the `Status` operationId).

func (*Client) UpdateDiscountForFacility

func (c *Client) UpdateDiscountForFacility(ctx context.Context, facilityRef string, facilityDiscountRef string, body UpdateDiscountForFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateDiscountForFacility Update facility discount

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `UpdateDiscountForFacility` operationId).

func (*Client) UpdateDiscountForFacilityWithBody

func (c *Client) UpdateDiscountForFacilityWithBody(ctx context.Context, facilityRef string, facilityDiscountRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateDiscountForFacilityWithBody Update facility discount

Takes any type of body and a specified content type.

Corresponds with PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `UpdateDiscountForFacility` operationId).

func (*Client) UpdateFacilityConnection

func (c *Client) UpdateFacilityConnection(ctx context.Context, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, body UpdateFacilityConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateFacilityConnection Update facility connection

Update the given connection for a facility.

Takes a body of the `application/json` content type.

Corresponds with PUT /api/facilities/{facilityId}/connections/{connectionId} (the `UpdateFacilityConnection` operationId).

func (*Client) UpdateFacilityConnectionWithBody

func (c *Client) UpdateFacilityConnectionWithBody(ctx context.Context, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateFacilityConnectionWithBody Update facility connection

Update the given connection for a facility.

Takes any type of body and a specified content type.

Corresponds with PUT /api/facilities/{facilityId}/connections/{connectionId} (the `UpdateFacilityConnection` operationId).

func (*Client) UpdateMe

func (c *Client) UpdateMe(ctx context.Context, body UpdateMeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateMe Update me user

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Update my own data.

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/users/me (the `UpdateMe` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) UpdateMeWithBody

func (c *Client) UpdateMeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateMeWithBody Update me user

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Update my own data.

Takes any type of body and a specified content type.

Corresponds with PATCH /api/users/me (the `UpdateMe` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) UpdateOrder added in v0.3.0

func (c *Client) UpdateOrder(ctx context.Context, orderId string, body UpdateOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateOrder Update order

Update an existing order.

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/orders/{orderId} (the `UpdateOrder` operationId).

func (*Client) UpdateOrderWithBody added in v0.3.0

func (c *Client) UpdateOrderWithBody(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateOrderWithBody Update order

Update an existing order.

Takes any type of body and a specified content type.

Corresponds with PATCH /api/orders/{orderId} (the `UpdateOrder` operationId).

func (*Client) UpdateRole

func (c *Client) UpdateRole(ctx context.Context, name string, body UpdateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateRole Update role

Updates an existing role (complete replacement).

Takes a body of the `application/json` content type.

Corresponds with PUT /api/roles/{name} (the `UpdateRole` operationId).

func (*Client) UpdateRoleWithBody

func (c *Client) UpdateRoleWithBody(ctx context.Context, name string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateRoleWithBody Update role

Updates an existing role (complete replacement).

Takes any type of body and a specified content type.

Corresponds with PUT /api/roles/{name} (the `UpdateRole` operationId).

func (*Client) UpdateStock

func (c *Client) UpdateStock(ctx context.Context, stockId string, body UpdateStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateStock Update stock

Takes a body of the `application/json` content type.

Corresponds with PUT /api/stocks/{stockId} (the `UpdateStock` operationId).

func (*Client) UpdateStockWithBody

func (c *Client) UpdateStockWithBody(ctx context.Context, stockId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateStockWithBody Update stock

Takes any type of body and a specified content type.

Corresponds with PUT /api/stocks/{stockId} (the `UpdateStock` operationId).

func (*Client) UpsertStocks

func (c *Client) UpsertStocks(ctx context.Context, body UpsertStocksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpsertStocks Update stocks

Update and create many stocks at once.

Takes a body of the `application/json` content type.

Corresponds with PUT /api/stocks (the `UpsertStocks` operationId).

func (*Client) UpsertStocksWithBody

func (c *Client) UpsertStocksWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpsertStocksWithBody Update stocks

Update and create many stocks at once.

Takes any type of body and a specified content type.

Corresponds with PUT /api/stocks (the `UpsertStocks` operationId).

type ClientInterface

type ClientInterface interface {

	// GetArticles List articles
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search articles tenant-wide based on title or tenantArticleId
	//
	// Corresponds with GET /api/articles (the `GetArticles` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	GetArticles(ctx context.Context, params *GetArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetForecastsForArticle Get article forecast
	//
	// This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Get the forecast for a specific tenantArticleId
	//
	// Corresponds with GET /api/articles/{tenantArticleId}/forecasts (the `GetForecastsForArticle` operationId).
	GetForecastsForArticle(ctx context.Context, tenantArticleId string, params *GetForecastsForArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStockDistribution Get article stock distribution
	//
	// Stock per Facility for a specific tenantArticleId, also includes the Tenant-Wide Summary
	//
	// Corresponds with GET /api/articles/{tenantArticleId}/stockdistribution (the `GetStockDistribution` operationId).
	GetStockDistribution(ctx context.Context, tenantArticleId string, params *GetStockDistributionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllFacilities List facilities
	//
	// Corresponds with GET /api/facilities (the `GetAllFacilities` operationId).
	GetAllFacilities(ctx context.Context, params *GetAllFacilitiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AddFacilityWithBody Create facility
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/facilities (the `AddFacility` operationId).
	AddFacilityWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AddFacility Create facility
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/facilities (the `AddFacility` operationId).
	AddFacility(ctx context.Context, body AddFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchFacilityWithBody List facilities (search)
	//
	// This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for Facility
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/facilities/search (the `SearchFacility` operationId).
	SearchFacilityWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchFacility List facilities (search)
	//
	// This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for Facility
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/facilities/search (the `SearchFacility` operationId).
	SearchFacility(ctx context.Context, body SearchFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteFacility Delete facility
	//
	// Corresponds with DELETE /api/facilities/{facilityId} (the `DeleteFacility` operationId).
	DeleteFacility(ctx context.Context, facilityId string, params *DeleteFacilityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFacility Get facility
	//
	// Corresponds with GET /api/facilities/{facilityId} (the `GetFacility` operationId).
	GetFacility(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchFacilityWithBody Update facility
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/facilities/{facilityId} (the `PatchFacility` operationId).
	PatchFacilityWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchFacility Update facility
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/facilities/{facilityId} (the `PatchFacility` operationId).
	PatchFacility(ctx context.Context, facilityId string, body PatchFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReplaceFacilityWithBody Update facility
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId} (the `ReplaceFacility` operationId).
	ReplaceFacilityWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReplaceFacility Update facility
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId} (the `ReplaceFacility` operationId).
	ReplaceFacility(ctx context.Context, facilityId string, body ReplaceFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FacilityActionWithBody Call facility action
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/facilities/{facilityId}/actions (the `FacilityAction` operationId).
	FacilityActionWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FacilityAction Call facility action
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/facilities/{facilityId}/actions (the `FacilityAction` operationId).
	FacilityAction(ctx context.Context, facilityId string, body FacilityActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListFacilityCarriers List facility carrier connections
	//
	// List all carrier connections configured for the given facility.
	//
	// Corresponds with GET /api/facilities/{facilityId}/carriers (the `ListFacilityCarriers` operationId).
	ListFacilityCarriers(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CalculateBestCarrierWithBody Calculate best carriers
	//
	// Calculate prioritized list of recommended carriers for the given facility and input parameters.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/facilities/{facilityId}/carriers/prioritization (the `CalculateBestCarrier` operationId).
	CalculateBestCarrierWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CalculateBestCarrier Calculate best carriers
	//
	// Calculate prioritized list of recommended carriers for the given facility and input parameters.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/facilities/{facilityId}/carriers/prioritization (the `CalculateBestCarrier` operationId).
	CalculateBestCarrier(ctx context.Context, facilityId string, body CalculateBestCarrierJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFacilityCarrier Get facility carrier connection
	//
	// Get the details for a carrier related to the facility with the given ID.
	//
	// Corresponds with GET /api/facilities/{facilityId}/carriers/{carrierRef} (the `GetFacilityCarrier` operationId).
	GetFacilityCarrier(ctx context.Context, facilityId string, carrierRef string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateCarrierToFacilityWithBody Create facility carrier connection
	//
	// Create a connection of a configured carrier to the facility with given ID.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/facilities/{facilityId}/carriers/{carrierRef} (the `CreateCarrierToFacility` operationId).
	CreateCarrierToFacilityWithBody(ctx context.Context, facilityId string, carrierRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateCarrierToFacility Create facility carrier connection
	//
	// Create a connection of a configured carrier to the facility with given ID.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/facilities/{facilityId}/carriers/{carrierRef} (the `CreateCarrierToFacility` operationId).
	CreateCarrierToFacility(ctx context.Context, facilityId string, carrierRef string, body CreateCarrierToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ConnectCarrierToFacilityWithBody Update facility carrier connection
	//
	// Connect a configured carrier to the facility with given ID.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId}/carriers/{carrierRef} (the `ConnectCarrierToFacility` operationId).
	ConnectCarrierToFacilityWithBody(ctx context.Context, facilityId string, carrierRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ConnectCarrierToFacility Update facility carrier connection
	//
	// Connect a configured carrier to the facility with given ID.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId}/carriers/{carrierRef} (the `ConnectCarrierToFacility` operationId).
	ConnectCarrierToFacility(ctx context.Context, facilityId string, carrierRef string, body ConnectCarrierToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFacilityConnections List facility connections
	//
	// Get the details for all connections related to the facility with the given ID.
	//
	// Corresponds with GET /api/facilities/{facilityId}/connections (the `GetFacilityConnections` operationId).
	GetFacilityConnections(ctx context.Context, facilityId string, params *GetFacilityConnectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateConnectionToFacilityWithBody Create facility connection
	//
	// Create a connections for a supplier facility with given ID.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/facilities/{facilityId}/connections (the `CreateConnectionToFacility` operationId).
	CreateConnectionToFacilityWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateConnectionToFacility Create facility connection
	//
	// Create a connections for a supplier facility with given ID.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/facilities/{facilityId}/connections (the `CreateConnectionToFacility` operationId).
	CreateConnectionToFacility(ctx context.Context, facilityId string, body CreateConnectionToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteFacilityConnection Delete facility connection
	//
	// Delete the connection for facility with the given ID.
	//
	// Corresponds with DELETE /api/facilities/{facilityId}/connections/{connectionId} (the `DeleteFacilityConnection` operationId).
	DeleteFacilityConnection(ctx context.Context, facilityId string, connectionId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFacilityConnection Get facility connection
	//
	// Get the details for a facility connection related to the facility with the given ID.
	//
	// Corresponds with GET /api/facilities/{facilityId}/connections/{connectionId} (the `GetFacilityConnection` operationId).
	GetFacilityConnection(ctx context.Context, facilityId string, connectionId string, params *GetFacilityConnectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateFacilityConnectionWithBody Update facility connection
	//
	// Update the given connection for a facility.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId}/connections/{connectionId} (the `UpdateFacilityConnection` operationId).
	UpdateFacilityConnectionWithBody(ctx context.Context, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateFacilityConnection Update facility connection
	//
	// Update the given connection for a facility.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId}/connections/{connectionId} (the `UpdateFacilityConnection` operationId).
	UpdateFacilityConnection(ctx context.Context, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, body UpdateFacilityConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteListingsOfFacility Delete listings
	//
	// Corresponds with DELETE /api/facilities/{facilityId}/listings (the `DeleteListingsOfFacility` operationId).
	DeleteListingsOfFacility(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFacilityListing List listings
	//
	// Corresponds with GET /api/facilities/{facilityId}/listings (the `GetFacilityListing` operationId).
	GetFacilityListing(ctx context.Context, facilityId string, params *GetFacilityListingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutFacilityListingWithBody Create and update listings per facility
	//
	// Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId}/listings (the `PutFacilityListing` operationId).
	PutFacilityListingWithBody(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutFacilityListing Create and update listings per facility
	//
	// Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId}/listings (the `PutFacilityListing` operationId).
	PutFacilityListing(ctx context.Context, facilityId string, body PutFacilityListingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteFacilityListing Delete listing
	//
	// Corresponds with DELETE /api/facilities/{facilityId}/listings/{tenantArticleId} (the `DeleteFacilityListing` operationId).
	DeleteFacilityListing(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetListing Get listing
	//
	// Corresponds with GET /api/facilities/{facilityId}/listings/{tenantArticleId} (the `GetListing` operationId).
	GetListing(ctx context.Context, facilityId string, tenantArticleId string, params *GetListingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchFacilityListingWithBody Update listing
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId} (the `PatchFacilityListing` operationId).
	PatchFacilityListingWithBody(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchFacilityListing Update listing
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId} (the `PatchFacilityListing` operationId).
	PatchFacilityListing(ctx context.Context, facilityId string, tenantArticleId string, body PatchFacilityListingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteFacilityListingPartialStock Delete listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	//
	// Corresponds with DELETE /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `DeleteFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	DeleteFacilityListingPartialStock(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFacilityListingPartialStock List listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	//
	// Corresponds with GET /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `GetFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	GetFacilityListingPartialStock(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchFacilityListingPartialStockWithBody Update listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	// Adds new partial stocks, updates existing partial stocks and keeps stocks that are previously present in the database.
	//
	// 1. If a stock exists in the patch action but not in the database it is added.
	// 2. If a stock exists both in the patch action and in the database it is updated and the contents are merged.
	// 3. If a stock exists only in the database, it is left untouched.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PatchFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PatchFacilityListingPartialStockWithBody(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchFacilityListingPartialStock Update listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	// Adds new partial stocks, updates existing partial stocks and keeps stocks that are previously present in the database.
	//
	// 1. If a stock exists in the patch action but not in the database it is added.
	// 2. If a stock exists both in the patch action and in the database it is updated and the contents are merged.
	// 3. If a stock exists only in the database, it is left untouched.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PatchFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PatchFacilityListingPartialStock(ctx context.Context, facilityId string, tenantArticleId string, body PatchFacilityListingPartialStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutFacilityListingPartialStockWithBody Update listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	// Replaces the current partial stock object related to its listing
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PutFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PutFacilityListingPartialStockWithBody(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutFacilityListingPartialStock Update listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	// Replaces the current partial stock object related to its listing
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PutFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PutFacilityListingPartialStock(ctx context.Context, facilityId string, tenantArticleId string, body PutFacilityListingPartialStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDiscountsForFacility List facility discounts
	//
	// Corresponds with GET /api/facilities/{facilityRef}/discounts (the `GetDiscountsForFacility` operationId).
	GetDiscountsForFacility(ctx context.Context, facilityRef string, params *GetDiscountsForFacilityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AddDiscountToFacilityWithBody Create facility discount
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/facilities/{facilityRef}/discounts (the `AddDiscountToFacility` operationId).
	AddDiscountToFacilityWithBody(ctx context.Context, facilityRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AddDiscountToFacility Create facility discount
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/facilities/{facilityRef}/discounts (the `AddDiscountToFacility` operationId).
	AddDiscountToFacility(ctx context.Context, facilityRef string, body AddDiscountToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteDiscountForFacility Delete facility discount
	//
	// Corresponds with DELETE /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `DeleteDiscountForFacility` operationId).
	DeleteDiscountForFacility(ctx context.Context, facilityRef string, facilityDiscountRef string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDiscountForFacility Get facility discount
	//
	// Corresponds with GET /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `GetDiscountForFacility` operationId).
	GetDiscountForFacility(ctx context.Context, facilityRef string, facilityDiscountRef string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDiscountForFacilityWithBody Update facility discount
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `UpdateDiscountForFacility` operationId).
	UpdateDiscountForFacilityWithBody(ctx context.Context, facilityRef string, facilityDiscountRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDiscountForFacility Update facility discount
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `UpdateDiscountForFacility` operationId).
	UpdateDiscountForFacility(ctx context.Context, facilityRef string, facilityDiscountRef string, body UpdateDiscountForFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HealthCheck Health check
	//
	// Corresponds with GET /api/health (the `HealthCheck` operationId).
	HealthCheck(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BulkUpsertListingsWithBody Create and update listings
	//
	// Bulk upsert listings independently of their facility.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/listings (the `BulkUpsertListings` operationId).
	BulkUpsertListingsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BulkUpsertListings Create and update listings
	//
	// Bulk upsert listings independently of their facility.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/listings (the `BulkUpsertListings` operationId).
	BulkUpsertListings(ctx context.Context, body BulkUpsertListingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchListingWithBody List listings (search)
	//
	// Search for Listing.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/listings/search (the `SearchListing` operationId).
	SearchListingWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchListing List listings (search)
	//
	// Search for Listing.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/listings/search (the `SearchListing` operationId).
	SearchListing(ctx context.Context, body SearchListingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllOrders List orders
	//
	// List orders with optional filtering by tenant order ID or consumer ID.
	//
	// Corresponds with GET /api/orders (the `GetAllOrders` operationId).
	GetAllOrders(ctx context.Context, params *GetAllOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AddOrderWithBody Create order
	//
	// Create a new order.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/orders (the `AddOrder` operationId).
	AddOrderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AddOrder Create order
	//
	// Create a new order.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/orders (the `AddOrder` operationId).
	AddOrder(ctx context.Context, body AddOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BulkOrdersActionWithBody Call bulk orders action
	//
	// Bulk action of orders.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/orders/actions (the `BulkOrdersAction` operationId).
	BulkOrdersActionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BulkOrdersAction Call bulk orders action
	//
	// Bulk action of orders.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/orders/actions (the `BulkOrdersAction` operationId).
	BulkOrdersAction(ctx context.Context, body BulkOrdersActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchOrderWithBody List orders (search)
	//
	// Search for Order.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/orders/search (the `SearchOrder` operationId).
	SearchOrderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchOrder List orders (search)
	//
	// Search for Order.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/orders/search (the `SearchOrder` operationId).
	SearchOrder(ctx context.Context, body SearchOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrder Get order
	//
	// Get a specific order by ID.
	//
	// Corresponds with GET /api/orders/{orderId} (the `GetOrder` operationId).
	GetOrder(ctx context.Context, orderId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateOrderWithBody Update order
	//
	// Update an existing order.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/orders/{orderId} (the `UpdateOrder` operationId).
	UpdateOrderWithBody(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateOrder Update order
	//
	// Update an existing order.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/orders/{orderId} (the `UpdateOrder` operationId).
	UpdateOrder(ctx context.Context, orderId string, body UpdateOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// OrderActionWithBody Call order action
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/orders/{orderId}/actions (the `OrderAction` operationId).
	OrderActionWithBody(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// OrderAction Call order action
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/orders/{orderId}/actions (the `OrderAction` operationId).
	OrderAction(ctx context.Context, orderId string, body OrderActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// OrderLineItemActionWithBody Call order line item action
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions (the `OrderLineItemAction` operationId).
	OrderLineItemActionWithBody(ctx context.Context, orderId string, orderLineItemId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// OrderLineItemAction Call order line item action
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions (the `OrderLineItemAction` operationId).
	OrderLineItemAction(ctx context.Context, orderId string, orderLineItemId string, body OrderLineItemActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPermissions List permissions
	//
	// This endpoint returns all available permissions in the FFT platform.
	//
	// Corresponds with GET /api/permissions (the `GetPermissions` operationId).
	GetPermissions(ctx context.Context, params *GetPermissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostDeliveryPromiseWithBody Create promise order
	//
	// Endpoint to create a promise order.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/promises/deliverypromise (the `PostDeliveryPromise` operationId).
	PostDeliveryPromiseWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostDeliveryPromise Create promise order
	//
	// Endpoint to create a promise order.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/promises/deliverypromise (the `PostDeliveryPromise` operationId).
	PostDeliveryPromise(ctx context.Context, body PostDeliveryPromiseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllRoles List roles
	//
	// Returns all existing roles, including their permissions and context ceilings.
	//
	// Corresponds with GET /api/roles (the `GetAllRoles` operationId).
	GetAllRoles(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRoleWithBody Create role
	//
	// Creates a new custom role.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/roles (the `CreateRole` operationId).
	CreateRoleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRole Create role
	//
	// Creates a new custom role.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/roles (the `CreateRole` operationId).
	CreateRole(ctx context.Context, body CreateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchRoleWithBody List roles (search)
	//
	// Search for Role.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/roles/search (the `SearchRole` operationId).
	SearchRoleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchRole List roles (search)
	//
	// Search for Role.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/roles/search (the `SearchRole` operationId).
	SearchRole(ctx context.Context, body SearchRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteRole Delete role
	//
	// Deletes an existing role.
	//
	// Corresponds with DELETE /api/roles/{name} (the `DeleteRole` operationId).
	DeleteRole(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRole Return role
	//
	// Returns a role requested by its name.
	//
	// Corresponds with GET /api/roles/{name} (the `GetRole` operationId).
	GetRole(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchRoleWithBody Update role
	//
	// Updates an existing role (partial update).
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/roles/{name} (the `PatchRole` operationId).
	PatchRoleWithBody(ctx context.Context, name string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchRole Update role
	//
	// Updates an existing role (partial update).
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/roles/{name} (the `PatchRole` operationId).
	PatchRole(ctx context.Context, name string, body PatchRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateRoleWithBody Update role
	//
	// Updates an existing role (complete replacement).
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/roles/{name} (the `UpdateRole` operationId).
	UpdateRoleWithBody(ctx context.Context, name string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateRole Update role
	//
	// Updates an existing role (complete replacement).
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/roles/{name} (the `UpdateRole` operationId).
	UpdateRole(ctx context.Context, name string, body UpdateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRoutingDecisionLogs Get routing decision logs
	//
	// This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Retrieves in-depth information about the complex routing with combinatorics
	//
	// Corresponds with GET /api/routing/decisionlogs (the `GetRoutingDecisionLogs` operationId).
	GetRoutingDecisionLogs(ctx context.Context, params *GetRoutingDecisionLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRoutingStrategyNodeConfigCategories List category node configuration
	//
	// List all the categories for node configurations.
	//
	// Corresponds with GET /api/routing/nodeconfigcategories (the `GetRoutingStrategyNodeConfigCategories` operationId).
	GetRoutingStrategyNodeConfigCategories(ctx context.Context, params *GetRoutingStrategyNodeConfigCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostRoutingStrategyNodeConfigCategoryWithBody Create category node configuration
	//
	// Creates a new category for a routing strategies node config.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/routing/nodeconfigcategories (the `PostRoutingStrategyNodeConfigCategory` operationId).
	PostRoutingStrategyNodeConfigCategoryWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostRoutingStrategyNodeConfigCategory Create category node configuration
	//
	// Creates a new category for a routing strategies node config.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/routing/nodeconfigcategories (the `PostRoutingStrategyNodeConfigCategory` operationId).
	PostRoutingStrategyNodeConfigCategory(ctx context.Context, body PostRoutingStrategyNodeConfigCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteRoutingStrategyNodeConfigCategory Delete category node configuration
	//
	// Deletes the category.
	//
	// Corresponds with DELETE /api/routing/nodeconfigcategories/{categoryId} (the `DeleteRoutingStrategyNodeConfigCategory` operationId).
	DeleteRoutingStrategyNodeConfigCategory(ctx context.Context, categoryId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRoutingStrategyNodeConfigCategory Returns category node configuration
	//
	// Returns the category.
	//
	// Corresponds with GET /api/routing/nodeconfigcategories/{categoryId} (the `GetRoutingStrategyNodeConfigCategory` operationId).
	GetRoutingStrategyNodeConfigCategory(ctx context.Context, categoryId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutRoutingStrategyNodeConfigCategoryWithBody Updates category node configuration
	//
	// Updates a category.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/routing/nodeconfigcategories/{categoryId} (the `PutRoutingStrategyNodeConfigCategory` operationId).
	PutRoutingStrategyNodeConfigCategoryWithBody(ctx context.Context, categoryId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutRoutingStrategyNodeConfigCategory Updates category node configuration
	//
	// Updates a category.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/routing/nodeconfigcategories/{categoryId} (the `PutRoutingStrategyNodeConfigCategory` operationId).
	PutRoutingStrategyNodeConfigCategory(ctx context.Context, categoryId string, body PutRoutingStrategyNodeConfigCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateSourcingOptionsRequestWithBody Create sourcing option
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/routing/sourcingoptions (the `CreateSourcingOptionsRequest` operationId).
	CreateSourcingOptionsRequestWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateSourcingOptionsRequest Create sourcing option
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/routing/sourcingoptions (the `CreateSourcingOptionsRequest` operationId).
	CreateSourcingOptionsRequest(ctx context.Context, body CreateSourcingOptionsRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSourcingOption Get sourcing option
	//
	// Corresponds with GET /api/routing/sourcingoptions/{sourcingOptionsRequestId} (the `GetSourcingOption` operationId).
	GetSourcingOption(ctx context.Context, sourcingOptionsRequestId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRoutingStrategies List routing strategies
	//
	// List all existing routing strategies.
	//
	// Corresponds with GET /api/routing/strategies (the `GetRoutingStrategies` operationId).
	GetRoutingStrategies(ctx context.Context, params *GetRoutingStrategiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostRoutingStrategyWithBody Create routing strategy
	//
	// Creates a new revision of the routing strategy.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/routing/strategies (the `PostRoutingStrategy` operationId).
	PostRoutingStrategyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostRoutingStrategy Create routing strategy
	//
	// Creates a new revision of the routing strategy.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/routing/strategies (the `PostRoutingStrategy` operationId).
	PostRoutingStrategy(ctx context.Context, body PostRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRoutingStrategy Get routing strategy
	//
	// Returns the routing strategy.
	//
	// Corresponds with GET /api/routing/strategies/{strategyId} (the `GetRoutingStrategy` operationId).
	GetRoutingStrategy(ctx context.Context, strategyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutRoutingStrategyWithBody Update routing strategy
	//
	// Updates a routing strategy.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/routing/strategies/{strategyId} (the `PutRoutingStrategy` operationId).
	PutRoutingStrategyWithBody(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutRoutingStrategy Update routing strategy
	//
	// Updates a routing strategy.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/routing/strategies/{strategyId} (the `PutRoutingStrategy` operationId).
	PutRoutingStrategy(ctx context.Context, strategyId string, body PutRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ActionsRoutingStrategyWithBody Call routing strategy action
	//
	// Performs an action on a routing strategy.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/actions (the `ActionsRoutingStrategy` operationId).
	ActionsRoutingStrategyWithBody(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ActionsRoutingStrategy Call routing strategy action
	//
	// Performs an action on a routing strategy.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/actions (the `ActionsRoutingStrategy` operationId).
	ActionsRoutingStrategy(ctx context.Context, strategyId string, body ActionsRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EvaluateRoutingStrategyWithBody Evaluate routing strategy
	//
	// Evaluates a routing strategy against a given order.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/evaluation (the `EvaluateRoutingStrategy` operationId).
	EvaluateRoutingStrategyWithBody(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EvaluateRoutingStrategy Evaluate routing strategy
	//
	// Evaluates a routing strategy against a given order.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/evaluation (the `EvaluateRoutingStrategy` operationId).
	EvaluateRoutingStrategy(ctx context.Context, strategyId string, body EvaluateRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EvaluateRoutingStrategyNode Evaluate routing strategy node
	//
	// Evaluates a routing strategy node and return the path.
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/nodes/{nodeId}/evaluation (the `EvaluateRoutingStrategyNode` operationId).
	EvaluateRoutingStrategyNode(ctx context.Context, strategyId string, nodeId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSafetyStocks List safety stocks
	//
	// Corresponds with GET /api/safetystocks (the `GetSafetyStocks` operationId).
	GetSafetyStocks(ctx context.Context, params *GetSafetyStocksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BulkUpdateSafetyStockWithBody Update safety stocks
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/safetystocks (the `BulkUpdateSafetyStock` operationId).
	BulkUpdateSafetyStockWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BulkUpdateSafetyStock Update safety stocks
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/safetystocks (the `BulkUpdateSafetyStock` operationId).
	BulkUpdateSafetyStock(ctx context.Context, body BulkUpdateSafetyStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteSafetyStock Delete safety stock
	//
	// Corresponds with DELETE /api/safetystocks/{safetyStockId} (the `DeleteSafetyStock` operationId).
	DeleteSafetyStock(ctx context.Context, safetyStockId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Status Get status
	//
	// Returns the platform status.
	//
	// Corresponds with GET /api/status (the `Status` operationId).
	Status(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStocks List stocks
	//
	// Corresponds with GET /api/stocks (the `GetStocks` operationId).
	GetStocks(ctx context.Context, params *GetStocksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateStockWithBody Create stock
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/stocks (the `CreateStock` operationId).
	CreateStockWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateStock Create stock
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/stocks (the `CreateStock` operationId).
	CreateStock(ctx context.Context, body CreateStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpsertStocksWithBody Update stocks
	//
	// Update and create many stocks at once.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/stocks (the `UpsertStocks` operationId).
	UpsertStocksWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpsertStocks Update stocks
	//
	// Update and create many stocks at once.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/stocks (the `UpsertStocks` operationId).
	UpsertStocks(ctx context.Context, body UpsertStocksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PerformStocksActionsWithBody Call stock action
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/stocks/actions (the `PerformStocksActions` operationId).
	PerformStocksActionsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PerformStocksActions Call stock action
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/stocks/actions (the `PerformStocksActions` operationId).
	PerformStocksActions(ctx context.Context, body PerformStocksActionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchStockWithBody List stocks (search)
	//
	// Search for Stock.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/stocks/search (the `SearchStock` operationId).
	SearchStockWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchStock List stocks (search)
	//
	// Search for Stock.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/stocks/search (the `SearchStock` operationId).
	SearchStock(ctx context.Context, body SearchStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStockSummaries List stock summaries
	//
	// Get the accumulated Stock for each Article.
	//
	// Corresponds with GET /api/stocks/summaries (the `GetStockSummaries` operationId).
	GetStockSummaries(ctx context.Context, params *GetStockSummariesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteStock Delete stock
	//
	// Corresponds with DELETE /api/stocks/{stockId} (the `DeleteStock` operationId).
	DeleteStock(ctx context.Context, stockId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStock Get stock
	//
	// Corresponds with GET /api/stocks/{stockId} (the `GetStock` operationId).
	GetStock(ctx context.Context, stockId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateStockWithBody Update stock
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/stocks/{stockId} (the `UpdateStock` operationId).
	UpdateStockWithBody(ctx context.Context, stockId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateStock Update stock
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/stocks/{stockId} (the `UpdateStock` operationId).
	UpdateStock(ctx context.Context, stockId string, body UpdateStockJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllUsers List users
	//
	// Corresponds with GET /api/users (the `GetAllUsers` operationId).
	GetAllUsers(ctx context.Context, params *GetAllUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateUserWithBody Creates user
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/users (the `CreateUser` operationId).
	CreateUserWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateUser Creates user
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/users (the `CreateUser` operationId).
	CreateUser(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateMeWithBody Update me user
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Update my own data.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/users/me (the `UpdateMe` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	UpdateMeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateMe Update me user
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Update my own data.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/users/me (the `UpdateMe` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	UpdateMe(ctx context.Context, body UpdateMeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecuteMeActionWithBody Call user action
	//
	// Executes an action to manipulate my user.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/users/me/actions (the `ExecuteMeAction` operationId).
	ExecuteMeActionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecuteMeAction Call user action
	//
	// Executes an action to manipulate my user.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/users/me/actions (the `ExecuteMeAction` operationId).
	ExecuteMeAction(ctx context.Context, body ExecuteMeActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEffectivePermissions Return effective permissions
	//
	// Returns the effective permissions of the user.
	//
	// Corresponds with GET /api/users/me/effectivepermissions (the `GetEffectivePermissions` operationId).
	GetEffectivePermissions(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchUserWithBody List users (search)
	//
	// This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for User
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/users/search (the `SearchUser` operationId).
	SearchUserWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchUser List users (search)
	//
	// This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for User
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/users/search (the `SearchUser` operationId).
	SearchUser(ctx context.Context, body SearchUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteUser Delete user
	//
	// Corresponds with DELETE /api/users/{userId} (the `DeleteUser` operationId).
	DeleteUser(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUser Return user
	//
	// Corresponds with GET /api/users/{userId} (the `GetUser` operationId).
	GetUser(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ChangeUserWithBody Update user
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/users/{userId} (the `ChangeUser` operationId).
	ChangeUserWithBody(ctx context.Context, userId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ChangeUser Update user
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/users/{userId} (the `ChangeUser` operationId).
	ChangeUser(ctx context.Context, userId string, body ChangeUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AssignFacilityWithBody Create facility assignment
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/users/{userId}/assignedFacilities (the `AssignFacility` operationId).
	AssignFacilityWithBody(ctx context.Context, userId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AssignFacility Create facility assignment
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/users/{userId}/assignedFacilities (the `AssignFacility` operationId).
	AssignFacility(ctx context.Context, userId string, body AssignFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUserRoles Get user roles
	//
	// Returns the roles of a user.
	//
	// Corresponds with GET /api/users/{userId}/permissions (the `GetUserRoles` operationId).
	GetUserRoles(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) ActionsRoutingStrategyWithBodyWithResponse added in v0.6.0

func (c *ClientWithResponses) ActionsRoutingStrategyWithBodyWithResponse(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ActionsRoutingStrategyResponse, error)

ActionsRoutingStrategyWithBodyWithResponse Call routing strategy action

Performs an action on a routing strategy.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/strategies/{strategyId}/actions (the `ActionsRoutingStrategy` operationId).

func (*ClientWithResponses) ActionsRoutingStrategyWithResponse added in v0.6.0

func (c *ClientWithResponses) ActionsRoutingStrategyWithResponse(ctx context.Context, strategyId string, body ActionsRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*ActionsRoutingStrategyResponse, error)

ActionsRoutingStrategyWithResponse Call routing strategy action

Performs an action on a routing strategy.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/strategies/{strategyId}/actions (the `ActionsRoutingStrategy` operationId).

func (*ClientWithResponses) AddDiscountToFacilityWithBodyWithResponse

func (c *ClientWithResponses) AddDiscountToFacilityWithBodyWithResponse(ctx context.Context, facilityRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddDiscountToFacilityResponse, error)

AddDiscountToFacilityWithBodyWithResponse Create facility discount

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityRef}/discounts (the `AddDiscountToFacility` operationId).

func (*ClientWithResponses) AddDiscountToFacilityWithResponse

func (c *ClientWithResponses) AddDiscountToFacilityWithResponse(ctx context.Context, facilityRef string, body AddDiscountToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*AddDiscountToFacilityResponse, error)

AddDiscountToFacilityWithResponse Create facility discount

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityRef}/discounts (the `AddDiscountToFacility` operationId).

func (*ClientWithResponses) AddFacilityWithBodyWithResponse

func (c *ClientWithResponses) AddFacilityWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddFacilityResponse, error)

AddFacilityWithBodyWithResponse Create facility

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities (the `AddFacility` operationId).

func (*ClientWithResponses) AddFacilityWithResponse

func (c *ClientWithResponses) AddFacilityWithResponse(ctx context.Context, body AddFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*AddFacilityResponse, error)

AddFacilityWithResponse Create facility

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities (the `AddFacility` operationId).

func (*ClientWithResponses) AddOrderWithBodyWithResponse added in v0.3.0

func (c *ClientWithResponses) AddOrderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddOrderResponse, error)

AddOrderWithBodyWithResponse Create order

Create a new order.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders (the `AddOrder` operationId).

func (*ClientWithResponses) AddOrderWithResponse added in v0.3.0

func (c *ClientWithResponses) AddOrderWithResponse(ctx context.Context, body AddOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*AddOrderResponse, error)

AddOrderWithResponse Create order

Create a new order.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders (the `AddOrder` operationId).

func (*ClientWithResponses) AssignFacilityWithBodyWithResponse

func (c *ClientWithResponses) AssignFacilityWithBodyWithResponse(ctx context.Context, userId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AssignFacilityResponse, error)

AssignFacilityWithBodyWithResponse Create facility assignment

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/users/{userId}/assignedFacilities (the `AssignFacility` operationId).

func (*ClientWithResponses) AssignFacilityWithResponse

func (c *ClientWithResponses) AssignFacilityWithResponse(ctx context.Context, userId string, body AssignFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*AssignFacilityResponse, error)

AssignFacilityWithResponse Create facility assignment

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/users/{userId}/assignedFacilities (the `AssignFacility` operationId).

func (*ClientWithResponses) BulkOrdersActionWithBodyWithResponse added in v0.7.0

func (c *ClientWithResponses) BulkOrdersActionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkOrdersActionResponse, error)

BulkOrdersActionWithBodyWithResponse Call bulk orders action

Bulk action of orders.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders/actions (the `BulkOrdersAction` operationId).

func (*ClientWithResponses) BulkOrdersActionWithResponse added in v0.7.0

func (c *ClientWithResponses) BulkOrdersActionWithResponse(ctx context.Context, body BulkOrdersActionJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkOrdersActionResponse, error)

BulkOrdersActionWithResponse Call bulk orders action

Bulk action of orders.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders/actions (the `BulkOrdersAction` operationId).

func (*ClientWithResponses) BulkUpdateSafetyStockWithBodyWithResponse

func (c *ClientWithResponses) BulkUpdateSafetyStockWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUpdateSafetyStockResponse, error)

BulkUpdateSafetyStockWithBodyWithResponse Update safety stocks

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/safetystocks (the `BulkUpdateSafetyStock` operationId).

func (*ClientWithResponses) BulkUpdateSafetyStockWithResponse

func (c *ClientWithResponses) BulkUpdateSafetyStockWithResponse(ctx context.Context, body BulkUpdateSafetyStockJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpdateSafetyStockResponse, error)

BulkUpdateSafetyStockWithResponse Update safety stocks

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/safetystocks (the `BulkUpdateSafetyStock` operationId).

func (*ClientWithResponses) BulkUpsertListingsWithBodyWithResponse

func (c *ClientWithResponses) BulkUpsertListingsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUpsertListingsResponse, error)

BulkUpsertListingsWithBodyWithResponse Create and update listings

Bulk upsert listings independently of their facility.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/listings (the `BulkUpsertListings` operationId).

func (*ClientWithResponses) BulkUpsertListingsWithResponse

func (c *ClientWithResponses) BulkUpsertListingsWithResponse(ctx context.Context, body BulkUpsertListingsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpsertListingsResponse, error)

BulkUpsertListingsWithResponse Create and update listings

Bulk upsert listings independently of their facility.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/listings (the `BulkUpsertListings` operationId).

func (*ClientWithResponses) CalculateBestCarrierWithBodyWithResponse

func (c *ClientWithResponses) CalculateBestCarrierWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CalculateBestCarrierResponse, error)

CalculateBestCarrierWithBodyWithResponse Calculate best carriers

Calculate prioritized list of recommended carriers for the given facility and input parameters.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityId}/carriers/prioritization (the `CalculateBestCarrier` operationId).

func (*ClientWithResponses) CalculateBestCarrierWithResponse

func (c *ClientWithResponses) CalculateBestCarrierWithResponse(ctx context.Context, facilityId string, body CalculateBestCarrierJSONRequestBody, reqEditors ...RequestEditorFn) (*CalculateBestCarrierResponse, error)

CalculateBestCarrierWithResponse Calculate best carriers

Calculate prioritized list of recommended carriers for the given facility and input parameters.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityId}/carriers/prioritization (the `CalculateBestCarrier` operationId).

func (*ClientWithResponses) ChangeUserWithBodyWithResponse

func (c *ClientWithResponses) ChangeUserWithBodyWithResponse(ctx context.Context, userId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChangeUserResponse, error)

ChangeUserWithBodyWithResponse Update user

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/users/{userId} (the `ChangeUser` operationId).

func (*ClientWithResponses) ChangeUserWithResponse

func (c *ClientWithResponses) ChangeUserWithResponse(ctx context.Context, userId string, body ChangeUserJSONRequestBody, reqEditors ...RequestEditorFn) (*ChangeUserResponse, error)

ChangeUserWithResponse Update user

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/users/{userId} (the `ChangeUser` operationId).

func (*ClientWithResponses) ConnectCarrierToFacilityWithBodyWithResponse

func (c *ClientWithResponses) ConnectCarrierToFacilityWithBodyWithResponse(ctx context.Context, facilityId string, carrierRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConnectCarrierToFacilityResponse, error)

ConnectCarrierToFacilityWithBodyWithResponse Update facility carrier connection

Connect a configured carrier to the facility with given ID.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId}/carriers/{carrierRef} (the `ConnectCarrierToFacility` operationId).

func (*ClientWithResponses) ConnectCarrierToFacilityWithResponse

func (c *ClientWithResponses) ConnectCarrierToFacilityWithResponse(ctx context.Context, facilityId string, carrierRef string, body ConnectCarrierToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*ConnectCarrierToFacilityResponse, error)

ConnectCarrierToFacilityWithResponse Update facility carrier connection

Connect a configured carrier to the facility with given ID.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId}/carriers/{carrierRef} (the `ConnectCarrierToFacility` operationId).

func (*ClientWithResponses) CreateCarrierToFacilityWithBodyWithResponse

func (c *ClientWithResponses) CreateCarrierToFacilityWithBodyWithResponse(ctx context.Context, facilityId string, carrierRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCarrierToFacilityResponse, error)

CreateCarrierToFacilityWithBodyWithResponse Create facility carrier connection

Create a connection of a configured carrier to the facility with given ID.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityId}/carriers/{carrierRef} (the `CreateCarrierToFacility` operationId).

func (*ClientWithResponses) CreateCarrierToFacilityWithResponse

func (c *ClientWithResponses) CreateCarrierToFacilityWithResponse(ctx context.Context, facilityId string, carrierRef string, body CreateCarrierToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCarrierToFacilityResponse, error)

CreateCarrierToFacilityWithResponse Create facility carrier connection

Create a connection of a configured carrier to the facility with given ID.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityId}/carriers/{carrierRef} (the `CreateCarrierToFacility` operationId).

func (*ClientWithResponses) CreateConnectionToFacilityWithBodyWithResponse

func (c *ClientWithResponses) CreateConnectionToFacilityWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateConnectionToFacilityResponse, error)

CreateConnectionToFacilityWithBodyWithResponse Create facility connection

Create a connections for a supplier facility with given ID.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityId}/connections (the `CreateConnectionToFacility` operationId).

func (*ClientWithResponses) CreateConnectionToFacilityWithResponse

func (c *ClientWithResponses) CreateConnectionToFacilityWithResponse(ctx context.Context, facilityId string, body CreateConnectionToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateConnectionToFacilityResponse, error)

CreateConnectionToFacilityWithResponse Create facility connection

Create a connections for a supplier facility with given ID.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityId}/connections (the `CreateConnectionToFacility` operationId).

func (*ClientWithResponses) CreateRoleWithBodyWithResponse

func (c *ClientWithResponses) CreateRoleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRoleResponse, error)

CreateRoleWithBodyWithResponse Create role

Creates a new custom role.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/roles (the `CreateRole` operationId).

func (*ClientWithResponses) CreateRoleWithResponse

func (c *ClientWithResponses) CreateRoleWithResponse(ctx context.Context, body CreateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRoleResponse, error)

CreateRoleWithResponse Create role

Creates a new custom role.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/roles (the `CreateRole` operationId).

func (*ClientWithResponses) CreateSourcingOptionsRequestWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) CreateSourcingOptionsRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSourcingOptionsRequestResponse, error)

CreateSourcingOptionsRequestWithBodyWithResponse Create sourcing option

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/sourcingoptions (the `CreateSourcingOptionsRequest` operationId).

func (*ClientWithResponses) CreateSourcingOptionsRequestWithResponse added in v0.2.0

func (c *ClientWithResponses) CreateSourcingOptionsRequestWithResponse(ctx context.Context, body CreateSourcingOptionsRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSourcingOptionsRequestResponse, error)

CreateSourcingOptionsRequestWithResponse Create sourcing option

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/sourcingoptions (the `CreateSourcingOptionsRequest` operationId).

func (*ClientWithResponses) CreateStockWithBodyWithResponse

func (c *ClientWithResponses) CreateStockWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStockResponse, error)

CreateStockWithBodyWithResponse Create stock

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/stocks (the `CreateStock` operationId).

func (*ClientWithResponses) CreateStockWithResponse

func (c *ClientWithResponses) CreateStockWithResponse(ctx context.Context, body CreateStockJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStockResponse, error)

CreateStockWithResponse Create stock

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/stocks (the `CreateStock` operationId).

func (*ClientWithResponses) CreateUserWithBodyWithResponse

func (c *ClientWithResponses) CreateUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)

CreateUserWithBodyWithResponse Creates user

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/users (the `CreateUser` operationId).

func (*ClientWithResponses) CreateUserWithResponse

func (c *ClientWithResponses) CreateUserWithResponse(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)

CreateUserWithResponse Creates user

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/users (the `CreateUser` operationId).

func (*ClientWithResponses) DeleteDiscountForFacilityWithResponse

func (c *ClientWithResponses) DeleteDiscountForFacilityWithResponse(ctx context.Context, facilityRef string, facilityDiscountRef string, reqEditors ...RequestEditorFn) (*DeleteDiscountForFacilityResponse, error)

DeleteDiscountForFacilityWithResponse Delete facility discount

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `DeleteDiscountForFacility` operationId).

func (*ClientWithResponses) DeleteFacilityConnectionWithResponse

func (c *ClientWithResponses) DeleteFacilityConnectionWithResponse(ctx context.Context, facilityId string, connectionId string, reqEditors ...RequestEditorFn) (*DeleteFacilityConnectionResponse, error)

DeleteFacilityConnectionWithResponse Delete facility connection

Delete the connection for facility with the given ID.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/facilities/{facilityId}/connections/{connectionId} (the `DeleteFacilityConnection` operationId).

func (*ClientWithResponses) DeleteFacilityListingPartialStockWithResponse deprecated

func (c *ClientWithResponses) DeleteFacilityListingPartialStockWithResponse(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*DeleteFacilityListingPartialStockResponse, error)

DeleteFacilityListingPartialStockWithResponse Delete listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `DeleteFacilityListingPartialStock` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) DeleteFacilityListingWithResponse

func (c *ClientWithResponses) DeleteFacilityListingWithResponse(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*DeleteFacilityListingResponse, error)

DeleteFacilityListingWithResponse Delete listing

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/facilities/{facilityId}/listings/{tenantArticleId} (the `DeleteFacilityListing` operationId).

func (*ClientWithResponses) DeleteFacilityWithResponse

func (c *ClientWithResponses) DeleteFacilityWithResponse(ctx context.Context, facilityId string, params *DeleteFacilityParams, reqEditors ...RequestEditorFn) (*DeleteFacilityResponse, error)

DeleteFacilityWithResponse Delete facility

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/facilities/{facilityId} (the `DeleteFacility` operationId).

func (*ClientWithResponses) DeleteListingsOfFacilityWithResponse

func (c *ClientWithResponses) DeleteListingsOfFacilityWithResponse(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*DeleteListingsOfFacilityResponse, error)

DeleteListingsOfFacilityWithResponse Delete listings

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/facilities/{facilityId}/listings (the `DeleteListingsOfFacility` operationId).

func (*ClientWithResponses) DeleteRoleWithResponse

func (c *ClientWithResponses) DeleteRoleWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*DeleteRoleResponse, error)

DeleteRoleWithResponse Delete role

Deletes an existing role.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/roles/{name} (the `DeleteRole` operationId).

func (*ClientWithResponses) DeleteRoutingStrategyNodeConfigCategoryWithResponse added in v0.6.0

func (c *ClientWithResponses) DeleteRoutingStrategyNodeConfigCategoryWithResponse(ctx context.Context, categoryId string, reqEditors ...RequestEditorFn) (*DeleteRoutingStrategyNodeConfigCategoryResponse, error)

DeleteRoutingStrategyNodeConfigCategoryWithResponse Delete category node configuration

Deletes the category.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/routing/nodeconfigcategories/{categoryId} (the `DeleteRoutingStrategyNodeConfigCategory` operationId).

func (*ClientWithResponses) DeleteSafetyStockWithResponse

func (c *ClientWithResponses) DeleteSafetyStockWithResponse(ctx context.Context, safetyStockId string, reqEditors ...RequestEditorFn) (*DeleteSafetyStockResponse, error)

DeleteSafetyStockWithResponse Delete safety stock

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/safetystocks/{safetyStockId} (the `DeleteSafetyStock` operationId).

func (*ClientWithResponses) DeleteStockWithResponse

func (c *ClientWithResponses) DeleteStockWithResponse(ctx context.Context, stockId string, reqEditors ...RequestEditorFn) (*DeleteStockResponse, error)

DeleteStockWithResponse Delete stock

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/stocks/{stockId} (the `DeleteStock` operationId).

func (*ClientWithResponses) DeleteUserWithResponse

func (c *ClientWithResponses) DeleteUserWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*DeleteUserResponse, error)

DeleteUserWithResponse Delete user

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/users/{userId} (the `DeleteUser` operationId).

func (*ClientWithResponses) EvaluateRoutingStrategyNodeWithResponse added in v0.6.0

func (c *ClientWithResponses) EvaluateRoutingStrategyNodeWithResponse(ctx context.Context, strategyId string, nodeId string, reqEditors ...RequestEditorFn) (*EvaluateRoutingStrategyNodeResponse, error)

EvaluateRoutingStrategyNodeWithResponse Evaluate routing strategy node

Evaluates a routing strategy node and return the path.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/strategies/{strategyId}/nodes/{nodeId}/evaluation (the `EvaluateRoutingStrategyNode` operationId).

func (*ClientWithResponses) EvaluateRoutingStrategyWithBodyWithResponse added in v0.6.0

func (c *ClientWithResponses) EvaluateRoutingStrategyWithBodyWithResponse(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EvaluateRoutingStrategyResponse, error)

EvaluateRoutingStrategyWithBodyWithResponse Evaluate routing strategy

Evaluates a routing strategy against a given order.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/strategies/{strategyId}/evaluation (the `EvaluateRoutingStrategy` operationId).

func (*ClientWithResponses) EvaluateRoutingStrategyWithResponse added in v0.6.0

func (c *ClientWithResponses) EvaluateRoutingStrategyWithResponse(ctx context.Context, strategyId string, body EvaluateRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*EvaluateRoutingStrategyResponse, error)

EvaluateRoutingStrategyWithResponse Evaluate routing strategy

Evaluates a routing strategy against a given order.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/strategies/{strategyId}/evaluation (the `EvaluateRoutingStrategy` operationId).

func (*ClientWithResponses) ExecuteMeActionWithBodyWithResponse

func (c *ClientWithResponses) ExecuteMeActionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteMeActionResponse, error)

ExecuteMeActionWithBodyWithResponse Call user action

Executes an action to manipulate my user.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/users/me/actions (the `ExecuteMeAction` operationId).

func (*ClientWithResponses) ExecuteMeActionWithResponse

func (c *ClientWithResponses) ExecuteMeActionWithResponse(ctx context.Context, body ExecuteMeActionJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteMeActionResponse, error)

ExecuteMeActionWithResponse Call user action

Executes an action to manipulate my user.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/users/me/actions (the `ExecuteMeAction` operationId).

func (*ClientWithResponses) FacilityActionWithBodyWithResponse

func (c *ClientWithResponses) FacilityActionWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FacilityActionResponse, error)

FacilityActionWithBodyWithResponse Call facility action

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityId}/actions (the `FacilityAction` operationId).

func (*ClientWithResponses) FacilityActionWithResponse

func (c *ClientWithResponses) FacilityActionWithResponse(ctx context.Context, facilityId string, body FacilityActionJSONRequestBody, reqEditors ...RequestEditorFn) (*FacilityActionResponse, error)

FacilityActionWithResponse Call facility action

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/{facilityId}/actions (the `FacilityAction` operationId).

func (*ClientWithResponses) GetAllFacilitiesWithResponse

func (c *ClientWithResponses) GetAllFacilitiesWithResponse(ctx context.Context, params *GetAllFacilitiesParams, reqEditors ...RequestEditorFn) (*GetAllFacilitiesResponse, error)

GetAllFacilitiesWithResponse List facilities

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities (the `GetAllFacilities` operationId).

func (*ClientWithResponses) GetAllOrdersWithResponse added in v0.3.0

func (c *ClientWithResponses) GetAllOrdersWithResponse(ctx context.Context, params *GetAllOrdersParams, reqEditors ...RequestEditorFn) (*GetAllOrdersResponse, error)

GetAllOrdersWithResponse List orders

List orders with optional filtering by tenant order ID or consumer ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/orders (the `GetAllOrders` operationId).

func (*ClientWithResponses) GetAllRolesWithResponse

func (c *ClientWithResponses) GetAllRolesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAllRolesResponse, error)

GetAllRolesWithResponse List roles

Returns all existing roles, including their permissions and context ceilings.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/roles (the `GetAllRoles` operationId).

func (*ClientWithResponses) GetAllUsersWithResponse

func (c *ClientWithResponses) GetAllUsersWithResponse(ctx context.Context, params *GetAllUsersParams, reqEditors ...RequestEditorFn) (*GetAllUsersResponse, error)

GetAllUsersWithResponse List users

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/users (the `GetAllUsers` operationId).

func (*ClientWithResponses) GetArticlesWithResponse deprecated

func (c *ClientWithResponses) GetArticlesWithResponse(ctx context.Context, params *GetArticlesParams, reqEditors ...RequestEditorFn) (*GetArticlesResponse, error)

GetArticlesWithResponse List articles

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search articles tenant-wide based on title or tenantArticleId

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/articles (the `GetArticles` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) GetDiscountForFacilityWithResponse

func (c *ClientWithResponses) GetDiscountForFacilityWithResponse(ctx context.Context, facilityRef string, facilityDiscountRef string, reqEditors ...RequestEditorFn) (*GetDiscountForFacilityResponse, error)

GetDiscountForFacilityWithResponse Get facility discount

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `GetDiscountForFacility` operationId).

func (*ClientWithResponses) GetDiscountsForFacilityWithResponse

func (c *ClientWithResponses) GetDiscountsForFacilityWithResponse(ctx context.Context, facilityRef string, params *GetDiscountsForFacilityParams, reqEditors ...RequestEditorFn) (*GetDiscountsForFacilityResponse, error)

GetDiscountsForFacilityWithResponse List facility discounts

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityRef}/discounts (the `GetDiscountsForFacility` operationId).

func (*ClientWithResponses) GetEffectivePermissionsWithResponse

func (c *ClientWithResponses) GetEffectivePermissionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetEffectivePermissionsResponse, error)

GetEffectivePermissionsWithResponse Return effective permissions

Returns the effective permissions of the user.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/users/me/effectivepermissions (the `GetEffectivePermissions` operationId).

func (*ClientWithResponses) GetFacilityCarrierWithResponse

func (c *ClientWithResponses) GetFacilityCarrierWithResponse(ctx context.Context, facilityId string, carrierRef string, reqEditors ...RequestEditorFn) (*GetFacilityCarrierResponse, error)

GetFacilityCarrierWithResponse Get facility carrier connection

Get the details for a carrier related to the facility with the given ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityId}/carriers/{carrierRef} (the `GetFacilityCarrier` operationId).

func (*ClientWithResponses) GetFacilityConnectionWithResponse

func (c *ClientWithResponses) GetFacilityConnectionWithResponse(ctx context.Context, facilityId string, connectionId string, params *GetFacilityConnectionParams, reqEditors ...RequestEditorFn) (*GetFacilityConnectionResponse, error)

GetFacilityConnectionWithResponse Get facility connection

Get the details for a facility connection related to the facility with the given ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityId}/connections/{connectionId} (the `GetFacilityConnection` operationId).

func (*ClientWithResponses) GetFacilityConnectionsWithResponse

func (c *ClientWithResponses) GetFacilityConnectionsWithResponse(ctx context.Context, facilityId string, params *GetFacilityConnectionsParams, reqEditors ...RequestEditorFn) (*GetFacilityConnectionsResponse, error)

GetFacilityConnectionsWithResponse List facility connections

Get the details for all connections related to the facility with the given ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityId}/connections (the `GetFacilityConnections` operationId).

func (*ClientWithResponses) GetFacilityListingPartialStockWithResponse deprecated

func (c *ClientWithResponses) GetFacilityListingPartialStockWithResponse(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*GetFacilityListingPartialStockResponse, error)

GetFacilityListingPartialStockWithResponse List listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `GetFacilityListingPartialStock` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) GetFacilityListingWithResponse

func (c *ClientWithResponses) GetFacilityListingWithResponse(ctx context.Context, facilityId string, params *GetFacilityListingParams, reqEditors ...RequestEditorFn) (*GetFacilityListingResponse, error)

GetFacilityListingWithResponse List listings

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityId}/listings (the `GetFacilityListing` operationId).

func (*ClientWithResponses) GetFacilityWithResponse

func (c *ClientWithResponses) GetFacilityWithResponse(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*GetFacilityResponse, error)

GetFacilityWithResponse Get facility

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityId} (the `GetFacility` operationId).

func (*ClientWithResponses) GetForecastsForArticleWithResponse

func (c *ClientWithResponses) GetForecastsForArticleWithResponse(ctx context.Context, tenantArticleId string, params *GetForecastsForArticleParams, reqEditors ...RequestEditorFn) (*GetForecastsForArticleResponse, error)

GetForecastsForArticleWithResponse Get article forecast

This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Get the forecast for a specific tenantArticleId

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/articles/{tenantArticleId}/forecasts (the `GetForecastsForArticle` operationId).

func (*ClientWithResponses) GetListingWithResponse

func (c *ClientWithResponses) GetListingWithResponse(ctx context.Context, facilityId string, tenantArticleId string, params *GetListingParams, reqEditors ...RequestEditorFn) (*GetListingResponse, error)

GetListingWithResponse Get listing

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityId}/listings/{tenantArticleId} (the `GetListing` operationId).

func (*ClientWithResponses) GetOrderWithResponse added in v0.3.0

func (c *ClientWithResponses) GetOrderWithResponse(ctx context.Context, orderId string, reqEditors ...RequestEditorFn) (*GetOrderResponse, error)

GetOrderWithResponse Get order

Get a specific order by ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/orders/{orderId} (the `GetOrder` operationId).

func (*ClientWithResponses) GetPermissionsWithResponse

func (c *ClientWithResponses) GetPermissionsWithResponse(ctx context.Context, params *GetPermissionsParams, reqEditors ...RequestEditorFn) (*GetPermissionsResponse, error)

GetPermissionsWithResponse List permissions

This endpoint returns all available permissions in the FFT platform.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/permissions (the `GetPermissions` operationId).

func (*ClientWithResponses) GetRoleWithResponse

func (c *ClientWithResponses) GetRoleWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetRoleResponse, error)

GetRoleWithResponse Return role

Returns a role requested by its name.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/roles/{name} (the `GetRole` operationId).

func (*ClientWithResponses) GetRoutingDecisionLogsWithResponse added in v0.6.0

func (c *ClientWithResponses) GetRoutingDecisionLogsWithResponse(ctx context.Context, params *GetRoutingDecisionLogsParams, reqEditors ...RequestEditorFn) (*GetRoutingDecisionLogsResponse, error)

GetRoutingDecisionLogsWithResponse Get routing decision logs

This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Retrieves in-depth information about the complex routing with combinatorics

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/routing/decisionlogs (the `GetRoutingDecisionLogs` operationId).

func (*ClientWithResponses) GetRoutingStrategiesWithResponse added in v0.6.0

func (c *ClientWithResponses) GetRoutingStrategiesWithResponse(ctx context.Context, params *GetRoutingStrategiesParams, reqEditors ...RequestEditorFn) (*GetRoutingStrategiesResponse, error)

GetRoutingStrategiesWithResponse List routing strategies

List all existing routing strategies.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/routing/strategies (the `GetRoutingStrategies` operationId).

func (*ClientWithResponses) GetRoutingStrategyNodeConfigCategoriesWithResponse added in v0.6.0

func (c *ClientWithResponses) GetRoutingStrategyNodeConfigCategoriesWithResponse(ctx context.Context, params *GetRoutingStrategyNodeConfigCategoriesParams, reqEditors ...RequestEditorFn) (*GetRoutingStrategyNodeConfigCategoriesResponse, error)

GetRoutingStrategyNodeConfigCategoriesWithResponse List category node configuration

List all the categories for node configurations.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/routing/nodeconfigcategories (the `GetRoutingStrategyNodeConfigCategories` operationId).

func (*ClientWithResponses) GetRoutingStrategyNodeConfigCategoryWithResponse added in v0.6.0

func (c *ClientWithResponses) GetRoutingStrategyNodeConfigCategoryWithResponse(ctx context.Context, categoryId string, reqEditors ...RequestEditorFn) (*GetRoutingStrategyNodeConfigCategoryResponse, error)

GetRoutingStrategyNodeConfigCategoryWithResponse Returns category node configuration

Returns the category.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/routing/nodeconfigcategories/{categoryId} (the `GetRoutingStrategyNodeConfigCategory` operationId).

func (*ClientWithResponses) GetRoutingStrategyWithResponse added in v0.6.0

func (c *ClientWithResponses) GetRoutingStrategyWithResponse(ctx context.Context, strategyId string, reqEditors ...RequestEditorFn) (*GetRoutingStrategyResponse, error)

GetRoutingStrategyWithResponse Get routing strategy

Returns the routing strategy.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/routing/strategies/{strategyId} (the `GetRoutingStrategy` operationId).

func (*ClientWithResponses) GetSafetyStocksWithResponse

func (c *ClientWithResponses) GetSafetyStocksWithResponse(ctx context.Context, params *GetSafetyStocksParams, reqEditors ...RequestEditorFn) (*GetSafetyStocksResponse, error)

GetSafetyStocksWithResponse List safety stocks

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/safetystocks (the `GetSafetyStocks` operationId).

func (*ClientWithResponses) GetSourcingOptionWithResponse added in v0.2.0

func (c *ClientWithResponses) GetSourcingOptionWithResponse(ctx context.Context, sourcingOptionsRequestId string, reqEditors ...RequestEditorFn) (*GetSourcingOptionResponse, error)

GetSourcingOptionWithResponse Get sourcing option

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/routing/sourcingoptions/{sourcingOptionsRequestId} (the `GetSourcingOption` operationId).

func (*ClientWithResponses) GetStockDistributionWithResponse

func (c *ClientWithResponses) GetStockDistributionWithResponse(ctx context.Context, tenantArticleId string, params *GetStockDistributionParams, reqEditors ...RequestEditorFn) (*GetStockDistributionResponse, error)

GetStockDistributionWithResponse Get article stock distribution

Stock per Facility for a specific tenantArticleId, also includes the Tenant-Wide Summary

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/articles/{tenantArticleId}/stockdistribution (the `GetStockDistribution` operationId).

func (*ClientWithResponses) GetStockSummariesWithResponse

func (c *ClientWithResponses) GetStockSummariesWithResponse(ctx context.Context, params *GetStockSummariesParams, reqEditors ...RequestEditorFn) (*GetStockSummariesResponse, error)

GetStockSummariesWithResponse List stock summaries

Get the accumulated Stock for each Article.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/stocks/summaries (the `GetStockSummaries` operationId).

func (*ClientWithResponses) GetStockWithResponse

func (c *ClientWithResponses) GetStockWithResponse(ctx context.Context, stockId string, reqEditors ...RequestEditorFn) (*GetStockResponse, error)

GetStockWithResponse Get stock

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/stocks/{stockId} (the `GetStock` operationId).

func (*ClientWithResponses) GetStocksWithResponse

func (c *ClientWithResponses) GetStocksWithResponse(ctx context.Context, params *GetStocksParams, reqEditors ...RequestEditorFn) (*GetStocksResponse, error)

GetStocksWithResponse List stocks

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/stocks (the `GetStocks` operationId).

func (*ClientWithResponses) GetUserRolesWithResponse

func (c *ClientWithResponses) GetUserRolesWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*GetUserRolesResponse, error)

GetUserRolesWithResponse Get user roles

Returns the roles of a user.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/users/{userId}/permissions (the `GetUserRoles` operationId).

func (*ClientWithResponses) GetUserWithResponse

func (c *ClientWithResponses) GetUserWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*GetUserResponse, error)

GetUserWithResponse Return user

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/users/{userId} (the `GetUser` operationId).

func (*ClientWithResponses) HealthCheckWithResponse

func (c *ClientWithResponses) HealthCheckWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthCheckResponse, error)

HealthCheckWithResponse Health check

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/health (the `HealthCheck` operationId).

func (*ClientWithResponses) ListFacilityCarriersWithResponse

func (c *ClientWithResponses) ListFacilityCarriersWithResponse(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*ListFacilityCarriersResponse, error)

ListFacilityCarriersWithResponse List facility carrier connections

List all carrier connections configured for the given facility.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/facilities/{facilityId}/carriers (the `ListFacilityCarriers` operationId).

func (*ClientWithResponses) OrderActionWithBodyWithResponse added in v0.3.0

func (c *ClientWithResponses) OrderActionWithBodyWithResponse(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*OrderActionResponse, error)

OrderActionWithBodyWithResponse Call order action

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders/{orderId}/actions (the `OrderAction` operationId).

func (*ClientWithResponses) OrderActionWithResponse added in v0.3.0

func (c *ClientWithResponses) OrderActionWithResponse(ctx context.Context, orderId string, body OrderActionJSONRequestBody, reqEditors ...RequestEditorFn) (*OrderActionResponse, error)

OrderActionWithResponse Call order action

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders/{orderId}/actions (the `OrderAction` operationId).

func (*ClientWithResponses) OrderLineItemActionWithBodyWithResponse added in v0.3.0

func (c *ClientWithResponses) OrderLineItemActionWithBodyWithResponse(ctx context.Context, orderId string, orderLineItemId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*OrderLineItemActionResponse, error)

OrderLineItemActionWithBodyWithResponse Call order line item action

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions (the `OrderLineItemAction` operationId).

func (*ClientWithResponses) OrderLineItemActionWithResponse added in v0.3.0

func (c *ClientWithResponses) OrderLineItemActionWithResponse(ctx context.Context, orderId string, orderLineItemId string, body OrderLineItemActionJSONRequestBody, reqEditors ...RequestEditorFn) (*OrderLineItemActionResponse, error)

OrderLineItemActionWithResponse Call order line item action

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions (the `OrderLineItemAction` operationId).

func (*ClientWithResponses) PatchFacilityListingPartialStockWithBodyWithResponse deprecated

func (c *ClientWithResponses) PatchFacilityListingPartialStockWithBodyWithResponse(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchFacilityListingPartialStockResponse, error)

PatchFacilityListingPartialStockWithBodyWithResponse Update listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead. Adds new partial stocks, updates existing partial stocks and keeps stocks that are previously present in the database.

1. If a stock exists in the patch action but not in the database it is added. 2. If a stock exists both in the patch action and in the database it is updated and the contents are merged. 3. If a stock exists only in the database, it is left untouched.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PatchFacilityListingPartialStock` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) PatchFacilityListingPartialStockWithResponse

func (c *ClientWithResponses) PatchFacilityListingPartialStockWithResponse(ctx context.Context, facilityId string, tenantArticleId string, body PatchFacilityListingPartialStockJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchFacilityListingPartialStockResponse, error)

PatchFacilityListingPartialStockWithResponse Update listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead. Adds new partial stocks, updates existing partial stocks and keeps stocks that are previously present in the database.

1. If a stock exists in the patch action but not in the database it is added. 2. If a stock exists both in the patch action and in the database it is updated and the contents are merged. 3. If a stock exists only in the database, it is left untouched.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PatchFacilityListingPartialStock` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) PatchFacilityListingWithBodyWithResponse

func (c *ClientWithResponses) PatchFacilityListingWithBodyWithResponse(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchFacilityListingResponse, error)

PatchFacilityListingWithBodyWithResponse Update listing

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId} (the `PatchFacilityListing` operationId).

func (*ClientWithResponses) PatchFacilityListingWithResponse

func (c *ClientWithResponses) PatchFacilityListingWithResponse(ctx context.Context, facilityId string, tenantArticleId string, body PatchFacilityListingJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchFacilityListingResponse, error)

PatchFacilityListingWithResponse Update listing

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId} (the `PatchFacilityListing` operationId).

func (*ClientWithResponses) PatchFacilityWithBodyWithResponse

func (c *ClientWithResponses) PatchFacilityWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchFacilityResponse, error)

PatchFacilityWithBodyWithResponse Update facility

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/facilities/{facilityId} (the `PatchFacility` operationId).

func (*ClientWithResponses) PatchFacilityWithResponse

func (c *ClientWithResponses) PatchFacilityWithResponse(ctx context.Context, facilityId string, body PatchFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchFacilityResponse, error)

PatchFacilityWithResponse Update facility

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/facilities/{facilityId} (the `PatchFacility` operationId).

func (*ClientWithResponses) PatchRoleWithBodyWithResponse

func (c *ClientWithResponses) PatchRoleWithBodyWithResponse(ctx context.Context, name string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchRoleResponse, error)

PatchRoleWithBodyWithResponse Update role

Updates an existing role (partial update).

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/roles/{name} (the `PatchRole` operationId).

func (*ClientWithResponses) PatchRoleWithResponse

func (c *ClientWithResponses) PatchRoleWithResponse(ctx context.Context, name string, body PatchRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchRoleResponse, error)

PatchRoleWithResponse Update role

Updates an existing role (partial update).

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/roles/{name} (the `PatchRole` operationId).

func (*ClientWithResponses) PerformStocksActionsWithBodyWithResponse

func (c *ClientWithResponses) PerformStocksActionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PerformStocksActionsResponse, error)

PerformStocksActionsWithBodyWithResponse Call stock action

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/stocks/actions (the `PerformStocksActions` operationId).

func (*ClientWithResponses) PerformStocksActionsWithResponse

func (c *ClientWithResponses) PerformStocksActionsWithResponse(ctx context.Context, body PerformStocksActionsJSONRequestBody, reqEditors ...RequestEditorFn) (*PerformStocksActionsResponse, error)

PerformStocksActionsWithResponse Call stock action

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/stocks/actions (the `PerformStocksActions` operationId).

func (*ClientWithResponses) PostDeliveryPromiseWithBodyWithResponse added in v0.3.0

func (c *ClientWithResponses) PostDeliveryPromiseWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostDeliveryPromiseResponse, error)

PostDeliveryPromiseWithBodyWithResponse Create promise order

Endpoint to create a promise order.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/promises/deliverypromise (the `PostDeliveryPromise` operationId).

func (*ClientWithResponses) PostDeliveryPromiseWithResponse added in v0.3.0

func (c *ClientWithResponses) PostDeliveryPromiseWithResponse(ctx context.Context, body PostDeliveryPromiseJSONRequestBody, reqEditors ...RequestEditorFn) (*PostDeliveryPromiseResponse, error)

PostDeliveryPromiseWithResponse Create promise order

Endpoint to create a promise order.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/promises/deliverypromise (the `PostDeliveryPromise` operationId).

func (*ClientWithResponses) PostRoutingStrategyNodeConfigCategoryWithBodyWithResponse added in v0.6.0

func (c *ClientWithResponses) PostRoutingStrategyNodeConfigCategoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostRoutingStrategyNodeConfigCategoryResponse, error)

PostRoutingStrategyNodeConfigCategoryWithBodyWithResponse Create category node configuration

Creates a new category for a routing strategies node config.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/nodeconfigcategories (the `PostRoutingStrategyNodeConfigCategory` operationId).

func (*ClientWithResponses) PostRoutingStrategyNodeConfigCategoryWithResponse added in v0.6.0

PostRoutingStrategyNodeConfigCategoryWithResponse Create category node configuration

Creates a new category for a routing strategies node config.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/nodeconfigcategories (the `PostRoutingStrategyNodeConfigCategory` operationId).

func (*ClientWithResponses) PostRoutingStrategyWithBodyWithResponse added in v0.6.0

func (c *ClientWithResponses) PostRoutingStrategyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostRoutingStrategyResponse, error)

PostRoutingStrategyWithBodyWithResponse Create routing strategy

Creates a new revision of the routing strategy.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/strategies (the `PostRoutingStrategy` operationId).

func (*ClientWithResponses) PostRoutingStrategyWithResponse added in v0.6.0

func (c *ClientWithResponses) PostRoutingStrategyWithResponse(ctx context.Context, body PostRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*PostRoutingStrategyResponse, error)

PostRoutingStrategyWithResponse Create routing strategy

Creates a new revision of the routing strategy.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/routing/strategies (the `PostRoutingStrategy` operationId).

func (*ClientWithResponses) PutFacilityListingPartialStockWithBodyWithResponse deprecated

func (c *ClientWithResponses) PutFacilityListingPartialStockWithBodyWithResponse(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutFacilityListingPartialStockResponse, error)

PutFacilityListingPartialStockWithBodyWithResponse Update listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead. Replaces the current partial stock object related to its listing

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PutFacilityListingPartialStock` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) PutFacilityListingPartialStockWithResponse

func (c *ClientWithResponses) PutFacilityListingPartialStockWithResponse(ctx context.Context, facilityId string, tenantArticleId string, body PutFacilityListingPartialStockJSONRequestBody, reqEditors ...RequestEditorFn) (*PutFacilityListingPartialStockResponse, error)

PutFacilityListingPartialStockWithResponse Update listing partial stocks

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead. Replaces the current partial stock object related to its listing

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PutFacilityListingPartialStock` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) PutFacilityListingWithBodyWithResponse

func (c *ClientWithResponses) PutFacilityListingWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutFacilityListingResponse, error)

PutFacilityListingWithBodyWithResponse Create and update listings per facility

Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId}/listings (the `PutFacilityListing` operationId).

func (*ClientWithResponses) PutFacilityListingWithResponse

func (c *ClientWithResponses) PutFacilityListingWithResponse(ctx context.Context, facilityId string, body PutFacilityListingJSONRequestBody, reqEditors ...RequestEditorFn) (*PutFacilityListingResponse, error)

PutFacilityListingWithResponse Create and update listings per facility

Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId}/listings (the `PutFacilityListing` operationId).

func (*ClientWithResponses) PutRoutingStrategyNodeConfigCategoryWithBodyWithResponse added in v0.6.0

func (c *ClientWithResponses) PutRoutingStrategyNodeConfigCategoryWithBodyWithResponse(ctx context.Context, categoryId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutRoutingStrategyNodeConfigCategoryResponse, error)

PutRoutingStrategyNodeConfigCategoryWithBodyWithResponse Updates category node configuration

Updates a category.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/routing/nodeconfigcategories/{categoryId} (the `PutRoutingStrategyNodeConfigCategory` operationId).

func (*ClientWithResponses) PutRoutingStrategyNodeConfigCategoryWithResponse added in v0.6.0

func (c *ClientWithResponses) PutRoutingStrategyNodeConfigCategoryWithResponse(ctx context.Context, categoryId string, body PutRoutingStrategyNodeConfigCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*PutRoutingStrategyNodeConfigCategoryResponse, error)

PutRoutingStrategyNodeConfigCategoryWithResponse Updates category node configuration

Updates a category.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/routing/nodeconfigcategories/{categoryId} (the `PutRoutingStrategyNodeConfigCategory` operationId).

func (*ClientWithResponses) PutRoutingStrategyWithBodyWithResponse added in v0.6.0

func (c *ClientWithResponses) PutRoutingStrategyWithBodyWithResponse(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutRoutingStrategyResponse, error)

PutRoutingStrategyWithBodyWithResponse Update routing strategy

Updates a routing strategy.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/routing/strategies/{strategyId} (the `PutRoutingStrategy` operationId).

func (*ClientWithResponses) PutRoutingStrategyWithResponse added in v0.6.0

func (c *ClientWithResponses) PutRoutingStrategyWithResponse(ctx context.Context, strategyId string, body PutRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*PutRoutingStrategyResponse, error)

PutRoutingStrategyWithResponse Update routing strategy

Updates a routing strategy.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/routing/strategies/{strategyId} (the `PutRoutingStrategy` operationId).

func (*ClientWithResponses) ReplaceFacilityWithBodyWithResponse

func (c *ClientWithResponses) ReplaceFacilityWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReplaceFacilityResponse, error)

ReplaceFacilityWithBodyWithResponse Update facility

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId} (the `ReplaceFacility` operationId).

func (*ClientWithResponses) ReplaceFacilityWithResponse

func (c *ClientWithResponses) ReplaceFacilityWithResponse(ctx context.Context, facilityId string, body ReplaceFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*ReplaceFacilityResponse, error)

ReplaceFacilityWithResponse Update facility

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId} (the `ReplaceFacility` operationId).

func (*ClientWithResponses) SearchFacilityWithBodyWithResponse

func (c *ClientWithResponses) SearchFacilityWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchFacilityResponse, error)

SearchFacilityWithBodyWithResponse List facilities (search)

This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for Facility

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/search (the `SearchFacility` operationId).

func (*ClientWithResponses) SearchFacilityWithResponse

func (c *ClientWithResponses) SearchFacilityWithResponse(ctx context.Context, body SearchFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchFacilityResponse, error)

SearchFacilityWithResponse List facilities (search)

This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for Facility

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/facilities/search (the `SearchFacility` operationId).

func (*ClientWithResponses) SearchListingWithBodyWithResponse

func (c *ClientWithResponses) SearchListingWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchListingResponse, error)

SearchListingWithBodyWithResponse List listings (search)

Search for Listing.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/listings/search (the `SearchListing` operationId).

func (*ClientWithResponses) SearchListingWithResponse

func (c *ClientWithResponses) SearchListingWithResponse(ctx context.Context, body SearchListingJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchListingResponse, error)

SearchListingWithResponse List listings (search)

Search for Listing.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/listings/search (the `SearchListing` operationId).

func (*ClientWithResponses) SearchOrderWithBodyWithResponse added in v0.3.0

func (c *ClientWithResponses) SearchOrderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchOrderResponse, error)

SearchOrderWithBodyWithResponse List orders (search)

Search for Order.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders/search (the `SearchOrder` operationId).

func (*ClientWithResponses) SearchOrderWithResponse added in v0.3.0

func (c *ClientWithResponses) SearchOrderWithResponse(ctx context.Context, body SearchOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchOrderResponse, error)

SearchOrderWithResponse List orders (search)

Search for Order.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/orders/search (the `SearchOrder` operationId).

func (*ClientWithResponses) SearchRoleWithBodyWithResponse

func (c *ClientWithResponses) SearchRoleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchRoleResponse, error)

SearchRoleWithBodyWithResponse List roles (search)

Search for Role.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/roles/search (the `SearchRole` operationId).

func (*ClientWithResponses) SearchRoleWithResponse

func (c *ClientWithResponses) SearchRoleWithResponse(ctx context.Context, body SearchRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchRoleResponse, error)

SearchRoleWithResponse List roles (search)

Search for Role.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/roles/search (the `SearchRole` operationId).

func (*ClientWithResponses) SearchStockWithBodyWithResponse

func (c *ClientWithResponses) SearchStockWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchStockResponse, error)

SearchStockWithBodyWithResponse List stocks (search)

Search for Stock.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/stocks/search (the `SearchStock` operationId).

func (*ClientWithResponses) SearchStockWithResponse

func (c *ClientWithResponses) SearchStockWithResponse(ctx context.Context, body SearchStockJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchStockResponse, error)

SearchStockWithResponse List stocks (search)

Search for Stock.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/stocks/search (the `SearchStock` operationId).

func (*ClientWithResponses) SearchUserWithBodyWithResponse

func (c *ClientWithResponses) SearchUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchUserResponse, error)

SearchUserWithBodyWithResponse List users (search)

This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for User

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/users/search (the `SearchUser` operationId).

func (*ClientWithResponses) SearchUserWithResponse

func (c *ClientWithResponses) SearchUserWithResponse(ctx context.Context, body SearchUserJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchUserResponse, error)

SearchUserWithResponse List users (search)

This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for User

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/users/search (the `SearchUser` operationId).

func (*ClientWithResponses) StatusWithResponse

func (c *ClientWithResponses) StatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*StatusResponse, error)

StatusWithResponse Get status

Returns the platform status.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/status (the `Status` operationId).

func (*ClientWithResponses) UpdateDiscountForFacilityWithBodyWithResponse

func (c *ClientWithResponses) UpdateDiscountForFacilityWithBodyWithResponse(ctx context.Context, facilityRef string, facilityDiscountRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDiscountForFacilityResponse, error)

UpdateDiscountForFacilityWithBodyWithResponse Update facility discount

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `UpdateDiscountForFacility` operationId).

func (*ClientWithResponses) UpdateDiscountForFacilityWithResponse

func (c *ClientWithResponses) UpdateDiscountForFacilityWithResponse(ctx context.Context, facilityRef string, facilityDiscountRef string, body UpdateDiscountForFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDiscountForFacilityResponse, error)

UpdateDiscountForFacilityWithResponse Update facility discount

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `UpdateDiscountForFacility` operationId).

func (*ClientWithResponses) UpdateFacilityConnectionWithBodyWithResponse

func (c *ClientWithResponses) UpdateFacilityConnectionWithBodyWithResponse(ctx context.Context, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFacilityConnectionResponse, error)

UpdateFacilityConnectionWithBodyWithResponse Update facility connection

Update the given connection for a facility.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId}/connections/{connectionId} (the `UpdateFacilityConnection` operationId).

func (*ClientWithResponses) UpdateFacilityConnectionWithResponse

func (c *ClientWithResponses) UpdateFacilityConnectionWithResponse(ctx context.Context, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, body UpdateFacilityConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFacilityConnectionResponse, error)

UpdateFacilityConnectionWithResponse Update facility connection

Update the given connection for a facility.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/facilities/{facilityId}/connections/{connectionId} (the `UpdateFacilityConnection` operationId).

func (*ClientWithResponses) UpdateMeWithBodyWithResponse deprecated

func (c *ClientWithResponses) UpdateMeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateMeResponse, error)

UpdateMeWithBodyWithResponse Update me user

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Update my own data.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/users/me (the `UpdateMe` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) UpdateMeWithResponse

func (c *ClientWithResponses) UpdateMeWithResponse(ctx context.Context, body UpdateMeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateMeResponse, error)

UpdateMeWithResponse Update me user

This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Update my own data.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/users/me (the `UpdateMe` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) UpdateOrderWithBodyWithResponse added in v0.3.0

func (c *ClientWithResponses) UpdateOrderWithBodyWithResponse(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrderResponse, error)

UpdateOrderWithBodyWithResponse Update order

Update an existing order.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/orders/{orderId} (the `UpdateOrder` operationId).

func (*ClientWithResponses) UpdateOrderWithResponse added in v0.3.0

func (c *ClientWithResponses) UpdateOrderWithResponse(ctx context.Context, orderId string, body UpdateOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrderResponse, error)

UpdateOrderWithResponse Update order

Update an existing order.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/orders/{orderId} (the `UpdateOrder` operationId).

func (*ClientWithResponses) UpdateRoleWithBodyWithResponse

func (c *ClientWithResponses) UpdateRoleWithBodyWithResponse(ctx context.Context, name string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRoleResponse, error)

UpdateRoleWithBodyWithResponse Update role

Updates an existing role (complete replacement).

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/roles/{name} (the `UpdateRole` operationId).

func (*ClientWithResponses) UpdateRoleWithResponse

func (c *ClientWithResponses) UpdateRoleWithResponse(ctx context.Context, name string, body UpdateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRoleResponse, error)

UpdateRoleWithResponse Update role

Updates an existing role (complete replacement).

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/roles/{name} (the `UpdateRole` operationId).

func (*ClientWithResponses) UpdateStockWithBodyWithResponse

func (c *ClientWithResponses) UpdateStockWithBodyWithResponse(ctx context.Context, stockId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStockResponse, error)

UpdateStockWithBodyWithResponse Update stock

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/stocks/{stockId} (the `UpdateStock` operationId).

func (*ClientWithResponses) UpdateStockWithResponse

func (c *ClientWithResponses) UpdateStockWithResponse(ctx context.Context, stockId string, body UpdateStockJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStockResponse, error)

UpdateStockWithResponse Update stock

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/stocks/{stockId} (the `UpdateStock` operationId).

func (*ClientWithResponses) UpsertStocksWithBodyWithResponse

func (c *ClientWithResponses) UpsertStocksWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertStocksResponse, error)

UpsertStocksWithBodyWithResponse Update stocks

Update and create many stocks at once.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/stocks (the `UpsertStocks` operationId).

func (*ClientWithResponses) UpsertStocksWithResponse

func (c *ClientWithResponses) UpsertStocksWithResponse(ctx context.Context, body UpsertStocksJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertStocksResponse, error)

UpsertStocksWithResponse Update stocks

Update and create many stocks at once.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/stocks (the `UpsertStocks` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// GetArticlesWithResponse List articles
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search articles tenant-wide based on title or tenantArticleId
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/articles (the `GetArticles` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	GetArticlesWithResponse(ctx context.Context, params *GetArticlesParams, reqEditors ...RequestEditorFn) (*GetArticlesResponse, error)

	// GetForecastsForArticleWithResponse Get article forecast
	//
	// This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Get the forecast for a specific tenantArticleId
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/articles/{tenantArticleId}/forecasts (the `GetForecastsForArticle` operationId).
	GetForecastsForArticleWithResponse(ctx context.Context, tenantArticleId string, params *GetForecastsForArticleParams, reqEditors ...RequestEditorFn) (*GetForecastsForArticleResponse, error)

	// GetStockDistributionWithResponse Get article stock distribution
	//
	// Stock per Facility for a specific tenantArticleId, also includes the Tenant-Wide Summary
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/articles/{tenantArticleId}/stockdistribution (the `GetStockDistribution` operationId).
	GetStockDistributionWithResponse(ctx context.Context, tenantArticleId string, params *GetStockDistributionParams, reqEditors ...RequestEditorFn) (*GetStockDistributionResponse, error)

	// GetAllFacilitiesWithResponse List facilities
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities (the `GetAllFacilities` operationId).
	GetAllFacilitiesWithResponse(ctx context.Context, params *GetAllFacilitiesParams, reqEditors ...RequestEditorFn) (*GetAllFacilitiesResponse, error)

	// AddFacilityWithBodyWithResponse Create facility
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities (the `AddFacility` operationId).
	AddFacilityWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddFacilityResponse, error)

	// AddFacilityWithResponse Create facility
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities (the `AddFacility` operationId).
	AddFacilityWithResponse(ctx context.Context, body AddFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*AddFacilityResponse, error)

	// SearchFacilityWithBodyWithResponse List facilities (search)
	//
	// This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for Facility
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/search (the `SearchFacility` operationId).
	SearchFacilityWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchFacilityResponse, error)

	// SearchFacilityWithResponse List facilities (search)
	//
	// This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for Facility
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/search (the `SearchFacility` operationId).
	SearchFacilityWithResponse(ctx context.Context, body SearchFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchFacilityResponse, error)

	// DeleteFacilityWithResponse Delete facility
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/facilities/{facilityId} (the `DeleteFacility` operationId).
	DeleteFacilityWithResponse(ctx context.Context, facilityId string, params *DeleteFacilityParams, reqEditors ...RequestEditorFn) (*DeleteFacilityResponse, error)

	// GetFacilityWithResponse Get facility
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityId} (the `GetFacility` operationId).
	GetFacilityWithResponse(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*GetFacilityResponse, error)

	// PatchFacilityWithBodyWithResponse Update facility
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/facilities/{facilityId} (the `PatchFacility` operationId).
	PatchFacilityWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchFacilityResponse, error)

	// PatchFacilityWithResponse Update facility
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/facilities/{facilityId} (the `PatchFacility` operationId).
	PatchFacilityWithResponse(ctx context.Context, facilityId string, body PatchFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchFacilityResponse, error)

	// ReplaceFacilityWithBodyWithResponse Update facility
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId} (the `ReplaceFacility` operationId).
	ReplaceFacilityWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReplaceFacilityResponse, error)

	// ReplaceFacilityWithResponse Update facility
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId} (the `ReplaceFacility` operationId).
	ReplaceFacilityWithResponse(ctx context.Context, facilityId string, body ReplaceFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*ReplaceFacilityResponse, error)

	// FacilityActionWithBodyWithResponse Call facility action
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityId}/actions (the `FacilityAction` operationId).
	FacilityActionWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FacilityActionResponse, error)

	// FacilityActionWithResponse Call facility action
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityId}/actions (the `FacilityAction` operationId).
	FacilityActionWithResponse(ctx context.Context, facilityId string, body FacilityActionJSONRequestBody, reqEditors ...RequestEditorFn) (*FacilityActionResponse, error)

	// ListFacilityCarriersWithResponse List facility carrier connections
	//
	// List all carrier connections configured for the given facility.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityId}/carriers (the `ListFacilityCarriers` operationId).
	ListFacilityCarriersWithResponse(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*ListFacilityCarriersResponse, error)

	// CalculateBestCarrierWithBodyWithResponse Calculate best carriers
	//
	// Calculate prioritized list of recommended carriers for the given facility and input parameters.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityId}/carriers/prioritization (the `CalculateBestCarrier` operationId).
	CalculateBestCarrierWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CalculateBestCarrierResponse, error)

	// CalculateBestCarrierWithResponse Calculate best carriers
	//
	// Calculate prioritized list of recommended carriers for the given facility and input parameters.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityId}/carriers/prioritization (the `CalculateBestCarrier` operationId).
	CalculateBestCarrierWithResponse(ctx context.Context, facilityId string, body CalculateBestCarrierJSONRequestBody, reqEditors ...RequestEditorFn) (*CalculateBestCarrierResponse, error)

	// GetFacilityCarrierWithResponse Get facility carrier connection
	//
	// Get the details for a carrier related to the facility with the given ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityId}/carriers/{carrierRef} (the `GetFacilityCarrier` operationId).
	GetFacilityCarrierWithResponse(ctx context.Context, facilityId string, carrierRef string, reqEditors ...RequestEditorFn) (*GetFacilityCarrierResponse, error)

	// CreateCarrierToFacilityWithBodyWithResponse Create facility carrier connection
	//
	// Create a connection of a configured carrier to the facility with given ID.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityId}/carriers/{carrierRef} (the `CreateCarrierToFacility` operationId).
	CreateCarrierToFacilityWithBodyWithResponse(ctx context.Context, facilityId string, carrierRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCarrierToFacilityResponse, error)

	// CreateCarrierToFacilityWithResponse Create facility carrier connection
	//
	// Create a connection of a configured carrier to the facility with given ID.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityId}/carriers/{carrierRef} (the `CreateCarrierToFacility` operationId).
	CreateCarrierToFacilityWithResponse(ctx context.Context, facilityId string, carrierRef string, body CreateCarrierToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCarrierToFacilityResponse, error)

	// ConnectCarrierToFacilityWithBodyWithResponse Update facility carrier connection
	//
	// Connect a configured carrier to the facility with given ID.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId}/carriers/{carrierRef} (the `ConnectCarrierToFacility` operationId).
	ConnectCarrierToFacilityWithBodyWithResponse(ctx context.Context, facilityId string, carrierRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConnectCarrierToFacilityResponse, error)

	// ConnectCarrierToFacilityWithResponse Update facility carrier connection
	//
	// Connect a configured carrier to the facility with given ID.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId}/carriers/{carrierRef} (the `ConnectCarrierToFacility` operationId).
	ConnectCarrierToFacilityWithResponse(ctx context.Context, facilityId string, carrierRef string, body ConnectCarrierToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*ConnectCarrierToFacilityResponse, error)

	// GetFacilityConnectionsWithResponse List facility connections
	//
	// Get the details for all connections related to the facility with the given ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityId}/connections (the `GetFacilityConnections` operationId).
	GetFacilityConnectionsWithResponse(ctx context.Context, facilityId string, params *GetFacilityConnectionsParams, reqEditors ...RequestEditorFn) (*GetFacilityConnectionsResponse, error)

	// CreateConnectionToFacilityWithBodyWithResponse Create facility connection
	//
	// Create a connections for a supplier facility with given ID.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityId}/connections (the `CreateConnectionToFacility` operationId).
	CreateConnectionToFacilityWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateConnectionToFacilityResponse, error)

	// CreateConnectionToFacilityWithResponse Create facility connection
	//
	// Create a connections for a supplier facility with given ID.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityId}/connections (the `CreateConnectionToFacility` operationId).
	CreateConnectionToFacilityWithResponse(ctx context.Context, facilityId string, body CreateConnectionToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateConnectionToFacilityResponse, error)

	// DeleteFacilityConnectionWithResponse Delete facility connection
	//
	// Delete the connection for facility with the given ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/facilities/{facilityId}/connections/{connectionId} (the `DeleteFacilityConnection` operationId).
	DeleteFacilityConnectionWithResponse(ctx context.Context, facilityId string, connectionId string, reqEditors ...RequestEditorFn) (*DeleteFacilityConnectionResponse, error)

	// GetFacilityConnectionWithResponse Get facility connection
	//
	// Get the details for a facility connection related to the facility with the given ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityId}/connections/{connectionId} (the `GetFacilityConnection` operationId).
	GetFacilityConnectionWithResponse(ctx context.Context, facilityId string, connectionId string, params *GetFacilityConnectionParams, reqEditors ...RequestEditorFn) (*GetFacilityConnectionResponse, error)

	// UpdateFacilityConnectionWithBodyWithResponse Update facility connection
	//
	// Update the given connection for a facility.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId}/connections/{connectionId} (the `UpdateFacilityConnection` operationId).
	UpdateFacilityConnectionWithBodyWithResponse(ctx context.Context, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFacilityConnectionResponse, error)

	// UpdateFacilityConnectionWithResponse Update facility connection
	//
	// Update the given connection for a facility.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId}/connections/{connectionId} (the `UpdateFacilityConnection` operationId).
	UpdateFacilityConnectionWithResponse(ctx context.Context, facilityId string, connectionId string, params *UpdateFacilityConnectionParams, body UpdateFacilityConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFacilityConnectionResponse, error)

	// DeleteListingsOfFacilityWithResponse Delete listings
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/facilities/{facilityId}/listings (the `DeleteListingsOfFacility` operationId).
	DeleteListingsOfFacilityWithResponse(ctx context.Context, facilityId string, reqEditors ...RequestEditorFn) (*DeleteListingsOfFacilityResponse, error)

	// GetFacilityListingWithResponse List listings
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityId}/listings (the `GetFacilityListing` operationId).
	GetFacilityListingWithResponse(ctx context.Context, facilityId string, params *GetFacilityListingParams, reqEditors ...RequestEditorFn) (*GetFacilityListingResponse, error)

	// PutFacilityListingWithBodyWithResponse Create and update listings per facility
	//
	// Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId}/listings (the `PutFacilityListing` operationId).
	PutFacilityListingWithBodyWithResponse(ctx context.Context, facilityId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutFacilityListingResponse, error)

	// PutFacilityListingWithResponse Create and update listings per facility
	//
	// Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId}/listings (the `PutFacilityListing` operationId).
	PutFacilityListingWithResponse(ctx context.Context, facilityId string, body PutFacilityListingJSONRequestBody, reqEditors ...RequestEditorFn) (*PutFacilityListingResponse, error)

	// DeleteFacilityListingWithResponse Delete listing
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/facilities/{facilityId}/listings/{tenantArticleId} (the `DeleteFacilityListing` operationId).
	DeleteFacilityListingWithResponse(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*DeleteFacilityListingResponse, error)

	// GetListingWithResponse Get listing
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityId}/listings/{tenantArticleId} (the `GetListing` operationId).
	GetListingWithResponse(ctx context.Context, facilityId string, tenantArticleId string, params *GetListingParams, reqEditors ...RequestEditorFn) (*GetListingResponse, error)

	// PatchFacilityListingWithBodyWithResponse Update listing
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId} (the `PatchFacilityListing` operationId).
	PatchFacilityListingWithBodyWithResponse(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchFacilityListingResponse, error)

	// PatchFacilityListingWithResponse Update listing
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId} (the `PatchFacilityListing` operationId).
	PatchFacilityListingWithResponse(ctx context.Context, facilityId string, tenantArticleId string, body PatchFacilityListingJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchFacilityListingResponse, error)

	// DeleteFacilityListingPartialStockWithResponse Delete listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `DeleteFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	DeleteFacilityListingPartialStockWithResponse(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*DeleteFacilityListingPartialStockResponse, error)

	// GetFacilityListingPartialStockWithResponse List listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `GetFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	GetFacilityListingPartialStockWithResponse(ctx context.Context, facilityId string, tenantArticleId string, reqEditors ...RequestEditorFn) (*GetFacilityListingPartialStockResponse, error)

	// PatchFacilityListingPartialStockWithBodyWithResponse Update listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	// Adds new partial stocks, updates existing partial stocks and keeps stocks that are previously present in the database.
	//
	// 1. If a stock exists in the patch action but not in the database it is added.
	// 2. If a stock exists both in the patch action and in the database it is updated and the contents are merged.
	// 3. If a stock exists only in the database, it is left untouched.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PatchFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PatchFacilityListingPartialStockWithBodyWithResponse(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchFacilityListingPartialStockResponse, error)

	// PatchFacilityListingPartialStockWithResponse Update listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	// Adds new partial stocks, updates existing partial stocks and keeps stocks that are previously present in the database.
	//
	// 1. If a stock exists in the patch action but not in the database it is added.
	// 2. If a stock exists both in the patch action and in the database it is updated and the contents are merged.
	// 3. If a stock exists only in the database, it is left untouched.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PatchFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PatchFacilityListingPartialStockWithResponse(ctx context.Context, facilityId string, tenantArticleId string, body PatchFacilityListingPartialStockJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchFacilityListingPartialStockResponse, error)

	// PutFacilityListingPartialStockWithBodyWithResponse Update listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	// Replaces the current partial stock object related to its listing
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PutFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PutFacilityListingPartialStockWithBodyWithResponse(ctx context.Context, facilityId string, tenantArticleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutFacilityListingPartialStockResponse, error)

	// PutFacilityListingPartialStockWithResponse Update listing partial stocks
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
	// Replaces the current partial stock object related to its listing
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks (the `PutFacilityListingPartialStock` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PutFacilityListingPartialStockWithResponse(ctx context.Context, facilityId string, tenantArticleId string, body PutFacilityListingPartialStockJSONRequestBody, reqEditors ...RequestEditorFn) (*PutFacilityListingPartialStockResponse, error)

	// GetDiscountsForFacilityWithResponse List facility discounts
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityRef}/discounts (the `GetDiscountsForFacility` operationId).
	GetDiscountsForFacilityWithResponse(ctx context.Context, facilityRef string, params *GetDiscountsForFacilityParams, reqEditors ...RequestEditorFn) (*GetDiscountsForFacilityResponse, error)

	// AddDiscountToFacilityWithBodyWithResponse Create facility discount
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityRef}/discounts (the `AddDiscountToFacility` operationId).
	AddDiscountToFacilityWithBodyWithResponse(ctx context.Context, facilityRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddDiscountToFacilityResponse, error)

	// AddDiscountToFacilityWithResponse Create facility discount
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/facilities/{facilityRef}/discounts (the `AddDiscountToFacility` operationId).
	AddDiscountToFacilityWithResponse(ctx context.Context, facilityRef string, body AddDiscountToFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*AddDiscountToFacilityResponse, error)

	// DeleteDiscountForFacilityWithResponse Delete facility discount
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `DeleteDiscountForFacility` operationId).
	DeleteDiscountForFacilityWithResponse(ctx context.Context, facilityRef string, facilityDiscountRef string, reqEditors ...RequestEditorFn) (*DeleteDiscountForFacilityResponse, error)

	// GetDiscountForFacilityWithResponse Get facility discount
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `GetDiscountForFacility` operationId).
	GetDiscountForFacilityWithResponse(ctx context.Context, facilityRef string, facilityDiscountRef string, reqEditors ...RequestEditorFn) (*GetDiscountForFacilityResponse, error)

	// UpdateDiscountForFacilityWithBodyWithResponse Update facility discount
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `UpdateDiscountForFacility` operationId).
	UpdateDiscountForFacilityWithBodyWithResponse(ctx context.Context, facilityRef string, facilityDiscountRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDiscountForFacilityResponse, error)

	// UpdateDiscountForFacilityWithResponse Update facility discount
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} (the `UpdateDiscountForFacility` operationId).
	UpdateDiscountForFacilityWithResponse(ctx context.Context, facilityRef string, facilityDiscountRef string, body UpdateDiscountForFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDiscountForFacilityResponse, error)

	// HealthCheckWithResponse Health check
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/health (the `HealthCheck` operationId).
	HealthCheckWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthCheckResponse, error)

	// BulkUpsertListingsWithBodyWithResponse Create and update listings
	//
	// Bulk upsert listings independently of their facility.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/listings (the `BulkUpsertListings` operationId).
	BulkUpsertListingsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUpsertListingsResponse, error)

	// BulkUpsertListingsWithResponse Create and update listings
	//
	// Bulk upsert listings independently of their facility.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/listings (the `BulkUpsertListings` operationId).
	BulkUpsertListingsWithResponse(ctx context.Context, body BulkUpsertListingsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpsertListingsResponse, error)

	// SearchListingWithBodyWithResponse List listings (search)
	//
	// Search for Listing.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/listings/search (the `SearchListing` operationId).
	SearchListingWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchListingResponse, error)

	// SearchListingWithResponse List listings (search)
	//
	// Search for Listing.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/listings/search (the `SearchListing` operationId).
	SearchListingWithResponse(ctx context.Context, body SearchListingJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchListingResponse, error)

	// GetAllOrdersWithResponse List orders
	//
	// List orders with optional filtering by tenant order ID or consumer ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/orders (the `GetAllOrders` operationId).
	GetAllOrdersWithResponse(ctx context.Context, params *GetAllOrdersParams, reqEditors ...RequestEditorFn) (*GetAllOrdersResponse, error)

	// AddOrderWithBodyWithResponse Create order
	//
	// Create a new order.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders (the `AddOrder` operationId).
	AddOrderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddOrderResponse, error)

	// AddOrderWithResponse Create order
	//
	// Create a new order.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders (the `AddOrder` operationId).
	AddOrderWithResponse(ctx context.Context, body AddOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*AddOrderResponse, error)

	// BulkOrdersActionWithBodyWithResponse Call bulk orders action
	//
	// Bulk action of orders.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders/actions (the `BulkOrdersAction` operationId).
	BulkOrdersActionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkOrdersActionResponse, error)

	// BulkOrdersActionWithResponse Call bulk orders action
	//
	// Bulk action of orders.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders/actions (the `BulkOrdersAction` operationId).
	BulkOrdersActionWithResponse(ctx context.Context, body BulkOrdersActionJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkOrdersActionResponse, error)

	// SearchOrderWithBodyWithResponse List orders (search)
	//
	// Search for Order.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders/search (the `SearchOrder` operationId).
	SearchOrderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchOrderResponse, error)

	// SearchOrderWithResponse List orders (search)
	//
	// Search for Order.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders/search (the `SearchOrder` operationId).
	SearchOrderWithResponse(ctx context.Context, body SearchOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchOrderResponse, error)

	// GetOrderWithResponse Get order
	//
	// Get a specific order by ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/orders/{orderId} (the `GetOrder` operationId).
	GetOrderWithResponse(ctx context.Context, orderId string, reqEditors ...RequestEditorFn) (*GetOrderResponse, error)

	// UpdateOrderWithBodyWithResponse Update order
	//
	// Update an existing order.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/orders/{orderId} (the `UpdateOrder` operationId).
	UpdateOrderWithBodyWithResponse(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrderResponse, error)

	// UpdateOrderWithResponse Update order
	//
	// Update an existing order.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/orders/{orderId} (the `UpdateOrder` operationId).
	UpdateOrderWithResponse(ctx context.Context, orderId string, body UpdateOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrderResponse, error)

	// OrderActionWithBodyWithResponse Call order action
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders/{orderId}/actions (the `OrderAction` operationId).
	OrderActionWithBodyWithResponse(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*OrderActionResponse, error)

	// OrderActionWithResponse Call order action
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders/{orderId}/actions (the `OrderAction` operationId).
	OrderActionWithResponse(ctx context.Context, orderId string, body OrderActionJSONRequestBody, reqEditors ...RequestEditorFn) (*OrderActionResponse, error)

	// OrderLineItemActionWithBodyWithResponse Call order line item action
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions (the `OrderLineItemAction` operationId).
	OrderLineItemActionWithBodyWithResponse(ctx context.Context, orderId string, orderLineItemId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*OrderLineItemActionResponse, error)

	// OrderLineItemActionWithResponse Call order line item action
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions (the `OrderLineItemAction` operationId).
	OrderLineItemActionWithResponse(ctx context.Context, orderId string, orderLineItemId string, body OrderLineItemActionJSONRequestBody, reqEditors ...RequestEditorFn) (*OrderLineItemActionResponse, error)

	// GetPermissionsWithResponse List permissions
	//
	// This endpoint returns all available permissions in the FFT platform.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/permissions (the `GetPermissions` operationId).
	GetPermissionsWithResponse(ctx context.Context, params *GetPermissionsParams, reqEditors ...RequestEditorFn) (*GetPermissionsResponse, error)

	// PostDeliveryPromiseWithBodyWithResponse Create promise order
	//
	// Endpoint to create a promise order.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/promises/deliverypromise (the `PostDeliveryPromise` operationId).
	PostDeliveryPromiseWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostDeliveryPromiseResponse, error)

	// PostDeliveryPromiseWithResponse Create promise order
	//
	// Endpoint to create a promise order.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/promises/deliverypromise (the `PostDeliveryPromise` operationId).
	PostDeliveryPromiseWithResponse(ctx context.Context, body PostDeliveryPromiseJSONRequestBody, reqEditors ...RequestEditorFn) (*PostDeliveryPromiseResponse, error)

	// GetAllRolesWithResponse List roles
	//
	// Returns all existing roles, including their permissions and context ceilings.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/roles (the `GetAllRoles` operationId).
	GetAllRolesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAllRolesResponse, error)

	// CreateRoleWithBodyWithResponse Create role
	//
	// Creates a new custom role.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/roles (the `CreateRole` operationId).
	CreateRoleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRoleResponse, error)

	// CreateRoleWithResponse Create role
	//
	// Creates a new custom role.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/roles (the `CreateRole` operationId).
	CreateRoleWithResponse(ctx context.Context, body CreateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRoleResponse, error)

	// SearchRoleWithBodyWithResponse List roles (search)
	//
	// Search for Role.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/roles/search (the `SearchRole` operationId).
	SearchRoleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchRoleResponse, error)

	// SearchRoleWithResponse List roles (search)
	//
	// Search for Role.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/roles/search (the `SearchRole` operationId).
	SearchRoleWithResponse(ctx context.Context, body SearchRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchRoleResponse, error)

	// DeleteRoleWithResponse Delete role
	//
	// Deletes an existing role.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/roles/{name} (the `DeleteRole` operationId).
	DeleteRoleWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*DeleteRoleResponse, error)

	// GetRoleWithResponse Return role
	//
	// Returns a role requested by its name.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/roles/{name} (the `GetRole` operationId).
	GetRoleWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetRoleResponse, error)

	// PatchRoleWithBodyWithResponse Update role
	//
	// Updates an existing role (partial update).
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/roles/{name} (the `PatchRole` operationId).
	PatchRoleWithBodyWithResponse(ctx context.Context, name string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchRoleResponse, error)

	// PatchRoleWithResponse Update role
	//
	// Updates an existing role (partial update).
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/roles/{name} (the `PatchRole` operationId).
	PatchRoleWithResponse(ctx context.Context, name string, body PatchRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchRoleResponse, error)

	// UpdateRoleWithBodyWithResponse Update role
	//
	// Updates an existing role (complete replacement).
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/roles/{name} (the `UpdateRole` operationId).
	UpdateRoleWithBodyWithResponse(ctx context.Context, name string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRoleResponse, error)

	// UpdateRoleWithResponse Update role
	//
	// Updates an existing role (complete replacement).
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/roles/{name} (the `UpdateRole` operationId).
	UpdateRoleWithResponse(ctx context.Context, name string, body UpdateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRoleResponse, error)

	// GetRoutingDecisionLogsWithResponse Get routing decision logs
	//
	// This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Retrieves in-depth information about the complex routing with combinatorics
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/routing/decisionlogs (the `GetRoutingDecisionLogs` operationId).
	GetRoutingDecisionLogsWithResponse(ctx context.Context, params *GetRoutingDecisionLogsParams, reqEditors ...RequestEditorFn) (*GetRoutingDecisionLogsResponse, error)

	// GetRoutingStrategyNodeConfigCategoriesWithResponse List category node configuration
	//
	// List all the categories for node configurations.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/routing/nodeconfigcategories (the `GetRoutingStrategyNodeConfigCategories` operationId).
	GetRoutingStrategyNodeConfigCategoriesWithResponse(ctx context.Context, params *GetRoutingStrategyNodeConfigCategoriesParams, reqEditors ...RequestEditorFn) (*GetRoutingStrategyNodeConfigCategoriesResponse, error)

	// PostRoutingStrategyNodeConfigCategoryWithBodyWithResponse Create category node configuration
	//
	// Creates a new category for a routing strategies node config.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/nodeconfigcategories (the `PostRoutingStrategyNodeConfigCategory` operationId).
	PostRoutingStrategyNodeConfigCategoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostRoutingStrategyNodeConfigCategoryResponse, error)

	// PostRoutingStrategyNodeConfigCategoryWithResponse Create category node configuration
	//
	// Creates a new category for a routing strategies node config.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/nodeconfigcategories (the `PostRoutingStrategyNodeConfigCategory` operationId).
	PostRoutingStrategyNodeConfigCategoryWithResponse(ctx context.Context, body PostRoutingStrategyNodeConfigCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*PostRoutingStrategyNodeConfigCategoryResponse, error)

	// DeleteRoutingStrategyNodeConfigCategoryWithResponse Delete category node configuration
	//
	// Deletes the category.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/routing/nodeconfigcategories/{categoryId} (the `DeleteRoutingStrategyNodeConfigCategory` operationId).
	DeleteRoutingStrategyNodeConfigCategoryWithResponse(ctx context.Context, categoryId string, reqEditors ...RequestEditorFn) (*DeleteRoutingStrategyNodeConfigCategoryResponse, error)

	// GetRoutingStrategyNodeConfigCategoryWithResponse Returns category node configuration
	//
	// Returns the category.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/routing/nodeconfigcategories/{categoryId} (the `GetRoutingStrategyNodeConfigCategory` operationId).
	GetRoutingStrategyNodeConfigCategoryWithResponse(ctx context.Context, categoryId string, reqEditors ...RequestEditorFn) (*GetRoutingStrategyNodeConfigCategoryResponse, error)

	// PutRoutingStrategyNodeConfigCategoryWithBodyWithResponse Updates category node configuration
	//
	// Updates a category.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/routing/nodeconfigcategories/{categoryId} (the `PutRoutingStrategyNodeConfigCategory` operationId).
	PutRoutingStrategyNodeConfigCategoryWithBodyWithResponse(ctx context.Context, categoryId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutRoutingStrategyNodeConfigCategoryResponse, error)

	// PutRoutingStrategyNodeConfigCategoryWithResponse Updates category node configuration
	//
	// Updates a category.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/routing/nodeconfigcategories/{categoryId} (the `PutRoutingStrategyNodeConfigCategory` operationId).
	PutRoutingStrategyNodeConfigCategoryWithResponse(ctx context.Context, categoryId string, body PutRoutingStrategyNodeConfigCategoryJSONRequestBody, reqEditors ...RequestEditorFn) (*PutRoutingStrategyNodeConfigCategoryResponse, error)

	// CreateSourcingOptionsRequestWithBodyWithResponse Create sourcing option
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/sourcingoptions (the `CreateSourcingOptionsRequest` operationId).
	CreateSourcingOptionsRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSourcingOptionsRequestResponse, error)

	// CreateSourcingOptionsRequestWithResponse Create sourcing option
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/sourcingoptions (the `CreateSourcingOptionsRequest` operationId).
	CreateSourcingOptionsRequestWithResponse(ctx context.Context, body CreateSourcingOptionsRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSourcingOptionsRequestResponse, error)

	// GetSourcingOptionWithResponse Get sourcing option
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/routing/sourcingoptions/{sourcingOptionsRequestId} (the `GetSourcingOption` operationId).
	GetSourcingOptionWithResponse(ctx context.Context, sourcingOptionsRequestId string, reqEditors ...RequestEditorFn) (*GetSourcingOptionResponse, error)

	// GetRoutingStrategiesWithResponse List routing strategies
	//
	// List all existing routing strategies.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/routing/strategies (the `GetRoutingStrategies` operationId).
	GetRoutingStrategiesWithResponse(ctx context.Context, params *GetRoutingStrategiesParams, reqEditors ...RequestEditorFn) (*GetRoutingStrategiesResponse, error)

	// PostRoutingStrategyWithBodyWithResponse Create routing strategy
	//
	// Creates a new revision of the routing strategy.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/strategies (the `PostRoutingStrategy` operationId).
	PostRoutingStrategyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostRoutingStrategyResponse, error)

	// PostRoutingStrategyWithResponse Create routing strategy
	//
	// Creates a new revision of the routing strategy.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/strategies (the `PostRoutingStrategy` operationId).
	PostRoutingStrategyWithResponse(ctx context.Context, body PostRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*PostRoutingStrategyResponse, error)

	// GetRoutingStrategyWithResponse Get routing strategy
	//
	// Returns the routing strategy.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/routing/strategies/{strategyId} (the `GetRoutingStrategy` operationId).
	GetRoutingStrategyWithResponse(ctx context.Context, strategyId string, reqEditors ...RequestEditorFn) (*GetRoutingStrategyResponse, error)

	// PutRoutingStrategyWithBodyWithResponse Update routing strategy
	//
	// Updates a routing strategy.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/routing/strategies/{strategyId} (the `PutRoutingStrategy` operationId).
	PutRoutingStrategyWithBodyWithResponse(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutRoutingStrategyResponse, error)

	// PutRoutingStrategyWithResponse Update routing strategy
	//
	// Updates a routing strategy.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/routing/strategies/{strategyId} (the `PutRoutingStrategy` operationId).
	PutRoutingStrategyWithResponse(ctx context.Context, strategyId string, body PutRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*PutRoutingStrategyResponse, error)

	// ActionsRoutingStrategyWithBodyWithResponse Call routing strategy action
	//
	// Performs an action on a routing strategy.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/actions (the `ActionsRoutingStrategy` operationId).
	ActionsRoutingStrategyWithBodyWithResponse(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ActionsRoutingStrategyResponse, error)

	// ActionsRoutingStrategyWithResponse Call routing strategy action
	//
	// Performs an action on a routing strategy.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/actions (the `ActionsRoutingStrategy` operationId).
	ActionsRoutingStrategyWithResponse(ctx context.Context, strategyId string, body ActionsRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*ActionsRoutingStrategyResponse, error)

	// EvaluateRoutingStrategyWithBodyWithResponse Evaluate routing strategy
	//
	// Evaluates a routing strategy against a given order.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/evaluation (the `EvaluateRoutingStrategy` operationId).
	EvaluateRoutingStrategyWithBodyWithResponse(ctx context.Context, strategyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EvaluateRoutingStrategyResponse, error)

	// EvaluateRoutingStrategyWithResponse Evaluate routing strategy
	//
	// Evaluates a routing strategy against a given order.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/evaluation (the `EvaluateRoutingStrategy` operationId).
	EvaluateRoutingStrategyWithResponse(ctx context.Context, strategyId string, body EvaluateRoutingStrategyJSONRequestBody, reqEditors ...RequestEditorFn) (*EvaluateRoutingStrategyResponse, error)

	// EvaluateRoutingStrategyNodeWithResponse Evaluate routing strategy node
	//
	// Evaluates a routing strategy node and return the path.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/routing/strategies/{strategyId}/nodes/{nodeId}/evaluation (the `EvaluateRoutingStrategyNode` operationId).
	EvaluateRoutingStrategyNodeWithResponse(ctx context.Context, strategyId string, nodeId string, reqEditors ...RequestEditorFn) (*EvaluateRoutingStrategyNodeResponse, error)

	// GetSafetyStocksWithResponse List safety stocks
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/safetystocks (the `GetSafetyStocks` operationId).
	GetSafetyStocksWithResponse(ctx context.Context, params *GetSafetyStocksParams, reqEditors ...RequestEditorFn) (*GetSafetyStocksResponse, error)

	// BulkUpdateSafetyStockWithBodyWithResponse Update safety stocks
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/safetystocks (the `BulkUpdateSafetyStock` operationId).
	BulkUpdateSafetyStockWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUpdateSafetyStockResponse, error)

	// BulkUpdateSafetyStockWithResponse Update safety stocks
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/safetystocks (the `BulkUpdateSafetyStock` operationId).
	BulkUpdateSafetyStockWithResponse(ctx context.Context, body BulkUpdateSafetyStockJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpdateSafetyStockResponse, error)

	// DeleteSafetyStockWithResponse Delete safety stock
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/safetystocks/{safetyStockId} (the `DeleteSafetyStock` operationId).
	DeleteSafetyStockWithResponse(ctx context.Context, safetyStockId string, reqEditors ...RequestEditorFn) (*DeleteSafetyStockResponse, error)

	// StatusWithResponse Get status
	//
	// Returns the platform status.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/status (the `Status` operationId).
	StatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*StatusResponse, error)

	// GetStocksWithResponse List stocks
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/stocks (the `GetStocks` operationId).
	GetStocksWithResponse(ctx context.Context, params *GetStocksParams, reqEditors ...RequestEditorFn) (*GetStocksResponse, error)

	// CreateStockWithBodyWithResponse Create stock
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/stocks (the `CreateStock` operationId).
	CreateStockWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStockResponse, error)

	// CreateStockWithResponse Create stock
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/stocks (the `CreateStock` operationId).
	CreateStockWithResponse(ctx context.Context, body CreateStockJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStockResponse, error)

	// UpsertStocksWithBodyWithResponse Update stocks
	//
	// Update and create many stocks at once.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/stocks (the `UpsertStocks` operationId).
	UpsertStocksWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertStocksResponse, error)

	// UpsertStocksWithResponse Update stocks
	//
	// Update and create many stocks at once.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/stocks (the `UpsertStocks` operationId).
	UpsertStocksWithResponse(ctx context.Context, body UpsertStocksJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertStocksResponse, error)

	// PerformStocksActionsWithBodyWithResponse Call stock action
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/stocks/actions (the `PerformStocksActions` operationId).
	PerformStocksActionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PerformStocksActionsResponse, error)

	// PerformStocksActionsWithResponse Call stock action
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/stocks/actions (the `PerformStocksActions` operationId).
	PerformStocksActionsWithResponse(ctx context.Context, body PerformStocksActionsJSONRequestBody, reqEditors ...RequestEditorFn) (*PerformStocksActionsResponse, error)

	// SearchStockWithBodyWithResponse List stocks (search)
	//
	// Search for Stock.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/stocks/search (the `SearchStock` operationId).
	SearchStockWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchStockResponse, error)

	// SearchStockWithResponse List stocks (search)
	//
	// Search for Stock.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/stocks/search (the `SearchStock` operationId).
	SearchStockWithResponse(ctx context.Context, body SearchStockJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchStockResponse, error)

	// GetStockSummariesWithResponse List stock summaries
	//
	// Get the accumulated Stock for each Article.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/stocks/summaries (the `GetStockSummaries` operationId).
	GetStockSummariesWithResponse(ctx context.Context, params *GetStockSummariesParams, reqEditors ...RequestEditorFn) (*GetStockSummariesResponse, error)

	// DeleteStockWithResponse Delete stock
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/stocks/{stockId} (the `DeleteStock` operationId).
	DeleteStockWithResponse(ctx context.Context, stockId string, reqEditors ...RequestEditorFn) (*DeleteStockResponse, error)

	// GetStockWithResponse Get stock
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/stocks/{stockId} (the `GetStock` operationId).
	GetStockWithResponse(ctx context.Context, stockId string, reqEditors ...RequestEditorFn) (*GetStockResponse, error)

	// UpdateStockWithBodyWithResponse Update stock
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/stocks/{stockId} (the `UpdateStock` operationId).
	UpdateStockWithBodyWithResponse(ctx context.Context, stockId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStockResponse, error)

	// UpdateStockWithResponse Update stock
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/stocks/{stockId} (the `UpdateStock` operationId).
	UpdateStockWithResponse(ctx context.Context, stockId string, body UpdateStockJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStockResponse, error)

	// GetAllUsersWithResponse List users
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/users (the `GetAllUsers` operationId).
	GetAllUsersWithResponse(ctx context.Context, params *GetAllUsersParams, reqEditors ...RequestEditorFn) (*GetAllUsersResponse, error)

	// CreateUserWithBodyWithResponse Creates user
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/users (the `CreateUser` operationId).
	CreateUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)

	// CreateUserWithResponse Creates user
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/users (the `CreateUser` operationId).
	CreateUserWithResponse(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)

	// UpdateMeWithBodyWithResponse Update me user
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Update my own data.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/users/me (the `UpdateMe` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	UpdateMeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateMeResponse, error)

	// UpdateMeWithResponse Update me user
	//
	// This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Update my own data.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/users/me (the `UpdateMe` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	UpdateMeWithResponse(ctx context.Context, body UpdateMeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateMeResponse, error)

	// ExecuteMeActionWithBodyWithResponse Call user action
	//
	// Executes an action to manipulate my user.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/users/me/actions (the `ExecuteMeAction` operationId).
	ExecuteMeActionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteMeActionResponse, error)

	// ExecuteMeActionWithResponse Call user action
	//
	// Executes an action to manipulate my user.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/users/me/actions (the `ExecuteMeAction` operationId).
	ExecuteMeActionWithResponse(ctx context.Context, body ExecuteMeActionJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteMeActionResponse, error)

	// GetEffectivePermissionsWithResponse Return effective permissions
	//
	// Returns the effective permissions of the user.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/users/me/effectivepermissions (the `GetEffectivePermissions` operationId).
	GetEffectivePermissionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetEffectivePermissionsResponse, error)

	// SearchUserWithBodyWithResponse List users (search)
	//
	// This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for User
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/users/search (the `SearchUser` operationId).
	SearchUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchUserResponse, error)

	// SearchUserWithResponse List users (search)
	//
	// This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Search for User
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/users/search (the `SearchUser` operationId).
	SearchUserWithResponse(ctx context.Context, body SearchUserJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchUserResponse, error)

	// DeleteUserWithResponse Delete user
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/users/{userId} (the `DeleteUser` operationId).
	DeleteUserWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*DeleteUserResponse, error)

	// GetUserWithResponse Return user
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/users/{userId} (the `GetUser` operationId).
	GetUserWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*GetUserResponse, error)

	// ChangeUserWithBodyWithResponse Update user
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/users/{userId} (the `ChangeUser` operationId).
	ChangeUserWithBodyWithResponse(ctx context.Context, userId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChangeUserResponse, error)

	// ChangeUserWithResponse Update user
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/users/{userId} (the `ChangeUser` operationId).
	ChangeUserWithResponse(ctx context.Context, userId string, body ChangeUserJSONRequestBody, reqEditors ...RequestEditorFn) (*ChangeUserResponse, error)

	// AssignFacilityWithBodyWithResponse Create facility assignment
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/users/{userId}/assignedFacilities (the `AssignFacility` operationId).
	AssignFacilityWithBodyWithResponse(ctx context.Context, userId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AssignFacilityResponse, error)

	// AssignFacilityWithResponse Create facility assignment
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/users/{userId}/assignedFacilities (the `AssignFacility` operationId).
	AssignFacilityWithResponse(ctx context.Context, userId string, body AssignFacilityJSONRequestBody, reqEditors ...RequestEditorFn) (*AssignFacilityResponse, error)

	// GetUserRolesWithResponse Get user roles
	//
	// Returns the roles of a user.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/users/{userId}/permissions (the `GetUserRoles` operationId).
	GetUserRolesWithResponse(ctx context.Context, userId string, reqEditors ...RequestEditorFn) (*GetUserRolesResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type ClosingDay

type ClosingDay struct {
	// Date The day at which the Facility is closed
	//
	// Example: 2020-02-03T09:45:51.525Z
	Date time.Time `json:"date"`

	// Reason The reason why the Facility is closed on this day
	Reason     string               `json:"reason"`
	Recurrence ClosingDayRecurrence `json:"recurrence"`
}

ClosingDay At this day the facility is closed and does not do picking

type ClosingDayRecurrence

type ClosingDayRecurrence string

ClosingDayRecurrence defines model for ClosingDay.Recurrence.

const (
	ClosingDayRecurrenceNONRECURRING ClosingDayRecurrence = "NONRECURRING"
	ClosingDayRecurrenceYEARLY       ClosingDayRecurrence = "YEARLY"
)

Defines values for ClosingDayRecurrence.

func (ClosingDayRecurrence) Valid

func (e ClosingDayRecurrence) Valid() bool

Valid indicates whether the value is a known member of the ClosingDayRecurrence enum.

type CollectDelivery added in v0.2.0

type CollectDelivery struct {
	// FacilityRef Reference to the facility where the consumer expects to collect the items
	FacilityRef *string `json:"facilityRef,omitempty"`

	// Paid Indicates if the order is already paid.
	Paid *bool `json:"paid,omitempty"`

	// ProvisioningTime The point in time by which the order is supposed to be provisioned.
	//
	// Example: 2020-02-03T08:45:50.525Z
	ProvisioningTime *time.Time `json:"provisioningTime,omitempty"`

	// SupplyingFacilities @deprecated Use supplyingFacilitiesConfigurations
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	SupplyingFacilities *[]string `json:"supplyingFacilities,omitempty"`

	// SupplyingFacilitiesConfigurations References of facility that could supply contents of the order to another facility with specific configuration of its usage
	SupplyingFacilitiesConfigurations *[]SupplyingFacilityConfiguration `json:"supplyingFacilitiesConfigurations,omitempty"`

	// TenantFacilityId Reference to the facility where the consumer expects to collect the items.
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`
	// contains filtered or unexported fields
}

CollectDelivery CollectDelivery

func (CollectDelivery) AsCollectDelivery0 added in v0.2.0

func (t CollectDelivery) AsCollectDelivery0() (CollectDelivery0, error)

AsCollectDelivery0 returns the union data inside the CollectDelivery as a CollectDelivery0

func (CollectDelivery) AsCollectDelivery1 added in v0.2.0

func (t CollectDelivery) AsCollectDelivery1() (CollectDelivery1, error)

AsCollectDelivery1 returns the union data inside the CollectDelivery as a CollectDelivery1

func (*CollectDelivery) FromCollectDelivery0 added in v0.2.0

func (t *CollectDelivery) FromCollectDelivery0(v CollectDelivery0) error

FromCollectDelivery0 overwrites any union data inside the CollectDelivery as the provided CollectDelivery0

func (*CollectDelivery) FromCollectDelivery1 added in v0.2.0

func (t *CollectDelivery) FromCollectDelivery1(v CollectDelivery1) error

FromCollectDelivery1 overwrites any union data inside the CollectDelivery as the provided CollectDelivery1

func (CollectDelivery) MarshalJSON added in v0.2.0

func (t CollectDelivery) MarshalJSON() ([]byte, error)

func (*CollectDelivery) MergeCollectDelivery0 added in v0.2.0

func (t *CollectDelivery) MergeCollectDelivery0(v CollectDelivery0) error

MergeCollectDelivery0 performs a merge with any union data inside the CollectDelivery, using the provided CollectDelivery0

func (*CollectDelivery) MergeCollectDelivery1 added in v0.2.0

func (t *CollectDelivery) MergeCollectDelivery1(v CollectDelivery1) error

MergeCollectDelivery1 performs a merge with any union data inside the CollectDelivery, using the provided CollectDelivery1

func (*CollectDelivery) UnmarshalJSON added in v0.2.0

func (t *CollectDelivery) UnmarshalJSON(b []byte) error

type CollectDelivery0 added in v0.2.0

type CollectDelivery0 = interface{}

CollectDelivery0 defines model for CollectDelivery.0.

type CollectDelivery1 added in v0.2.0

type CollectDelivery1 = interface{}

CollectDelivery1 defines model for CollectDelivery.1.

type ConnectCarrierToFacilityJSONRequestBody

type ConnectCarrierToFacilityJSONRequestBody = FacilityCarrierConnectionForModification

ConnectCarrierToFacilityJSONRequestBody defines body for ConnectCarrierToFacility for application/json ContentType.

type ConnectCarrierToFacilityResponse

type ConnectCarrierToFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FacilityCarrierConnection
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseConnectCarrierToFacilityResponse

func ParseConnectCarrierToFacilityResponse(rsp *http.Response) (*ConnectCarrierToFacilityResponse, error)

ParseConnectCarrierToFacilityResponse parses an HTTP response from a ConnectCarrierToFacilityWithResponse call

func (ConnectCarrierToFacilityResponse) ContentType

func (r ConnectCarrierToFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ConnectCarrierToFacilityResponse) GetBody added in v0.8.0

func (r ConnectCarrierToFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ConnectCarrierToFacilityResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ConnectCarrierToFacilityResponse) GetJSON400 added in v0.8.0

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ConnectCarrierToFacilityResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ConnectCarrierToFacilityResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ConnectCarrierToFacilityResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ConnectCarrierToFacilityResponse) Status

Status returns HTTPResponse.Status

func (ConnectCarrierToFacilityResponse) StatusCode

func (r ConnectCarrierToFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ConnectionType

type ConnectionType string

ConnectionType ConnectionType

const (
	ConnectionTypeCUSTOMER        ConnectionType = "CUSTOMER"
	ConnectionTypeMANAGEDFACILITY ConnectionType = "MANAGED_FACILITY"
	ConnectionTypeSUPPLIER        ConnectionType = "SUPPLIER"
)

Defines values for ConnectionType.

func (ConnectionType) Valid

func (e ConnectionType) Valid() bool

Valid indicates whether the value is a known member of the ConnectionType enum.

type ConsumerAddress added in v0.3.0

type ConsumerAddress struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// AddressType Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.
	AddressType *AddressType `json:"addressType,omitempty"`

	// City Example: Langenfeld
	City string `json:"city"`

	// CompanyName Example: Speedy Boxales Ltd.
	CompanyName *string `json:"companyName,omitempty"`

	// Coordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
	Coordinates *Coordinates `json:"coordinates,omitempty"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country string `json:"country"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Email Example: test@try.de
	Email *openapi_types.Email `json:"email,omitempty"`

	// FirstName Example: Maxine
	FirstName *string `json:"firstName,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber *string `json:"houseNumber,omitempty"`

	// LastName Example: Muller
	LastName *string `json:"lastName,omitempty"`

	// PersonalTitle Example: Dr.
	PersonalTitle *string `json:"personalTitle,omitempty"`
	PhoneNumbers  *[]struct {
		// CustomAttributes Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
		CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

		// Label Can be used to give a description for the number, like "private", "business number", etc.
		Label *string                         `json:"label,omitempty"`
		Type  ConsumerAddressPhoneNumbersType `json:"type"`

		// Value The number itself. We do not enforce any format (yet).
		Value string `json:"value"`
	} `json:"phoneNumbers,omitempty"`

	// PostalCode Example: 40764
	PostalCode string `json:"postalCode"`

	// Province Example: NRW
	Province *string `json:"province,omitempty"`

	// Salutation Example: Frau
	Salutation *string `json:"salutation,omitempty"`

	// Street Example: Hauptstr.
	Street string `json:"street"`
}

ConsumerAddress ConsumerAddress

type ConsumerAddressForSourcingOptions added in v0.2.0

type ConsumerAddressForSourcingOptions struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// AddressType Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.
	AddressType *AddressType `json:"addressType,omitempty"`

	// City The city of the address.
	//
	// Example: Berlin
	City *string `json:"city,omitempty"`

	// CompanyName Example: Speedy Boxales Ltd.
	CompanyName *string `json:"companyName,omitempty"`

	// Coordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
	Coordinates *Coordinates `json:"coordinates,omitempty"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country string `json:"country"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Email Example: test@try.de
	Email *openapi_types.Email `json:"email,omitempty"`

	// FirstName Example: Maxine
	FirstName *string `json:"firstName,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber *string `json:"houseNumber,omitempty"`

	// LastName Example: Muller
	LastName *string `json:"lastName,omitempty"`

	// PersonalTitle Example: Dr.
	PersonalTitle *string                                         `json:"personalTitle,omitempty"`
	PhoneNumbers  *[]ConsumerAddressForSourcingOptionsPhoneNumber `json:"phoneNumbers,omitempty"`

	// PostalCode The postal code of the address.
	//
	// Example: 10115
	PostalCode *string `json:"postalCode,omitempty"`

	// Province Example: NRW
	Province *string `json:"province,omitempty"`

	// Salutation Example: Frau
	Salutation *string `json:"salutation,omitempty"`

	// Street The street of the address.
	//
	// Example: Invalidenstraße 116
	Street *string `json:"street,omitempty"`
}

ConsumerAddressForSourcingOptions ConsumerAddressForSourcingOptions

type ConsumerAddressForSourcingOptionsPhoneNumber added in v0.2.0

type ConsumerAddressForSourcingOptionsPhoneNumber struct {
	// CustomAttributes Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Label Can be used to give a description for the number, like "private", "business number", etc.
	Label *string                                          `json:"label,omitempty"`
	Type  ConsumerAddressForSourcingOptionsPhoneNumberType `json:"type"`

	// Value The number itself. We do not enforce any format (yet).
	Value string `json:"value"`
}

ConsumerAddressForSourcingOptionsPhoneNumber ConsumerAddressForSourcingOptionsPhoneNumber

type ConsumerAddressForSourcingOptionsPhoneNumberType added in v0.2.0

type ConsumerAddressForSourcingOptionsPhoneNumberType string

ConsumerAddressForSourcingOptionsPhoneNumberType defines model for ConsumerAddressForSourcingOptionsPhoneNumber.Type.

const (
	ConsumerAddressForSourcingOptionsPhoneNumberTypeMOBILE ConsumerAddressForSourcingOptionsPhoneNumberType = "MOBILE"
	ConsumerAddressForSourcingOptionsPhoneNumberTypePHONE  ConsumerAddressForSourcingOptionsPhoneNumberType = "PHONE"
)

Defines values for ConsumerAddressForSourcingOptionsPhoneNumberType.

func (ConsumerAddressForSourcingOptionsPhoneNumberType) Valid added in v0.2.0

Valid indicates whether the value is a known member of the ConsumerAddressForSourcingOptionsPhoneNumberType enum.

type ConsumerAddressPhoneNumbersType added in v0.8.0

type ConsumerAddressPhoneNumbersType string

ConsumerAddressPhoneNumbersType defines model for ConsumerAddress.PhoneNumbers.Type.

const (
	ConsumerAddressPhoneNumbersTypeMOBILE ConsumerAddressPhoneNumbersType = "MOBILE"
	ConsumerAddressPhoneNumbersTypePHONE  ConsumerAddressPhoneNumbersType = "PHONE"
)

Defines values for ConsumerAddressPhoneNumbersType.

func (ConsumerAddressPhoneNumbersType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the ConsumerAddressPhoneNumbersType enum.

type ConsumerAddressesForSourcingOptions added in v0.2.0

type ConsumerAddressesForSourcingOptions struct {
	Addresses *[]ConsumerAddressForSourcingOptions `json:"addresses,omitempty"`

	// ConsumerId The id of the consumer.
	//
	// Example: e4213a07-f563-46a3-b1ba-4dfeb6abe82a
	ConsumerId *string `json:"consumerId,omitempty"`

	// CustomAttributes Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`
	FacilityRef      *string                 `json:"facilityRef,omitempty"`
	TenantFacilityId *string                 `json:"tenantFacilityId,omitempty"`
}

ConsumerAddressesForSourcingOptions ConsumerAddressesForSourcingOptions

type ContextLimitation

type ContextLimitation struct {
	// Type The type of the context limitation.
	Type ContextLimitationType `json:"type"`

	// Values An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).
	Values []string `json:"values"`
}

ContextLimitation ContextLimitation

type ContextLimitationType

type ContextLimitationType string

ContextLimitationType The type of the context limitation.

const (
	ContextLimitationTypeFACILITY      ContextLimitationType = "FACILITY"
	ContextLimitationTypeFACILITYGROUP ContextLimitationType = "FACILITY_GROUP"
	ContextLimitationTypeROLE          ContextLimitationType = "ROLE"
	ContextLimitationTypeUSERROLE      ContextLimitationType = "USER_ROLE"
	ContextLimitationTypeZONE          ContextLimitationType = "ZONE"
)

Defines values for ContextLimitationType.

func (ContextLimitationType) Valid

func (e ContextLimitationType) Valid() bool

Valid indicates whether the value is a known member of the ContextLimitationType enum.

type ContextOperator

type ContextOperator string

ContextOperator The operator used to define how the context values are evaluated or compared.

const (
	NOT ContextOperator = "NOT"
)

Defines values for ContextOperator.

func (ContextOperator) Valid

func (e ContextOperator) Valid() bool

Valid indicates whether the value is a known member of the ContextOperator enum.

type Coordinates

type Coordinates struct {
	// Lat Latitude value
	//
	// Example: 50.937531
	Lat float32 `json:"lat"`

	// Lon Longitude value
	//
	// Example: 6.960279
	Lon float32 `json:"lon"`
}

Coordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API

type CostCoefficientCostDetail added in v0.8.0

type CostCoefficientCostDetail struct {
	// Amount Money
	Amount Money `json:"amount"`

	// Coefficient The configured rate
	//
	// Example: 0.0001
	Coefficient float32 `json:"coefficient"`

	// Id Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds
	//
	// Example: 0
	Id string `json:"id"`

	// MeasurementUnit CostMeasurementUnit
	MeasurementUnit CostMeasurementUnit `json:"measurementUnit"`

	// MeasurementValue The weight or volume the coefficient was multiplied by
	//
	// Example: 4000
	MeasurementValue float32                       `json:"measurementValue"`
	Type             CostCoefficientCostDetailType `json:"type"`
}

CostCoefficientCostDetail The configured rate charged per measurement unit, applied to the measured value.

type CostCoefficientCostDetailType added in v0.8.0

type CostCoefficientCostDetailType string

CostCoefficientCostDetailType defines model for CostCoefficientCostDetail.Type.

const (
	COSTCOEFFICIENT CostCoefficientCostDetailType = "COST_COEFFICIENT"
)

Defines values for CostCoefficientCostDetailType.

func (CostCoefficientCostDetailType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the CostCoefficientCostDetailType enum.

type CostCoefficientMeasurementUnit

type CostCoefficientMeasurementUnit string

CostCoefficientMeasurementUnit The unit of measurement for the coefficient

const (
	CostCoefficientMeasurementUnitGRAM CostCoefficientMeasurementUnit = "GRAM"
)

Defines values for CostCoefficientMeasurementUnit.

func (CostCoefficientMeasurementUnit) Valid

Valid indicates whether the value is a known member of the CostCoefficientMeasurementUnit enum.

type CostMeasurementUnit added in v0.8.0

type CostMeasurementUnit string

CostMeasurementUnit CostMeasurementUnit

const (
	CostMeasurementUnitCUBICMETER CostMeasurementUnit = "CUBIC_METER"
	CostMeasurementUnitGRAM       CostMeasurementUnit = "GRAM"
)

Defines values for CostMeasurementUnit.

func (CostMeasurementUnit) Valid added in v0.8.0

func (e CostMeasurementUnit) Valid() bool

Valid indicates whether the value is a known member of the CostMeasurementUnit enum.

type CreateCarrierToFacilityJSONRequestBody

type CreateCarrierToFacilityJSONRequestBody = FacilityCarrierConnectionForCreation

CreateCarrierToFacilityJSONRequestBody defines body for CreateCarrierToFacility for application/json ContentType.

type CreateCarrierToFacilityResponse

type CreateCarrierToFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *FacilityCarrierConnection
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseCreateCarrierToFacilityResponse

func ParseCreateCarrierToFacilityResponse(rsp *http.Response) (*CreateCarrierToFacilityResponse, error)

ParseCreateCarrierToFacilityResponse parses an HTTP response from a CreateCarrierToFacilityWithResponse call

func (CreateCarrierToFacilityResponse) ContentType

func (r CreateCarrierToFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateCarrierToFacilityResponse) GetBody added in v0.8.0

func (r CreateCarrierToFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateCarrierToFacilityResponse) GetJSON201 added in v0.8.0

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateCarrierToFacilityResponse) GetJSON400 added in v0.8.0

func (r CreateCarrierToFacilityResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateCarrierToFacilityResponse) GetJSON401 added in v0.8.0

func (r CreateCarrierToFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateCarrierToFacilityResponse) GetJSON403 added in v0.8.0

func (r CreateCarrierToFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateCarrierToFacilityResponse) GetJSON404 added in v0.8.0

func (r CreateCarrierToFacilityResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CreateCarrierToFacilityResponse) Status

Status returns HTTPResponse.Status

func (CreateCarrierToFacilityResponse) StatusCode

func (r CreateCarrierToFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateConnectionToFacilityJSONBody

type CreateConnectionToFacilityJSONBody struct {
	// contains filtered or unexported fields
}

CreateConnectionToFacilityJSONBody defines parameters for CreateConnectionToFacility.

func (CreateConnectionToFacilityJSONBody) AsInterFacilityConnectionToCustomerForCreation

func (t CreateConnectionToFacilityJSONBody) AsInterFacilityConnectionToCustomerForCreation() (InterFacilityConnectionToCustomerForCreation, error)

AsInterFacilityConnectionToCustomerForCreation returns the union data inside the CreateConnectionToFacilityJSONBody as a InterFacilityConnectionToCustomerForCreation

func (CreateConnectionToFacilityJSONBody) AsInterFacilityConnectionToManagedFacilityForCreation

func (t CreateConnectionToFacilityJSONBody) AsInterFacilityConnectionToManagedFacilityForCreation() (InterFacilityConnectionToManagedFacilityForCreation, error)

AsInterFacilityConnectionToManagedFacilityForCreation returns the union data inside the CreateConnectionToFacilityJSONBody as a InterFacilityConnectionToManagedFacilityForCreation

func (CreateConnectionToFacilityJSONBody) AsInterFacilityConnectionToSupplierForCreation

func (t CreateConnectionToFacilityJSONBody) AsInterFacilityConnectionToSupplierForCreation() (InterFacilityConnectionToSupplierForCreation, error)

AsInterFacilityConnectionToSupplierForCreation returns the union data inside the CreateConnectionToFacilityJSONBody as a InterFacilityConnectionToSupplierForCreation

func (CreateConnectionToFacilityJSONBody) Discriminator

func (t CreateConnectionToFacilityJSONBody) Discriminator() (string, error)

func (*CreateConnectionToFacilityJSONBody) FromInterFacilityConnectionToCustomerForCreation

func (t *CreateConnectionToFacilityJSONBody) FromInterFacilityConnectionToCustomerForCreation(v InterFacilityConnectionToCustomerForCreation) error

FromInterFacilityConnectionToCustomerForCreation overwrites any union data inside the CreateConnectionToFacilityJSONBody as the provided InterFacilityConnectionToCustomerForCreation

func (*CreateConnectionToFacilityJSONBody) FromInterFacilityConnectionToManagedFacilityForCreation

func (t *CreateConnectionToFacilityJSONBody) FromInterFacilityConnectionToManagedFacilityForCreation(v InterFacilityConnectionToManagedFacilityForCreation) error

FromInterFacilityConnectionToManagedFacilityForCreation overwrites any union data inside the CreateConnectionToFacilityJSONBody as the provided InterFacilityConnectionToManagedFacilityForCreation

func (*CreateConnectionToFacilityJSONBody) FromInterFacilityConnectionToSupplierForCreation

func (t *CreateConnectionToFacilityJSONBody) FromInterFacilityConnectionToSupplierForCreation(v InterFacilityConnectionToSupplierForCreation) error

FromInterFacilityConnectionToSupplierForCreation overwrites any union data inside the CreateConnectionToFacilityJSONBody as the provided InterFacilityConnectionToSupplierForCreation

func (CreateConnectionToFacilityJSONBody) MarshalJSON

func (t CreateConnectionToFacilityJSONBody) MarshalJSON() ([]byte, error)

func (*CreateConnectionToFacilityJSONBody) MergeInterFacilityConnectionToCustomerForCreation

func (t *CreateConnectionToFacilityJSONBody) MergeInterFacilityConnectionToCustomerForCreation(v InterFacilityConnectionToCustomerForCreation) error

MergeInterFacilityConnectionToCustomerForCreation performs a merge with any union data inside the CreateConnectionToFacilityJSONBody, using the provided InterFacilityConnectionToCustomerForCreation

func (*CreateConnectionToFacilityJSONBody) MergeInterFacilityConnectionToManagedFacilityForCreation

func (t *CreateConnectionToFacilityJSONBody) MergeInterFacilityConnectionToManagedFacilityForCreation(v InterFacilityConnectionToManagedFacilityForCreation) error

MergeInterFacilityConnectionToManagedFacilityForCreation performs a merge with any union data inside the CreateConnectionToFacilityJSONBody, using the provided InterFacilityConnectionToManagedFacilityForCreation

func (*CreateConnectionToFacilityJSONBody) MergeInterFacilityConnectionToSupplierForCreation

func (t *CreateConnectionToFacilityJSONBody) MergeInterFacilityConnectionToSupplierForCreation(v InterFacilityConnectionToSupplierForCreation) error

MergeInterFacilityConnectionToSupplierForCreation performs a merge with any union data inside the CreateConnectionToFacilityJSONBody, using the provided InterFacilityConnectionToSupplierForCreation

func (*CreateConnectionToFacilityJSONBody) UnmarshalJSON

func (t *CreateConnectionToFacilityJSONBody) UnmarshalJSON(b []byte) error

func (CreateConnectionToFacilityJSONBody) ValueByDiscriminator

func (t CreateConnectionToFacilityJSONBody) ValueByDiscriminator() (interface{}, error)

type CreateConnectionToFacilityJSONRequestBody

type CreateConnectionToFacilityJSONRequestBody CreateConnectionToFacilityJSONBody

CreateConnectionToFacilityJSONRequestBody defines body for CreateConnectionToFacility for application/json ContentType.

type CreateConnectionToFacilityResponse

type CreateConnectionToFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *InterFacilityConnection
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseCreateConnectionToFacilityResponse

func ParseCreateConnectionToFacilityResponse(rsp *http.Response) (*CreateConnectionToFacilityResponse, error)

ParseCreateConnectionToFacilityResponse parses an HTTP response from a CreateConnectionToFacilityWithResponse call

func (CreateConnectionToFacilityResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateConnectionToFacilityResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (CreateConnectionToFacilityResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CreateConnectionToFacilityResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateConnectionToFacilityResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateConnectionToFacilityResponse) Status

Status returns HTTPResponse.Status

func (CreateConnectionToFacilityResponse) StatusCode

func (r CreateConnectionToFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRoleJSONRequestBody

type CreateRoleJSONRequestBody = RoleForCreation

CreateRoleJSONRequestBody defines body for CreateRole for application/json ContentType.

type CreateRoleResponse

type CreateRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *Role
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseCreateRoleResponse

func ParseCreateRoleResponse(rsp *http.Response) (*CreateRoleResponse, error)

ParseCreateRoleResponse parses an HTTP response from a CreateRoleWithResponse call

func (CreateRoleResponse) ContentType

func (r CreateRoleResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateRoleResponse) GetBody added in v0.8.0

func (r CreateRoleResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateRoleResponse) GetJSON201 added in v0.8.0

func (r CreateRoleResponse) GetJSON201() *Role

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateRoleResponse) GetJSON401 added in v0.8.0

func (r CreateRoleResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateRoleResponse) GetJSON403 added in v0.8.0

func (r CreateRoleResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateRoleResponse) Status

func (r CreateRoleResponse) Status() string

Status returns HTTPResponse.Status

func (CreateRoleResponse) StatusCode

func (r CreateRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSourcingOptionsRequestJSONRequestBody added in v0.2.0

type CreateSourcingOptionsRequestJSONRequestBody = SourcingOptionsRequest

CreateSourcingOptionsRequestJSONRequestBody defines body for CreateSourcingOptionsRequest for application/json ContentType.

type CreateSourcingOptionsRequestResponse added in v0.2.0

type CreateSourcingOptionsRequestResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *SourcingOptionsResponse
	// XML201 the response for an HTTP 201 `application/xml` response
	XML201 *SourcingOptionsResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseCreateSourcingOptionsRequestResponse added in v0.2.0

func ParseCreateSourcingOptionsRequestResponse(rsp *http.Response) (*CreateSourcingOptionsRequestResponse, error)

ParseCreateSourcingOptionsRequestResponse parses an HTTP response from a CreateSourcingOptionsRequestWithResponse call

func (CreateSourcingOptionsRequestResponse) ContentType added in v0.2.0

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateSourcingOptionsRequestResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (CreateSourcingOptionsRequestResponse) GetJSON201 added in v0.8.0

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateSourcingOptionsRequestResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateSourcingOptionsRequestResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateSourcingOptionsRequestResponse) GetXML201 added in v0.8.0

GetXML201 returns the response for an HTTP 201 `application/xml` response

func (CreateSourcingOptionsRequestResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (CreateSourcingOptionsRequestResponse) StatusCode added in v0.2.0

StatusCode returns HTTPResponse.StatusCode

type CreateStockJSONRequestBody

type CreateStockJSONRequestBody = StockForCreation

CreateStockJSONRequestBody defines body for CreateStock for application/json ContentType.

type CreateStockResponse

type CreateStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *Stock
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseCreateStockResponse

func ParseCreateStockResponse(rsp *http.Response) (*CreateStockResponse, error)

ParseCreateStockResponse parses an HTTP response from a CreateStockWithResponse call

func (CreateStockResponse) ContentType

func (r CreateStockResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateStockResponse) GetBody added in v0.8.0

func (r CreateStockResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateStockResponse) GetJSON201 added in v0.8.0

func (r CreateStockResponse) GetJSON201() *Stock

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateStockResponse) GetJSON401 added in v0.8.0

func (r CreateStockResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateStockResponse) GetJSON403 added in v0.8.0

func (r CreateStockResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateStockResponse) Status

func (r CreateStockResponse) Status() string

Status returns HTTPResponse.Status

func (CreateStockResponse) StatusCode

func (r CreateStockResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateUserJSONRequestBody

type CreateUserJSONRequestBody = UserForCreation

CreateUserJSONRequestBody defines body for CreateUser for application/json ContentType.

type CreateUserResponse

type CreateUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *User
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseCreateUserResponse

func ParseCreateUserResponse(rsp *http.Response) (*CreateUserResponse, error)

ParseCreateUserResponse parses an HTTP response from a CreateUserWithResponse call

func (CreateUserResponse) ContentType

func (r CreateUserResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateUserResponse) GetBody added in v0.8.0

func (r CreateUserResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateUserResponse) GetJSON201 added in v0.8.0

func (r CreateUserResponse) GetJSON201() *User

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateUserResponse) GetJSON401 added in v0.8.0

func (r CreateUserResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateUserResponse) GetJSON403 added in v0.8.0

func (r CreateUserResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateUserResponse) GetJSON404 added in v0.8.0

func (r CreateUserResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CreateUserResponse) Status

func (r CreateUserResponse) Status() string

Status returns HTTPResponse.Status

func (CreateUserResponse) StatusCode

func (r CreateUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CurrencyCode

type CurrencyCode string

CurrencyCode The currency code is a three-letter code that represents a currency in the ISO 4217 standard.

const (
	CurrencyCodeAED CurrencyCode = "AED"
	CurrencyCodeAFN CurrencyCode = "AFN"
	CurrencyCodeALL CurrencyCode = "ALL"
	CurrencyCodeAMD CurrencyCode = "AMD"
	CurrencyCodeANG CurrencyCode = "ANG"
	CurrencyCodeAOA CurrencyCode = "AOA"
	CurrencyCodeARS CurrencyCode = "ARS"
	CurrencyCodeAUD CurrencyCode = "AUD"
	CurrencyCodeAWG CurrencyCode = "AWG"
	CurrencyCodeAZN CurrencyCode = "AZN"
	CurrencyCodeBAM CurrencyCode = "BAM"
	CurrencyCodeBBD CurrencyCode = "BBD"
	CurrencyCodeBDT CurrencyCode = "BDT"
	CurrencyCodeBGN CurrencyCode = "BGN"
	CurrencyCodeBHD CurrencyCode = "BHD"
	CurrencyCodeBIF CurrencyCode = "BIF"
	CurrencyCodeBMD CurrencyCode = "BMD"
	CurrencyCodeBND CurrencyCode = "BND"
	CurrencyCodeBOB CurrencyCode = "BOB"
	CurrencyCodeBOV CurrencyCode = "BOV"
	CurrencyCodeBRL CurrencyCode = "BRL"
	CurrencyCodeBSD CurrencyCode = "BSD"
	CurrencyCodeBTN CurrencyCode = "BTN"
	CurrencyCodeBWP CurrencyCode = "BWP"
	CurrencyCodeBYN CurrencyCode = "BYN"
	CurrencyCodeBZD CurrencyCode = "BZD"
	CurrencyCodeCAD CurrencyCode = "CAD"
	CurrencyCodeCDF CurrencyCode = "CDF"
	CurrencyCodeCHE CurrencyCode = "CHE"
	CurrencyCodeCHF CurrencyCode = "CHF"
	CurrencyCodeCHW CurrencyCode = "CHW"
	CurrencyCodeCLF CurrencyCode = "CLF"
	CurrencyCodeCLP CurrencyCode = "CLP"
	CurrencyCodeCNY CurrencyCode = "CNY"
	CurrencyCodeCOP CurrencyCode = "COP"
	CurrencyCodeCOU CurrencyCode = "COU"
	CurrencyCodeCRC CurrencyCode = "CRC"
	CurrencyCodeCUC CurrencyCode = "CUC"
	CurrencyCodeCUP CurrencyCode = "CUP"
	CurrencyCodeCVE CurrencyCode = "CVE"
	CurrencyCodeCZK CurrencyCode = "CZK"
	CurrencyCodeDJF CurrencyCode = "DJF"
	CurrencyCodeDKK CurrencyCode = "DKK"
	CurrencyCodeDOP CurrencyCode = "DOP"
	CurrencyCodeDZD CurrencyCode = "DZD"
	CurrencyCodeEGP CurrencyCode = "EGP"
	CurrencyCodeERN CurrencyCode = "ERN"
	CurrencyCodeETB CurrencyCode = "ETB"
	CurrencyCodeEUR CurrencyCode = "EUR"
	CurrencyCodeFJD CurrencyCode = "FJD"
	CurrencyCodeFKP CurrencyCode = "FKP"
	CurrencyCodeGBP CurrencyCode = "GBP"
	CurrencyCodeGEL CurrencyCode = "GEL"
	CurrencyCodeGHS CurrencyCode = "GHS"
	CurrencyCodeGIP CurrencyCode = "GIP"
	CurrencyCodeGMD CurrencyCode = "GMD"
	CurrencyCodeGNF CurrencyCode = "GNF"
	CurrencyCodeGTQ CurrencyCode = "GTQ"
	CurrencyCodeGYD CurrencyCode = "GYD"
	CurrencyCodeHKD CurrencyCode = "HKD"
	CurrencyCodeHNL CurrencyCode = "HNL"
	CurrencyCodeHTG CurrencyCode = "HTG"
	CurrencyCodeHUF CurrencyCode = "HUF"
	CurrencyCodeIDR CurrencyCode = "IDR"
	CurrencyCodeILS CurrencyCode = "ILS"
	CurrencyCodeINR CurrencyCode = "INR"
	CurrencyCodeIQD CurrencyCode = "IQD"
	CurrencyCodeIRR CurrencyCode = "IRR"
	CurrencyCodeISK CurrencyCode = "ISK"
	CurrencyCodeJMD CurrencyCode = "JMD"
	CurrencyCodeJOD CurrencyCode = "JOD"
	CurrencyCodeJPY CurrencyCode = "JPY"
	CurrencyCodeKES CurrencyCode = "KES"
	CurrencyCodeKGS CurrencyCode = "KGS"
	CurrencyCodeKHR CurrencyCode = "KHR"
	CurrencyCodeKMF CurrencyCode = "KMF"
	CurrencyCodeKPW CurrencyCode = "KPW"
	CurrencyCodeKRW CurrencyCode = "KRW"
	CurrencyCodeKWD CurrencyCode = "KWD"
	CurrencyCodeKYD CurrencyCode = "KYD"
	CurrencyCodeKZT CurrencyCode = "KZT"
	CurrencyCodeLAK CurrencyCode = "LAK"
	CurrencyCodeLBP CurrencyCode = "LBP"
	CurrencyCodeLKR CurrencyCode = "LKR"
	CurrencyCodeLRD CurrencyCode = "LRD"
	CurrencyCodeLSL CurrencyCode = "LSL"
	CurrencyCodeLYD CurrencyCode = "LYD"
	CurrencyCodeMAD CurrencyCode = "MAD"
	CurrencyCodeMDL CurrencyCode = "MDL"
	CurrencyCodeMGA CurrencyCode = "MGA"
	CurrencyCodeMKD CurrencyCode = "MKD"
	CurrencyCodeMMK CurrencyCode = "MMK"
	CurrencyCodeMNT CurrencyCode = "MNT"
	CurrencyCodeMOP CurrencyCode = "MOP"
	CurrencyCodeMRU CurrencyCode = "MRU"
	CurrencyCodeMUR CurrencyCode = "MUR"
	CurrencyCodeMVR CurrencyCode = "MVR"
	CurrencyCodeMWK CurrencyCode = "MWK"
	CurrencyCodeMXN CurrencyCode = "MXN"
	CurrencyCodeMXV CurrencyCode = "MXV"
	CurrencyCodeMYR CurrencyCode = "MYR"
	CurrencyCodeMZN CurrencyCode = "MZN"
	CurrencyCodeNAD CurrencyCode = "NAD"
	CurrencyCodeNGN CurrencyCode = "NGN"
	CurrencyCodeNIO CurrencyCode = "NIO"
	CurrencyCodeNOK CurrencyCode = "NOK"
	CurrencyCodeNPR CurrencyCode = "NPR"
	CurrencyCodeNZD CurrencyCode = "NZD"
	CurrencyCodeOMR CurrencyCode = "OMR"
	CurrencyCodePAB CurrencyCode = "PAB"
	CurrencyCodePEN CurrencyCode = "PEN"
	CurrencyCodePGK CurrencyCode = "PGK"
	CurrencyCodePHP CurrencyCode = "PHP"
	CurrencyCodePKR CurrencyCode = "PKR"
	CurrencyCodePLN CurrencyCode = "PLN"
	CurrencyCodePYG CurrencyCode = "PYG"
	CurrencyCodeQAR CurrencyCode = "QAR"
	CurrencyCodeRON CurrencyCode = "RON"
	CurrencyCodeRSD CurrencyCode = "RSD"
	CurrencyCodeRUB CurrencyCode = "RUB"
	CurrencyCodeRWF CurrencyCode = "RWF"
	CurrencyCodeSAR CurrencyCode = "SAR"
	CurrencyCodeSBD CurrencyCode = "SBD"
	CurrencyCodeSCR CurrencyCode = "SCR"
	CurrencyCodeSDG CurrencyCode = "SDG"
	CurrencyCodeSEK CurrencyCode = "SEK"
	CurrencyCodeSGD CurrencyCode = "SGD"
	CurrencyCodeSHP CurrencyCode = "SHP"
	CurrencyCodeSLE CurrencyCode = "SLE"
	CurrencyCodeSOS CurrencyCode = "SOS"
	CurrencyCodeSRD CurrencyCode = "SRD"
	CurrencyCodeSSP CurrencyCode = "SSP"
	CurrencyCodeSTN CurrencyCode = "STN"
	CurrencyCodeSVC CurrencyCode = "SVC"
	CurrencyCodeSYP CurrencyCode = "SYP"
	CurrencyCodeSZL CurrencyCode = "SZL"
	CurrencyCodeTHB CurrencyCode = "THB"
	CurrencyCodeTJS CurrencyCode = "TJS"
	CurrencyCodeTMT CurrencyCode = "TMT"
	CurrencyCodeTND CurrencyCode = "TND"
	CurrencyCodeTOP CurrencyCode = "TOP"
	CurrencyCodeTRY CurrencyCode = "TRY"
	CurrencyCodeTTD CurrencyCode = "TTD"
	CurrencyCodeTWD CurrencyCode = "TWD"
	CurrencyCodeTZS CurrencyCode = "TZS"
	CurrencyCodeUAH CurrencyCode = "UAH"
	CurrencyCodeUGX CurrencyCode = "UGX"
	CurrencyCodeUSD CurrencyCode = "USD"
	CurrencyCodeUSN CurrencyCode = "USN"
	CurrencyCodeUYI CurrencyCode = "UYI"
	CurrencyCodeUYU CurrencyCode = "UYU"
	CurrencyCodeUYW CurrencyCode = "UYW"
	CurrencyCodeUZS CurrencyCode = "UZS"
	CurrencyCodeVED CurrencyCode = "VED"
	CurrencyCodeVES CurrencyCode = "VES"
	CurrencyCodeVND CurrencyCode = "VND"
	CurrencyCodeVUV CurrencyCode = "VUV"
	CurrencyCodeWST CurrencyCode = "WST"
	CurrencyCodeXAF CurrencyCode = "XAF"
	CurrencyCodeXAG CurrencyCode = "XAG"
	CurrencyCodeXAU CurrencyCode = "XAU"
	CurrencyCodeXBA CurrencyCode = "XBA"
	CurrencyCodeXBB CurrencyCode = "XBB"
	CurrencyCodeXBC CurrencyCode = "XBC"
	CurrencyCodeXBD CurrencyCode = "XBD"
	CurrencyCodeXCD CurrencyCode = "XCD"
	CurrencyCodeXDR CurrencyCode = "XDR"
	CurrencyCodeXOF CurrencyCode = "XOF"
	CurrencyCodeXPD CurrencyCode = "XPD"
	CurrencyCodeXPF CurrencyCode = "XPF"
	CurrencyCodeXPT CurrencyCode = "XPT"
	CurrencyCodeXSU CurrencyCode = "XSU"
	CurrencyCodeXTS CurrencyCode = "XTS"
	CurrencyCodeXUA CurrencyCode = "XUA"
	CurrencyCodeXXX CurrencyCode = "XXX"
	CurrencyCodeYER CurrencyCode = "YER"
	CurrencyCodeZAR CurrencyCode = "ZAR"
	CurrencyCodeZMW CurrencyCode = "ZMW"
	CurrencyCodeZWL CurrencyCode = "ZWL"
)

Defines values for CurrencyCode.

func (CurrencyCode) Valid

func (e CurrencyCode) Valid() bool

Valid indicates whether the value is a known member of the CurrencyCode enum.

type CustomClaims

type CustomClaims struct {
	// Roles The roles of the user
	Roles []UserRole `json:"roles"`
}

CustomClaims CustomClaims

type CustomServiceDefinition

type CustomServiceDefinition struct {
	// AdditionalInformation Additional information necessary to fulfil the custom service
	AdditionalInformation *[]struct {
		// AdditionalInformationRef A reference to the specific additional information of the custom service
		AdditionalInformationRef string `json:"additionalInformationRef"`

		// TenantAdditionalInformationId The id of the tenant specific additional information
		TenantAdditionalInformationId *string `json:"tenantAdditionalInformationId,omitempty"`

		// Value The value of the additional information
		Value *CustomServiceDefinition_AdditionalInformation_Value `json:"value,omitempty"`
	} `json:"additionalInformation,omitempty"`

	// CustomAttributes Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// CustomServiceRef A reference to the custom service to be applied to the orderline items
	CustomServiceRef *string `json:"customServiceRef,omitempty"`

	// IsBundled if true all articles below this service are intrpreted as a bundle
	IsBundled *bool `json:"isBundled,omitempty"`

	// TenantCustomServiceId The id of the tenant specific custom service
	TenantCustomServiceId *string `json:"tenantCustomServiceId,omitempty"`
}

CustomServiceDefinition CustomServiceDefinition

type CustomServiceDefinitionAdditionalInformationValue0

type CustomServiceDefinitionAdditionalInformationValue0 = string

CustomServiceDefinitionAdditionalInformationValue0 defines model for CustomServiceDefinition.AdditionalInformation.Value.0.

type CustomServiceDefinitionAdditionalInformationValue1

type CustomServiceDefinitionAdditionalInformationValue1 = int

CustomServiceDefinitionAdditionalInformationValue1 defines model for CustomServiceDefinition.AdditionalInformation.Value.1.

type CustomServiceDefinitionAdditionalInformationValue2

type CustomServiceDefinitionAdditionalInformationValue2 = float32

CustomServiceDefinitionAdditionalInformationValue2 defines model for CustomServiceDefinition.AdditionalInformation.Value.2.

type CustomServiceDefinitionAdditionalInformationValue3

type CustomServiceDefinitionAdditionalInformationValue3 = bool

CustomServiceDefinitionAdditionalInformationValue3 defines model for CustomServiceDefinition.AdditionalInformation.Value.3.

type CustomServiceDefinition_AdditionalInformation_Value

type CustomServiceDefinition_AdditionalInformation_Value struct {
	// contains filtered or unexported fields
}

CustomServiceDefinition_AdditionalInformation_Value The value of the additional information

func (CustomServiceDefinition_AdditionalInformation_Value) AsCustomServiceDefinitionAdditionalInformationValue0

func (t CustomServiceDefinition_AdditionalInformation_Value) AsCustomServiceDefinitionAdditionalInformationValue0() (CustomServiceDefinitionAdditionalInformationValue0, error)

AsCustomServiceDefinitionAdditionalInformationValue0 returns the union data inside the CustomServiceDefinition_AdditionalInformation_Value as a CustomServiceDefinitionAdditionalInformationValue0

func (CustomServiceDefinition_AdditionalInformation_Value) AsCustomServiceDefinitionAdditionalInformationValue1

func (t CustomServiceDefinition_AdditionalInformation_Value) AsCustomServiceDefinitionAdditionalInformationValue1() (CustomServiceDefinitionAdditionalInformationValue1, error)

AsCustomServiceDefinitionAdditionalInformationValue1 returns the union data inside the CustomServiceDefinition_AdditionalInformation_Value as a CustomServiceDefinitionAdditionalInformationValue1

func (CustomServiceDefinition_AdditionalInformation_Value) AsCustomServiceDefinitionAdditionalInformationValue2

func (t CustomServiceDefinition_AdditionalInformation_Value) AsCustomServiceDefinitionAdditionalInformationValue2() (CustomServiceDefinitionAdditionalInformationValue2, error)

AsCustomServiceDefinitionAdditionalInformationValue2 returns the union data inside the CustomServiceDefinition_AdditionalInformation_Value as a CustomServiceDefinitionAdditionalInformationValue2

func (CustomServiceDefinition_AdditionalInformation_Value) AsCustomServiceDefinitionAdditionalInformationValue3

func (t CustomServiceDefinition_AdditionalInformation_Value) AsCustomServiceDefinitionAdditionalInformationValue3() (CustomServiceDefinitionAdditionalInformationValue3, error)

AsCustomServiceDefinitionAdditionalInformationValue3 returns the union data inside the CustomServiceDefinition_AdditionalInformation_Value as a CustomServiceDefinitionAdditionalInformationValue3

func (*CustomServiceDefinition_AdditionalInformation_Value) FromCustomServiceDefinitionAdditionalInformationValue0

func (t *CustomServiceDefinition_AdditionalInformation_Value) FromCustomServiceDefinitionAdditionalInformationValue0(v CustomServiceDefinitionAdditionalInformationValue0) error

FromCustomServiceDefinitionAdditionalInformationValue0 overwrites any union data inside the CustomServiceDefinition_AdditionalInformation_Value as the provided CustomServiceDefinitionAdditionalInformationValue0

func (*CustomServiceDefinition_AdditionalInformation_Value) FromCustomServiceDefinitionAdditionalInformationValue1

func (t *CustomServiceDefinition_AdditionalInformation_Value) FromCustomServiceDefinitionAdditionalInformationValue1(v CustomServiceDefinitionAdditionalInformationValue1) error

FromCustomServiceDefinitionAdditionalInformationValue1 overwrites any union data inside the CustomServiceDefinition_AdditionalInformation_Value as the provided CustomServiceDefinitionAdditionalInformationValue1

func (*CustomServiceDefinition_AdditionalInformation_Value) FromCustomServiceDefinitionAdditionalInformationValue2

func (t *CustomServiceDefinition_AdditionalInformation_Value) FromCustomServiceDefinitionAdditionalInformationValue2(v CustomServiceDefinitionAdditionalInformationValue2) error

FromCustomServiceDefinitionAdditionalInformationValue2 overwrites any union data inside the CustomServiceDefinition_AdditionalInformation_Value as the provided CustomServiceDefinitionAdditionalInformationValue2

func (*CustomServiceDefinition_AdditionalInformation_Value) FromCustomServiceDefinitionAdditionalInformationValue3

func (t *CustomServiceDefinition_AdditionalInformation_Value) FromCustomServiceDefinitionAdditionalInformationValue3(v CustomServiceDefinitionAdditionalInformationValue3) error

FromCustomServiceDefinitionAdditionalInformationValue3 overwrites any union data inside the CustomServiceDefinition_AdditionalInformation_Value as the provided CustomServiceDefinitionAdditionalInformationValue3

func (CustomServiceDefinition_AdditionalInformation_Value) MarshalJSON

func (*CustomServiceDefinition_AdditionalInformation_Value) MergeCustomServiceDefinitionAdditionalInformationValue0

func (t *CustomServiceDefinition_AdditionalInformation_Value) MergeCustomServiceDefinitionAdditionalInformationValue0(v CustomServiceDefinitionAdditionalInformationValue0) error

MergeCustomServiceDefinitionAdditionalInformationValue0 performs a merge with any union data inside the CustomServiceDefinition_AdditionalInformation_Value, using the provided CustomServiceDefinitionAdditionalInformationValue0

func (*CustomServiceDefinition_AdditionalInformation_Value) MergeCustomServiceDefinitionAdditionalInformationValue1

func (t *CustomServiceDefinition_AdditionalInformation_Value) MergeCustomServiceDefinitionAdditionalInformationValue1(v CustomServiceDefinitionAdditionalInformationValue1) error

MergeCustomServiceDefinitionAdditionalInformationValue1 performs a merge with any union data inside the CustomServiceDefinition_AdditionalInformation_Value, using the provided CustomServiceDefinitionAdditionalInformationValue1

func (*CustomServiceDefinition_AdditionalInformation_Value) MergeCustomServiceDefinitionAdditionalInformationValue2

func (t *CustomServiceDefinition_AdditionalInformation_Value) MergeCustomServiceDefinitionAdditionalInformationValue2(v CustomServiceDefinitionAdditionalInformationValue2) error

MergeCustomServiceDefinitionAdditionalInformationValue2 performs a merge with any union data inside the CustomServiceDefinition_AdditionalInformation_Value, using the provided CustomServiceDefinitionAdditionalInformationValue2

func (*CustomServiceDefinition_AdditionalInformation_Value) MergeCustomServiceDefinitionAdditionalInformationValue3

func (t *CustomServiceDefinition_AdditionalInformation_Value) MergeCustomServiceDefinitionAdditionalInformationValue3(v CustomServiceDefinitionAdditionalInformationValue3) error

MergeCustomServiceDefinitionAdditionalInformationValue3 performs a merge with any union data inside the CustomServiceDefinition_AdditionalInformation_Value, using the provided CustomServiceDefinitionAdditionalInformationValue3

func (*CustomServiceDefinition_AdditionalInformation_Value) UnmarshalJSON

type CustomServiceItem

type CustomServiceItem struct {
	ArticleItems []ArticleItem `json:"articleItems"`

	// CustomServiceDefinition CustomServiceDefinition
	CustomServiceDefinition CustomServiceDefinition `json:"customServiceDefinition"`
	CustomServiceItems      []CustomServiceItem     `json:"customServiceItems"`
	Id                      string                  `json:"id"`
}

CustomServiceItem CustomServiceItem

type CustomServiceItemForCreation

type CustomServiceItemForCreation struct {
	ArticleItems []ArticleItem `json:"articleItems"`

	// CustomServiceDefinition CustomServiceDefinition
	CustomServiceDefinition CustomServiceDefinition        `json:"customServiceDefinition"`
	CustomServiceItems      []CustomServiceItemForCreation `json:"customServiceItems"`
}

CustomServiceItemForCreation CustomServiceItemForCreation

type CustomServiceReference added in v0.3.0

type CustomServiceReference struct {
	ArticleItems []ArticleItem `json:"articleItems"`

	// CustomServiceDefinition CustomServiceDefinition
	CustomServiceDefinition CustomServiceDefinition `json:"customServiceDefinition"`
	CustomServiceItems      []CustomServiceItem     `json:"customServiceItems"`
	Id                      string                  `json:"id"`
}

CustomServiceReference CustomServiceReference

type CustomServiceReferenceForCreation added in v0.2.0

type CustomServiceReferenceForCreation struct {
	ArticleItems []ArticleItem `json:"articleItems"`

	// CustomServiceDefinition CustomServiceDefinition
	CustomServiceDefinition CustomServiceDefinition        `json:"customServiceDefinition"`
	CustomServiceItems      []CustomServiceItemForCreation `json:"customServiceItems"`
}

CustomServiceReferenceForCreation CustomServiceReferenceForCreation

type CutoffTime

type CutoffTime struct {
	// Hour Example: 16
	Hour float32 `json:"hour"`

	// Minute Example: 30
	Minute float32 `json:"minute"`
}

CutoffTime CutoffTime

type DateEqFilter

type DateEqFilter struct {
	Eq    *time.Time `json:"eq,omitempty"`
	NotEq *time.Time `json:"notEq,omitempty"`
}

DateEqFilter DateEqFilter

type DateFilter

type DateFilter struct {
	// After Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.
	After *string `json:"after,omitempty"`

	// Before Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.
	Before *string    `json:"before,omitempty"`
	Eq     *time.Time `json:"eq,omitempty"`
	Gt     *time.Time `json:"gt,omitempty"`
	Gte    *time.Time `json:"gte,omitempty"`
	Lt     *time.Time `json:"lt,omitempty"`
	Lte    *time.Time `json:"lte,omitempty"`
	NotEq  *time.Time `json:"notEq,omitempty"`
}

DateFilter DateFilter

type DateListFilter

type DateListFilter struct {
	// Contains DateEqFilter
	Contains *DateEqFilter `json:"contains,omitempty"`
}

DateListFilter DateListFilter

type DeleteDiscountForFacilityResponse

type DeleteDiscountForFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseDeleteDiscountForFacilityResponse

func ParseDeleteDiscountForFacilityResponse(rsp *http.Response) (*DeleteDiscountForFacilityResponse, error)

ParseDeleteDiscountForFacilityResponse parses an HTTP response from a DeleteDiscountForFacilityWithResponse call

func (DeleteDiscountForFacilityResponse) ContentType

func (r DeleteDiscountForFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteDiscountForFacilityResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (DeleteDiscountForFacilityResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteDiscountForFacilityResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteDiscountForFacilityResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteDiscountForFacilityResponse) Status

Status returns HTTPResponse.Status

func (DeleteDiscountForFacilityResponse) StatusCode

func (r DeleteDiscountForFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteFacilityConnectionResponse

type DeleteFacilityConnectionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseDeleteFacilityConnectionResponse

func ParseDeleteFacilityConnectionResponse(rsp *http.Response) (*DeleteFacilityConnectionResponse, error)

ParseDeleteFacilityConnectionResponse parses an HTTP response from a DeleteFacilityConnectionWithResponse call

func (DeleteFacilityConnectionResponse) ContentType

func (r DeleteFacilityConnectionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteFacilityConnectionResponse) GetBody added in v0.8.0

func (r DeleteFacilityConnectionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteFacilityConnectionResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteFacilityConnectionResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteFacilityConnectionResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteFacilityConnectionResponse) Status

Status returns HTTPResponse.Status

func (DeleteFacilityConnectionResponse) StatusCode

func (r DeleteFacilityConnectionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteFacilityListingPartialStockResponse

type DeleteFacilityListingPartialStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseDeleteFacilityListingPartialStockResponse

func ParseDeleteFacilityListingPartialStockResponse(rsp *http.Response) (*DeleteFacilityListingPartialStockResponse, error)

ParseDeleteFacilityListingPartialStockResponse parses an HTTP response from a DeleteFacilityListingPartialStockWithResponse call

func (DeleteFacilityListingPartialStockResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteFacilityListingPartialStockResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (DeleteFacilityListingPartialStockResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteFacilityListingPartialStockResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteFacilityListingPartialStockResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteFacilityListingPartialStockResponse) Status

Status returns HTTPResponse.Status

func (DeleteFacilityListingPartialStockResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteFacilityListingResponse

type DeleteFacilityListingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseDeleteFacilityListingResponse

func ParseDeleteFacilityListingResponse(rsp *http.Response) (*DeleteFacilityListingResponse, error)

ParseDeleteFacilityListingResponse parses an HTTP response from a DeleteFacilityListingWithResponse call

func (DeleteFacilityListingResponse) ContentType

func (r DeleteFacilityListingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteFacilityListingResponse) GetBody added in v0.8.0

func (r DeleteFacilityListingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteFacilityListingResponse) GetJSON401 added in v0.8.0

func (r DeleteFacilityListingResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteFacilityListingResponse) GetJSON403 added in v0.8.0

func (r DeleteFacilityListingResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteFacilityListingResponse) GetJSON404 added in v0.8.0

func (r DeleteFacilityListingResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteFacilityListingResponse) Status

Status returns HTTPResponse.Status

func (DeleteFacilityListingResponse) StatusCode

func (r DeleteFacilityListingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteFacilityParams

type DeleteFacilityParams struct {
	// ForceDeletion cascading deletion without pre condition check
	ForceDeletion *bool `form:"forceDeletion,omitempty" json:"forceDeletion,omitempty"`
}

DeleteFacilityParams defines parameters for DeleteFacility.

type DeleteFacilityResponse

type DeleteFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseDeleteFacilityResponse

func ParseDeleteFacilityResponse(rsp *http.Response) (*DeleteFacilityResponse, error)

ParseDeleteFacilityResponse parses an HTTP response from a DeleteFacilityWithResponse call

func (DeleteFacilityResponse) ContentType

func (r DeleteFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteFacilityResponse) GetBody added in v0.8.0

func (r DeleteFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteFacilityResponse) GetJSON401 added in v0.8.0

func (r DeleteFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteFacilityResponse) GetJSON403 added in v0.8.0

func (r DeleteFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteFacilityResponse) GetJSON404 added in v0.8.0

func (r DeleteFacilityResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteFacilityResponse) Status

func (r DeleteFacilityResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteFacilityResponse) StatusCode

func (r DeleteFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteListingsOfFacilityResponse

type DeleteListingsOfFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseDeleteListingsOfFacilityResponse

func ParseDeleteListingsOfFacilityResponse(rsp *http.Response) (*DeleteListingsOfFacilityResponse, error)

ParseDeleteListingsOfFacilityResponse parses an HTTP response from a DeleteListingsOfFacilityWithResponse call

func (DeleteListingsOfFacilityResponse) ContentType

func (r DeleteListingsOfFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteListingsOfFacilityResponse) GetBody added in v0.8.0

func (r DeleteListingsOfFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteListingsOfFacilityResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteListingsOfFacilityResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteListingsOfFacilityResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteListingsOfFacilityResponse) Status

Status returns HTTPResponse.Status

func (DeleteListingsOfFacilityResponse) StatusCode

func (r DeleteListingsOfFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteRoleResponse

type DeleteRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Role
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseDeleteRoleResponse

func ParseDeleteRoleResponse(rsp *http.Response) (*DeleteRoleResponse, error)

ParseDeleteRoleResponse parses an HTTP response from a DeleteRoleWithResponse call

func (DeleteRoleResponse) ContentType

func (r DeleteRoleResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteRoleResponse) GetBody added in v0.8.0

func (r DeleteRoleResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteRoleResponse) GetJSON200 added in v0.8.0

func (r DeleteRoleResponse) GetJSON200() *Role

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DeleteRoleResponse) GetJSON401 added in v0.8.0

func (r DeleteRoleResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteRoleResponse) GetJSON403 added in v0.8.0

func (r DeleteRoleResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteRoleResponse) GetJSON404 added in v0.8.0

func (r DeleteRoleResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteRoleResponse) Status

func (r DeleteRoleResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteRoleResponse) StatusCode

func (r DeleteRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteRoutingStrategyNodeConfigCategoryResponse added in v0.6.0

type DeleteRoutingStrategyNodeConfigCategoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseDeleteRoutingStrategyNodeConfigCategoryResponse added in v0.6.0

func ParseDeleteRoutingStrategyNodeConfigCategoryResponse(rsp *http.Response) (*DeleteRoutingStrategyNodeConfigCategoryResponse, error)

ParseDeleteRoutingStrategyNodeConfigCategoryResponse parses an HTTP response from a DeleteRoutingStrategyNodeConfigCategoryWithResponse call

func (DeleteRoutingStrategyNodeConfigCategoryResponse) ContentType added in v0.6.0

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteRoutingStrategyNodeConfigCategoryResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (DeleteRoutingStrategyNodeConfigCategoryResponse) GetJSON400 added in v0.8.0

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DeleteRoutingStrategyNodeConfigCategoryResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteRoutingStrategyNodeConfigCategoryResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteRoutingStrategyNodeConfigCategoryResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (DeleteRoutingStrategyNodeConfigCategoryResponse) StatusCode added in v0.6.0

StatusCode returns HTTPResponse.StatusCode

type DeleteSafetyStockResponse

type DeleteSafetyStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseDeleteSafetyStockResponse

func ParseDeleteSafetyStockResponse(rsp *http.Response) (*DeleteSafetyStockResponse, error)

ParseDeleteSafetyStockResponse parses an HTTP response from a DeleteSafetyStockWithResponse call

func (DeleteSafetyStockResponse) ContentType

func (r DeleteSafetyStockResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteSafetyStockResponse) GetBody added in v0.8.0

func (r DeleteSafetyStockResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteSafetyStockResponse) GetJSON401 added in v0.8.0

func (r DeleteSafetyStockResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteSafetyStockResponse) GetJSON403 added in v0.8.0

func (r DeleteSafetyStockResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteSafetyStockResponse) GetJSON404 added in v0.8.0

func (r DeleteSafetyStockResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteSafetyStockResponse) Status

func (r DeleteSafetyStockResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteSafetyStockResponse) StatusCode

func (r DeleteSafetyStockResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteStockResponse

type DeleteStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseDeleteStockResponse

func ParseDeleteStockResponse(rsp *http.Response) (*DeleteStockResponse, error)

ParseDeleteStockResponse parses an HTTP response from a DeleteStockWithResponse call

func (DeleteStockResponse) ContentType

func (r DeleteStockResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteStockResponse) GetBody added in v0.8.0

func (r DeleteStockResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteStockResponse) GetJSON401 added in v0.8.0

func (r DeleteStockResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteStockResponse) GetJSON403 added in v0.8.0

func (r DeleteStockResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteStockResponse) Status

func (r DeleteStockResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteStockResponse) StatusCode

func (r DeleteStockResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteUserResponse

type DeleteUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseDeleteUserResponse

func ParseDeleteUserResponse(rsp *http.Response) (*DeleteUserResponse, error)

ParseDeleteUserResponse parses an HTTP response from a DeleteUserWithResponse call

func (DeleteUserResponse) ContentType

func (r DeleteUserResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteUserResponse) GetBody added in v0.8.0

func (r DeleteUserResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteUserResponse) GetJSON401 added in v0.8.0

func (r DeleteUserResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteUserResponse) GetJSON403 added in v0.8.0

func (r DeleteUserResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteUserResponse) GetJSON404 added in v0.8.0

func (r DeleteUserResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteUserResponse) Status

func (r DeleteUserResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteUserResponse) StatusCode

func (r DeleteUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeliverCostCoefficient

type DeliverCostCoefficient struct {
	// MeasurementUnit The unit of measurement for the coefficient
	MeasurementUnit CostCoefficientMeasurementUnit `json:"measurementUnit"`

	// Value The coefficient value
	//
	// Example: 1.5
	Value float32 `json:"value"`
}

DeliverCostCoefficient DeliverCostCoefficient

type DeliveryArea

type DeliveryArea struct {
	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country string `json:"country"`

	// PostalCode Example: 40764
	PostalCode string `json:"postalCode"`
}

DeliveryArea DeliveryArea

type DeliveryCost added in v0.3.0

type DeliveryCost struct {
	// Cost The cost of sending with a carrier
	//
	// Example: 10.99
	Cost float32 `json:"cost"`

	// Currency The currency of the price as an ISO 4217 code.
	//
	// Example: EUR
	Currency string `json:"currency"`
}

DeliveryCost DeliveryCost

type DeliveryEvent added in v0.2.0

type DeliveryEvent struct {
	// DeliveryTarget The destination for a delivery
	DeliveryTarget  DeliveryTarget               `json:"deliveryTarget"`
	DeliveryTrigger DeliveryEventDeliveryTrigger `json:"deliveryTrigger"`
}

DeliveryEvent DeliveryEvent

type DeliveryEventDeliveryTrigger added in v0.2.0

type DeliveryEventDeliveryTrigger string

DeliveryEventDeliveryTrigger defines model for DeliveryEvent.DeliveryTrigger.

const (
	DEFAULT DeliveryEventDeliveryTrigger = "DEFAULT"
)

Defines values for DeliveryEventDeliveryTrigger.

func (DeliveryEventDeliveryTrigger) Valid added in v0.2.0

Valid indicates whether the value is a known member of the DeliveryEventDeliveryTrigger enum.

type DeliveryPreferences added in v0.2.0

type DeliveryPreferences struct {
	Collect *[]CollectDelivery `json:"collect,omitempty"`

	// EstimatedDeliveryDate Estimated delivery or pickup commitment.
	//
	// Example: 2020-02-03T09:45:51.525Z
	EstimatedDeliveryDate *time.Time `json:"estimatedDeliveryDate,omitempty"`

	// ReservationPreferences DeliveryReservationPreferences
	ReservationPreferences *DeliveryReservationPreferences `json:"reservationPreferences,omitempty"`

	// Shipping DeliveryPreferencesShipping
	Shipping *DeliveryPreferencesShipping `json:"shipping,omitempty"`

	// SourcingOptionRefs Id of the SourcingOptions
	SourcingOptionRefs *[]string `json:"sourcingOptionRefs,omitempty"`

	// SupplyingFacilities @deprecated Use supplyingFacilities under collect
	SupplyingFacilities *[]string `json:"supplyingFacilities,omitempty"`

	// TargetTime At which time the result is expected.
	//
	// Example: 2020-02-03T09:45:51.525Z
	TargetTime *time.Time `json:"targetTime,omitempty"`
}

DeliveryPreferences DeliveryPreferences

type DeliveryPreferencesShipping added in v0.2.0

type DeliveryPreferencesShipping struct {
	// CarrierProductCategory CarrierProductCategory
	CarrierProductCategory *CarrierProductCategory `json:"carrierProductCategory,omitempty"`

	// DesiredDeliveryTime Example: 2020-02-03T09:45:51.525Z
	DesiredDeliveryTime          *time.Time                     `json:"desiredDeliveryTime,omitempty"`
	PreferredCarriers            *[]PreferredCarrier            `json:"preferredCarriers,omitempty"`
	PreferredCarriersWithProduct *[]PreferredCarrierWithProduct `json:"preferredCarriersWithProduct,omitempty"`
	PreselectedFacilities        *[]PreselectedFacility         `json:"preselectedFacilities,omitempty"`

	// ServiceLevel DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.
	ServiceLevel *DeliveryPreferencesShippingServiceLevel `json:"serviceLevel,omitempty"`
}

DeliveryPreferencesShipping DeliveryPreferencesShipping

type DeliveryPreferencesShippingServiceLevel added in v0.2.0

type DeliveryPreferencesShippingServiceLevel string

DeliveryPreferencesShippingServiceLevel DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.

const (
	DeliveryPreferencesShippingServiceLevelDELIVERY DeliveryPreferencesShippingServiceLevel = "DELIVERY"
	DeliveryPreferencesShippingServiceLevelSAMEDAY  DeliveryPreferencesShippingServiceLevel = "SAMEDAY"
)

Defines values for DeliveryPreferencesShippingServiceLevel.

func (DeliveryPreferencesShippingServiceLevel) Valid added in v0.2.0

Valid indicates whether the value is a known member of the DeliveryPreferencesShippingServiceLevel enum.

type DeliveryPromiseCollect added in v0.3.0

type DeliveryPromiseCollect struct {
	// Facility BasicDeliveryPromiseShipmentFacility
	Facility   BasicDeliveryPromiseShipmentFacility `json:"facility"`
	LineItems  []DeliveryPromiseLineItem            `json:"lineItems"`
	TargetTime time.Time                            `json:"targetTime"`
}

DeliveryPromiseCollect DeliveryPromiseCollect

type DeliveryPromiseLineItem added in v0.3.0

type DeliveryPromiseLineItem struct {
	// AvailabilityTimeframe AvailabilityTimeframe
	AvailabilityTimeframe *AvailabilityTimeframe `json:"availabilityTimeframe,omitempty"`
	Available             *float32               `json:"available,omitempty"`

	// OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.
	// Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviour *OutOfStockBehaviour `json:"outOfStockBehaviour,omitempty"`
	Quantity            *float32             `json:"quantity,omitempty"`
	TenantArticleId     *string              `json:"tenantArticleId,omitempty"`
	Title               *string              `json:"title,omitempty"`
}

DeliveryPromiseLineItem DeliveryPromiseLineItem

type DeliveryPromiseShipment added in v0.3.0

type DeliveryPromiseShipment struct {
	Carriers []PromiseCarrier `json:"carriers"`

	// Facility BasicDeliveryPromiseShipmentFacility
	Facility  BasicDeliveryPromiseShipmentFacility `json:"facility"`
	LineItems []DeliveryPromiseLineItem            `json:"lineItems"`
}

DeliveryPromiseShipment DeliveryPromiseShipment

type DeliveryReservationMode added in v0.2.0

type DeliveryReservationMode = interface{}

DeliveryReservationMode DeliveryReservationMode

type DeliveryReservationPreferences added in v0.2.0

type DeliveryReservationPreferences struct {
	// Mode DeliveryReservationMode
	Mode DeliveryReservationMode `json:"mode"`

	// ReservationTime Example: 2020-02-03T09:45:51.525Z
	ReservationTime *time.Time `json:"reservationTime,omitempty"`
}

DeliveryReservationPreferences DeliveryReservationPreferences

type DeliveryTarget

type DeliveryTarget string

DeliveryTarget The destination for a delivery

const (
	SHIPTOCUSTOMER DeliveryTarget = "SHIP_TO_CUSTOMER"
	SHIPTOSTORE    DeliveryTarget = "SHIP_TO_STORE"
)

Defines values for DeliveryTarget.

func (DeliveryTarget) Valid

func (e DeliveryTarget) Valid() bool

Valid indicates whether the value is a known member of the DeliveryTarget enum.

type EffectivePermissionsResponse

type EffectivePermissionsResponse struct {
	// Roles The roles of the user
	Roles []UserRoleWithPermissions `json:"roles"`

	// UserId User ID of the current user
	UserId string `json:"userId"`
}

EffectivePermissionsResponse EffectivePermissionsResponse

type ErrorInner

type ErrorInner struct {
	// Description Example: Missing attributes were name, address, items
	Description *string `json:"description,omitempty"`

	// RequestVersion The version provided within an invalid request.
	//
	// Example: 41
	RequestVersion *int64 `json:"requestVersion,omitempty"`

	// Summary Example: One or more mandatory attributes were not provided.
	Summary string `json:"summary"`

	// Version Example: 42
	Version *int64 `json:"version,omitempty"`
}

ErrorInner ErrorInner

type EstimatedDeliveryTime added in v0.3.0

type EstimatedDeliveryTime struct {
	// MaxDeliveryDays Maximum total delivery time in days
	//
	// Example: 3
	MaxDeliveryDays int `json:"maxDeliveryDays"`

	// MinDeliveryDays Minimum total delivery time in days
	//
	// Example: 1
	MinDeliveryDays int `json:"minDeliveryDays"`
}

EstimatedDeliveryTime EstimatedDeliveryTime

type EvaluateRoutingStrategyJSONRequestBody added in v0.6.0

type EvaluateRoutingStrategyJSONRequestBody = OrderForCreation

EvaluateRoutingStrategyJSONRequestBody defines body for EvaluateRoutingStrategy for application/json ContentType.

type EvaluateRoutingStrategyNodeResponse added in v0.6.0

type EvaluateRoutingStrategyNodeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingStrategyEvaluationResult
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseEvaluateRoutingStrategyNodeResponse added in v0.6.0

func ParseEvaluateRoutingStrategyNodeResponse(rsp *http.Response) (*EvaluateRoutingStrategyNodeResponse, error)

ParseEvaluateRoutingStrategyNodeResponse parses an HTTP response from a EvaluateRoutingStrategyNodeWithResponse call

func (EvaluateRoutingStrategyNodeResponse) ContentType added in v0.6.0

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EvaluateRoutingStrategyNodeResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (EvaluateRoutingStrategyNodeResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EvaluateRoutingStrategyNodeResponse) GetJSON400 added in v0.8.0

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (EvaluateRoutingStrategyNodeResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (EvaluateRoutingStrategyNodeResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (EvaluateRoutingStrategyNodeResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (EvaluateRoutingStrategyNodeResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (EvaluateRoutingStrategyNodeResponse) StatusCode added in v0.6.0

StatusCode returns HTTPResponse.StatusCode

type EvaluateRoutingStrategyResponse added in v0.6.0

type EvaluateRoutingStrategyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingStrategyEvaluationResult
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseEvaluateRoutingStrategyResponse added in v0.6.0

func ParseEvaluateRoutingStrategyResponse(rsp *http.Response) (*EvaluateRoutingStrategyResponse, error)

ParseEvaluateRoutingStrategyResponse parses an HTTP response from a EvaluateRoutingStrategyWithResponse call

func (EvaluateRoutingStrategyResponse) ContentType added in v0.6.0

func (r EvaluateRoutingStrategyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EvaluateRoutingStrategyResponse) GetBody added in v0.8.0

func (r EvaluateRoutingStrategyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (EvaluateRoutingStrategyResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EvaluateRoutingStrategyResponse) GetJSON400 added in v0.8.0

func (r EvaluateRoutingStrategyResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (EvaluateRoutingStrategyResponse) GetJSON401 added in v0.8.0

func (r EvaluateRoutingStrategyResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (EvaluateRoutingStrategyResponse) GetJSON403 added in v0.8.0

func (r EvaluateRoutingStrategyResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (EvaluateRoutingStrategyResponse) GetJSON404 added in v0.8.0

func (r EvaluateRoutingStrategyResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (EvaluateRoutingStrategyResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (EvaluateRoutingStrategyResponse) StatusCode added in v0.6.0

func (r EvaluateRoutingStrategyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExecuteMeActionJSONBody

type ExecuteMeActionJSONBody struct {
	// contains filtered or unexported fields
}

ExecuteMeActionJSONBody defines parameters for ExecuteMeAction.

func (ExecuteMeActionJSONBody) AsModifyMeAction

func (t ExecuteMeActionJSONBody) AsModifyMeAction() (ModifyMeAction, error)

AsModifyMeAction returns the union data inside the ExecuteMeActionJSONBody as a ModifyMeAction

func (ExecuteMeActionJSONBody) AsModifyMyCredentialsAction

func (t ExecuteMeActionJSONBody) AsModifyMyCredentialsAction() (ModifyMyCredentialsAction, error)

AsModifyMyCredentialsAction returns the union data inside the ExecuteMeActionJSONBody as a ModifyMyCredentialsAction

func (*ExecuteMeActionJSONBody) FromModifyMeAction

func (t *ExecuteMeActionJSONBody) FromModifyMeAction(v ModifyMeAction) error

FromModifyMeAction overwrites any union data inside the ExecuteMeActionJSONBody as the provided ModifyMeAction

func (*ExecuteMeActionJSONBody) FromModifyMyCredentialsAction

func (t *ExecuteMeActionJSONBody) FromModifyMyCredentialsAction(v ModifyMyCredentialsAction) error

FromModifyMyCredentialsAction overwrites any union data inside the ExecuteMeActionJSONBody as the provided ModifyMyCredentialsAction

func (ExecuteMeActionJSONBody) MarshalJSON

func (t ExecuteMeActionJSONBody) MarshalJSON() ([]byte, error)

func (*ExecuteMeActionJSONBody) MergeModifyMeAction

func (t *ExecuteMeActionJSONBody) MergeModifyMeAction(v ModifyMeAction) error

MergeModifyMeAction performs a merge with any union data inside the ExecuteMeActionJSONBody, using the provided ModifyMeAction

func (*ExecuteMeActionJSONBody) MergeModifyMyCredentialsAction

func (t *ExecuteMeActionJSONBody) MergeModifyMyCredentialsAction(v ModifyMyCredentialsAction) error

MergeModifyMyCredentialsAction performs a merge with any union data inside the ExecuteMeActionJSONBody, using the provided ModifyMyCredentialsAction

func (*ExecuteMeActionJSONBody) UnmarshalJSON

func (t *ExecuteMeActionJSONBody) UnmarshalJSON(b []byte) error

type ExecuteMeActionJSONRequestBody

type ExecuteMeActionJSONRequestBody ExecuteMeActionJSONBody

ExecuteMeActionJSONRequestBody defines body for ExecuteMeAction for application/json ContentType.

type ExecuteMeActionResponse

type ExecuteMeActionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *User
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ApiError
}

func ParseExecuteMeActionResponse

func ParseExecuteMeActionResponse(rsp *http.Response) (*ExecuteMeActionResponse, error)

ParseExecuteMeActionResponse parses an HTTP response from a ExecuteMeActionWithResponse call

func (ExecuteMeActionResponse) ContentType

func (r ExecuteMeActionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ExecuteMeActionResponse) GetBody added in v0.8.0

func (r ExecuteMeActionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ExecuteMeActionResponse) GetJSON200 added in v0.8.0

func (r ExecuteMeActionResponse) GetJSON200() *User

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ExecuteMeActionResponse) GetJSON400 added in v0.8.0

func (r ExecuteMeActionResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ExecuteMeActionResponse) GetJSON401 added in v0.8.0

func (r ExecuteMeActionResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ExecuteMeActionResponse) GetJSON403 added in v0.8.0

func (r ExecuteMeActionResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ExecuteMeActionResponse) GetJSON409 added in v0.8.0

func (r ExecuteMeActionResponse) GetJSON409() *ApiError

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ExecuteMeActionResponse) Status

func (r ExecuteMeActionResponse) Status() string

Status returns HTTPResponse.Status

func (ExecuteMeActionResponse) StatusCode

func (r ExecuteMeActionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExportContainerSearchQuery added in v0.3.0

type ExportContainerSearchQuery struct {
	And *[]ExportContainerSearchQuery `json:"and,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]ExportContainerSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// Description Search by description
	Description *StringFilter `json:"description,omitempty"`

	// Name Search by name
	Name *StringFilter                 `json:"name,omitempty"`
	Or   *[]ExportContainerSearchQuery `json:"or,omitempty"`

	// TenantExportContainerId Search by tenantExportContainerId
	//
	// Example: MY_EXPORTCONTAINER_ID
	TenantExportContainerId *StringFilter `json:"tenantExportContainerId,omitempty"`
}

ExportContainerSearchQuery ExportContainerSearchQuery

type ExportContainerSearchQuery_CustomAttributes_AdditionalProperties added in v0.3.0

type ExportContainerSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

ExportContainerSearchQuery_CustomAttributes_AdditionalProperties defines model for ExportContainerSearchQuery.customAttributes.AdditionalProperties.

func (ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter added in v0.3.0

AsBooleanFilter returns the union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter added in v0.3.0

AsDateFilter returns the union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter added in v0.3.0

AsNumberEqFilter returns the union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter added in v0.3.0

AsStringEqFilter returns the union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter added in v0.3.0

FromBooleanFilter overwrites any union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter added in v0.3.0

FromDateFilter overwrites any union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter added in v0.3.0

FromNumberEqFilter overwrites any union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter added in v0.3.0

FromStringEqFilter overwrites any union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON added in v0.3.0

func (*ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter added in v0.3.0

MergeBooleanFilter performs a merge with any union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter added in v0.3.0

MergeDateFilter performs a merge with any union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter added in v0.3.0

MergeNumberEqFilter performs a merge with any union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter added in v0.3.0

MergeStringEqFilter performs a merge with any union data inside the ExportContainerSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*ExportContainerSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON added in v0.3.0

type Facility

type Facility struct {
	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Id The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.
	//
	// Example: Esb20gpHBL94X5NdMp3C
	Id string `json:"id"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Name Example: Hamburg NW2
	Name           string                   `json:"name"`
	OperativeCosts *[]FacilityOperativeCost `json:"operativeCosts,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status FacilityStatus  `json:"status"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type FacilityType `json:"type"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

Facility Facility

type FacilityActionJSONRequestBody

type FacilityActionJSONRequestBody = FacilityActionsParameter

FacilityActionJSONRequestBody defines body for FacilityAction for application/json ContentType.

type FacilityActionResponse

type FacilityActionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ManagedFacility
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseFacilityActionResponse

func ParseFacilityActionResponse(rsp *http.Response) (*FacilityActionResponse, error)

ParseFacilityActionResponse parses an HTTP response from a FacilityActionWithResponse call

func (FacilityActionResponse) ContentType

func (r FacilityActionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (FacilityActionResponse) GetBody added in v0.8.0

func (r FacilityActionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (FacilityActionResponse) GetJSON200 added in v0.8.0

func (r FacilityActionResponse) GetJSON200() *ManagedFacility

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (FacilityActionResponse) GetJSON401 added in v0.8.0

func (r FacilityActionResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (FacilityActionResponse) GetJSON403 added in v0.8.0

func (r FacilityActionResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (FacilityActionResponse) Status

func (r FacilityActionResponse) Status() string

Status returns HTTPResponse.Status

func (FacilityActionResponse) StatusCode

func (r FacilityActionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FacilityActionsParameter

type FacilityActionsParameter struct {
	// contains filtered or unexported fields
}

FacilityActionsParameter FacilityActionsParameter

func (FacilityActionsParameter) AsRemoveFacilityCoordinatesActionParameter

func (t FacilityActionsParameter) AsRemoveFacilityCoordinatesActionParameter() (RemoveFacilityCoordinatesActionParameter, error)

AsRemoveFacilityCoordinatesActionParameter returns the union data inside the FacilityActionsParameter as a RemoveFacilityCoordinatesActionParameter

func (FacilityActionsParameter) AsUpdateFacilityCoordinatesActionParameter

func (t FacilityActionsParameter) AsUpdateFacilityCoordinatesActionParameter() (UpdateFacilityCoordinatesActionParameter, error)

AsUpdateFacilityCoordinatesActionParameter returns the union data inside the FacilityActionsParameter as a UpdateFacilityCoordinatesActionParameter

func (*FacilityActionsParameter) FromRemoveFacilityCoordinatesActionParameter

func (t *FacilityActionsParameter) FromRemoveFacilityCoordinatesActionParameter(v RemoveFacilityCoordinatesActionParameter) error

FromRemoveFacilityCoordinatesActionParameter overwrites any union data inside the FacilityActionsParameter as the provided RemoveFacilityCoordinatesActionParameter

func (*FacilityActionsParameter) FromUpdateFacilityCoordinatesActionParameter

func (t *FacilityActionsParameter) FromUpdateFacilityCoordinatesActionParameter(v UpdateFacilityCoordinatesActionParameter) error

FromUpdateFacilityCoordinatesActionParameter overwrites any union data inside the FacilityActionsParameter as the provided UpdateFacilityCoordinatesActionParameter

func (FacilityActionsParameter) MarshalJSON

func (t FacilityActionsParameter) MarshalJSON() ([]byte, error)

func (*FacilityActionsParameter) MergeRemoveFacilityCoordinatesActionParameter

func (t *FacilityActionsParameter) MergeRemoveFacilityCoordinatesActionParameter(v RemoveFacilityCoordinatesActionParameter) error

MergeRemoveFacilityCoordinatesActionParameter performs a merge with any union data inside the FacilityActionsParameter, using the provided RemoveFacilityCoordinatesActionParameter

func (*FacilityActionsParameter) MergeUpdateFacilityCoordinatesActionParameter

func (t *FacilityActionsParameter) MergeUpdateFacilityCoordinatesActionParameter(v UpdateFacilityCoordinatesActionParameter) error

MergeUpdateFacilityCoordinatesActionParameter performs a merge with any union data inside the FacilityActionsParameter, using the provided UpdateFacilityCoordinatesActionParameter

func (*FacilityActionsParameter) UnmarshalJSON

func (t *FacilityActionsParameter) UnmarshalJSON(b []byte) error

type FacilityAddress

type FacilityAddress struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// City Example: Langenfeld
	City string `json:"city"`

	// CompanyName Example: Speedy Boxales Ltd.
	CompanyName string `json:"companyName"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country string `json:"country"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`
	EmailAddresses   *[]struct {
		// Recipient Human readable information who is the recipient for emails sent to this address.
		//
		// Example: 'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.
		Recipient *string `json:"recipient,omitempty"`
		Value     string  `json:"value"`
	} `json:"emailAddresses,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber  *string `json:"houseNumber,omitempty"`
	PhoneNumbers *[]struct {
		// CustomAttributes Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
		CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

		// Label Can be used to give a description for the number, like "private", "business number", etc.
		Label *string                         `json:"label,omitempty"`
		Type  FacilityAddressPhoneNumbersType `json:"type"`

		// Value The number itself. We do not enforce any format (yet).
		Value string `json:"value"`
	} `json:"phoneNumbers,omitempty"`

	// PostalCode Example: 40764
	PostalCode string `json:"postalCode"`

	// Province Example: NRW
	Province *string `json:"province,omitempty"`

	// ResolvedCoordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
	ResolvedCoordinates *Coordinates `json:"resolvedCoordinates,omitempty"`

	// ResolvedTimeZone Timezone for information retrieved e.g. by the Google Maps API
	ResolvedTimeZone *TimeZone `json:"resolvedTimeZone,omitempty"`

	// Street Example: Hauptstr.
	Street string `json:"street"`
}

FacilityAddress FacilityAddress

type FacilityAddressEmailAddressesFilter

type FacilityAddressEmailAddressesFilter struct {
	// Recipient Search by recipient
	Recipient *StringFilter `json:"recipient,omitempty"`

	// Value Search by value
	Value *StringFilter `json:"value,omitempty"`
}

FacilityAddressEmailAddressesFilter FacilityAddressEmailAddressesFilter

type FacilityAddressEmailAddressesListFilter

type FacilityAddressEmailAddressesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *FacilityAddressEmailAddressesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

FacilityAddressEmailAddressesListFilter FacilityAddressEmailAddressesListFilter

type FacilityAddressFilter

type FacilityAddressFilter struct {
	// City Search by city
	//
	// Example: Yellowstone
	City *StringSearchFilter `json:"city,omitempty"`

	// CompanyName Search by companyName
	CompanyName *StringFilter `json:"companyName,omitempty"`

	// Country Search by country
	//
	// Example: US
	Country *StringSearchFilter `json:"country,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]FacilityAddressFilter_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// EmailAddresses Nested list search by emailAddresses
	//
	// Example: phil.bison@fulfillmenttools.com
	EmailAddresses *FacilityAddressEmailAddressesListFilter `json:"emailAddresses,omitempty"`

	// HouseNumber Search by houseNumber
	//
	// Example: 42
	HouseNumber *StringFilter `json:"houseNumber,omitempty"`

	// PostalCode Search by postalCode
	//
	// Example: 42420
	PostalCode *StringSearchFilter `json:"postalCode,omitempty"`

	// Province Search by province
	Province *StringFilter `json:"province,omitempty"`

	// Street Search by street
	Street *StringFilter `json:"street,omitempty"`
}

FacilityAddressFilter FacilityAddressFilter

type FacilityAddressFilter_CustomAttributes_AdditionalProperties

type FacilityAddressFilter_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

FacilityAddressFilter_CustomAttributes_AdditionalProperties defines model for FacilityAddressFilter.customAttributes.AdditionalProperties.

func (FacilityAddressFilter_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties as a BooleanFilter

func (FacilityAddressFilter_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties as a DateFilter

func (FacilityAddressFilter_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (FacilityAddressFilter_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*FacilityAddressFilter_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*FacilityAddressFilter_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*FacilityAddressFilter_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*FacilityAddressFilter_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (FacilityAddressFilter_CustomAttributes_AdditionalProperties) MarshalJSON

func (*FacilityAddressFilter_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*FacilityAddressFilter_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*FacilityAddressFilter_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*FacilityAddressFilter_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the FacilityAddressFilter_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*FacilityAddressFilter_CustomAttributes_AdditionalProperties) UnmarshalJSON

type FacilityAddressForCreation

type FacilityAddressForCreation struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// City Example: Langenfeld
	City string `json:"city"`

	// CompanyName Example: Speedy Boxales Ltd.
	CompanyName string `json:"companyName"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country string `json:"country"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`
	EmailAddresses   *[]struct {
		// Recipient Human readable information who is the recipient for emails sent to this address.
		//
		// Example: 'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.
		Recipient *string `json:"recipient,omitempty"`
		Value     string  `json:"value"`
	} `json:"emailAddresses,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber  *string `json:"houseNumber,omitempty"`
	PhoneNumbers *[]struct {
		// CustomAttributes Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
		CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

		// Label Can be used to give a description for the number, like "private", "business number", etc.
		Label *string                                    `json:"label,omitempty"`
		Type  FacilityAddressForCreationPhoneNumbersType `json:"type"`

		// Value The number itself. We do not enforce any format (yet).
		Value string `json:"value"`
	} `json:"phoneNumbers,omitempty"`

	// PostalCode Example: 40764
	PostalCode string `json:"postalCode"`

	// Province Example: NRW
	Province *string `json:"province,omitempty"`

	// ResolvedCoordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
	ResolvedCoordinates *Coordinates `json:"resolvedCoordinates,omitempty"`

	// ResolvedTimeZone User-specified time zone in identifier format (e.g., "America/Los_Angeles"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified.
	//
	// Example: America/Los_Angeles
	ResolvedTimeZone *TimeZoneForCreation `json:"resolvedTimeZone,omitempty"`

	// Street Example: Hauptstr.
	Street string `json:"street"`
}

FacilityAddressForCreation FacilityAddressForCreation

type FacilityAddressForCreationPhoneNumbersType

type FacilityAddressForCreationPhoneNumbersType string

FacilityAddressForCreationPhoneNumbersType defines model for FacilityAddressForCreation.PhoneNumbers.Type.

const (
	FacilityAddressForCreationPhoneNumbersTypeMOBILE FacilityAddressForCreationPhoneNumbersType = "MOBILE"
	FacilityAddressForCreationPhoneNumbersTypePHONE  FacilityAddressForCreationPhoneNumbersType = "PHONE"
)

Defines values for FacilityAddressForCreationPhoneNumbersType.

func (FacilityAddressForCreationPhoneNumbersType) Valid

Valid indicates whether the value is a known member of the FacilityAddressForCreationPhoneNumbersType enum.

type FacilityAddressPhoneNumbersType

type FacilityAddressPhoneNumbersType string

FacilityAddressPhoneNumbersType defines model for FacilityAddress.PhoneNumbers.Type.

const (
	FacilityAddressPhoneNumbersTypeMOBILE FacilityAddressPhoneNumbersType = "MOBILE"
	FacilityAddressPhoneNumbersTypePHONE  FacilityAddressPhoneNumbersType = "PHONE"
)

Defines values for FacilityAddressPhoneNumbersType.

func (FacilityAddressPhoneNumbersType) Valid

Valid indicates whether the value is a known member of the FacilityAddressPhoneNumbersType enum.

type FacilityAddressSort

type FacilityAddressSort struct {
	City       *FacilityAddressSortCity       `json:"city,omitempty"`
	Country    *FacilityAddressSortCountry    `json:"country,omitempty"`
	PostalCode *FacilityAddressSortPostalCode `json:"postalCode,omitempty"`
}

FacilityAddressSort FacilityAddressSort

type FacilityAddressSortCity

type FacilityAddressSortCity string

FacilityAddressSortCity defines model for FacilityAddressSort.City.

const (
	FacilityAddressSortCityASC  FacilityAddressSortCity = "ASC"
	FacilityAddressSortCityDESC FacilityAddressSortCity = "DESC"
)

Defines values for FacilityAddressSortCity.

func (FacilityAddressSortCity) Valid

func (e FacilityAddressSortCity) Valid() bool

Valid indicates whether the value is a known member of the FacilityAddressSortCity enum.

type FacilityAddressSortCountry

type FacilityAddressSortCountry string

FacilityAddressSortCountry defines model for FacilityAddressSort.Country.

const (
	FacilityAddressSortCountryASC  FacilityAddressSortCountry = "ASC"
	FacilityAddressSortCountryDESC FacilityAddressSortCountry = "DESC"
)

Defines values for FacilityAddressSortCountry.

func (FacilityAddressSortCountry) Valid

func (e FacilityAddressSortCountry) Valid() bool

Valid indicates whether the value is a known member of the FacilityAddressSortCountry enum.

type FacilityAddressSortPostalCode

type FacilityAddressSortPostalCode string

FacilityAddressSortPostalCode defines model for FacilityAddressSort.PostalCode.

const (
	FacilityAddressSortPostalCodeASC  FacilityAddressSortPostalCode = "ASC"
	FacilityAddressSortPostalCodeDESC FacilityAddressSortPostalCode = "DESC"
)

Defines values for FacilityAddressSortPostalCode.

func (FacilityAddressSortPostalCode) Valid

Valid indicates whether the value is a known member of the FacilityAddressSortPostalCode enum.

type FacilityCarrierConnection

type FacilityCarrierConnection struct {
	// CarrierRef Reference to the carrier
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	CarrierRef string `json:"carrierRef"`

	// Configuration Carrier-specific configuration
	Configuration *map[string]interface{} `json:"configuration,omitempty"`

	// Created Creation timestamp
	//
	// Example: 2026-06-17T12:00:00.000Z
	Created time.Time `json:"created"`

	// Credentials Carrier-specific credentials
	Credentials *map[string]interface{} `json:"credentials,omitempty"`

	// CutoffTime CutoffTime
	CutoffTime *CutoffTime `json:"cutoffTime,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes *CarrierCutoffTimes `json:"cutoffTimes,omitempty"`

	// DeliveryAreas Delivery areas supported by this connection
	DeliveryAreas *[]DeliveryArea `json:"deliveryAreas,omitempty"`

	// DeliveryType Type of delivery service
	DeliveryType *FacilityCarrierConnectionDeliveryType `json:"deliveryType,omitempty"`

	// FacilityRef Reference to the facility
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef string `json:"facilityRef"`

	// Id Unique identifier for the facility carrier connection
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id string `json:"id"`

	// Key Configuration key for the carrier connection
	Key string `json:"key"`

	// LastModified Last modification timestamp
	//
	// Example: 2026-06-17T12:00:00.000Z
	LastModified time.Time `json:"lastModified"`

	// Name Human-readable name for the connection
	Name *string `json:"name,omitempty"`

	// ParcelLabelClassifications Parcel label classifications
	ParcelLabelClassifications *[]ParcelLabelClassification `json:"parcelLabelClassifications,omitempty"`

	// Status Status of the carrier connection
	Status FacilityCarrierConnectionStatus `json:"status"`

	// Tags Tags associated with the connection
	Tags *[]TagReference `json:"tags,omitempty"`

	// ValidDeliveryTargets Valid delivery targets for this connection
	ValidDeliveryTargets *[]DeliveryTarget `json:"validDeliveryTargets,omitempty"`

	// Version Version number for optimistic locking
	//
	// Example: 1
	Version float32 `json:"version"`
}

FacilityCarrierConnection FacilityCarrierConnection

type FacilityCarrierConnectionDeliveryType

type FacilityCarrierConnectionDeliveryType string

FacilityCarrierConnectionDeliveryType Type of delivery service

const (
	FacilityCarrierConnectionDeliveryTypeDELIVERY FacilityCarrierConnectionDeliveryType = "DELIVERY"
	FacilityCarrierConnectionDeliveryTypeSAMEDAY  FacilityCarrierConnectionDeliveryType = "SAMEDAY"
)

Defines values for FacilityCarrierConnectionDeliveryType.

func (FacilityCarrierConnectionDeliveryType) Valid

Valid indicates whether the value is a known member of the FacilityCarrierConnectionDeliveryType enum.

type FacilityCarrierConnectionForCreation

type FacilityCarrierConnectionForCreation struct {
	// Configuration Carrier-specific configuration
	Configuration *map[string]interface{} `json:"configuration,omitempty"`

	// Credentials Carrier-specific credentials
	Credentials *map[string]interface{} `json:"credentials,omitempty"`

	// CutoffTime CutoffTime
	CutoffTime *CutoffTime `json:"cutoffTime,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes *CarrierCutoffTimes `json:"cutoffTimes,omitempty"`

	// DeliveryAreas Delivery areas supported by this connection
	DeliveryAreas *[]DeliveryArea `json:"deliveryAreas,omitempty"`

	// Name Human-readable name for the connection
	Name *string `json:"name,omitempty"`

	// ParcelLabelClassifications Parcel label classifications for creation
	ParcelLabelClassifications *[]ParcelLabelClassificationForCreation `json:"parcelLabelClassifications,omitempty"`

	// Status Status of the carrier connection
	Status *FacilityCarrierConnectionForCreationStatus `json:"status,omitempty"`

	// Tags Tags associated with the connection
	Tags *[]TagReference `json:"tags,omitempty"`

	// ValidDeliveryTargets Valid delivery targets for this connection
	ValidDeliveryTargets *[]DeliveryTarget `json:"validDeliveryTargets,omitempty"`
}

FacilityCarrierConnectionForCreation FacilityCarrierConnectionForCreation

type FacilityCarrierConnectionForCreationStatus

type FacilityCarrierConnectionForCreationStatus string

FacilityCarrierConnectionForCreationStatus Status of the carrier connection

const (
	FacilityCarrierConnectionForCreationStatusACTIVE   FacilityCarrierConnectionForCreationStatus = "ACTIVE"
	FacilityCarrierConnectionForCreationStatusINACTIVE FacilityCarrierConnectionForCreationStatus = "INACTIVE"
)

Defines values for FacilityCarrierConnectionForCreationStatus.

func (FacilityCarrierConnectionForCreationStatus) Valid

Valid indicates whether the value is a known member of the FacilityCarrierConnectionForCreationStatus enum.

type FacilityCarrierConnectionForModification

type FacilityCarrierConnectionForModification struct {
	// Configuration Carrier-specific configuration
	Configuration *map[string]interface{} `json:"configuration,omitempty"`

	// Credentials Carrier-specific credentials
	Credentials *map[string]interface{} `json:"credentials,omitempty"`

	// CutoffTime CutoffTime
	CutoffTime *CutoffTime `json:"cutoffTime,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes *CarrierCutoffTimes `json:"cutoffTimes,omitempty"`

	// DeliveryAreas Delivery areas supported by this connection
	DeliveryAreas *[]DeliveryArea `json:"deliveryAreas,omitempty"`

	// Name Human-readable name for the connection
	Name *string `json:"name,omitempty"`

	// ParcelLabelClassifications Parcel label classifications for creation
	ParcelLabelClassifications *[]ParcelLabelClassificationForCreation `json:"parcelLabelClassifications,omitempty"`

	// Status Status of the carrier connection
	Status *FacilityCarrierConnectionForModificationStatus `json:"status,omitempty"`

	// Tags Tags associated with the connection
	Tags *[]TagReference `json:"tags,omitempty"`

	// ValidDeliveryTargets Valid delivery targets for this connection
	ValidDeliveryTargets *[]DeliveryTarget `json:"validDeliveryTargets,omitempty"`

	// Version Version number for optimistic locking
	//
	// Example: 1
	Version float32 `json:"version"`
}

FacilityCarrierConnectionForModification FacilityCarrierConnectionForModification

type FacilityCarrierConnectionForModificationStatus

type FacilityCarrierConnectionForModificationStatus string

FacilityCarrierConnectionForModificationStatus Status of the carrier connection

const (
	FacilityCarrierConnectionForModificationStatusACTIVE   FacilityCarrierConnectionForModificationStatus = "ACTIVE"
	FacilityCarrierConnectionForModificationStatusINACTIVE FacilityCarrierConnectionForModificationStatus = "INACTIVE"
)

Defines values for FacilityCarrierConnectionForModificationStatus.

func (FacilityCarrierConnectionForModificationStatus) Valid

Valid indicates whether the value is a known member of the FacilityCarrierConnectionForModificationStatus enum.

type FacilityCarrierConnectionStatus

type FacilityCarrierConnectionStatus string

FacilityCarrierConnectionStatus Status of the carrier connection

const (
	FacilityCarrierConnectionStatusACTIVE   FacilityCarrierConnectionStatus = "ACTIVE"
	FacilityCarrierConnectionStatusINACTIVE FacilityCarrierConnectionStatus = "INACTIVE"
)

Defines values for FacilityCarrierConnectionStatus.

func (FacilityCarrierConnectionStatus) Valid

Valid indicates whether the value is a known member of the FacilityCarrierConnectionStatus enum.

type FacilityContact

type FacilityContact struct {
	// CustomAttributes Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`
	FirstName        string                  `json:"firstName"`
	LastName         string                  `json:"lastName"`

	// RoleDescription Example: Manager, Supervisor, Teamleader, etc.
	RoleDescription *string `json:"roleDescription,omitempty"`
}

FacilityContact FacilityContact

type FacilityContactFilter

type FacilityContactFilter struct {
	// FirstName Search by firstName
	FirstName *StringFilter `json:"firstName,omitempty"`

	// LastName Search by lastName
	LastName *StringFilter `json:"lastName,omitempty"`
}

FacilityContactFilter FacilityContactFilter

type FacilityDiscount

type FacilityDiscount struct {
	// Context The context of the discount. This is used to determine the conditions  under which the discount can be applied.
	Context *[]FacilityDiscountContext `json:"context,omitempty"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created  *time.Time                `json:"created,omitempty"`
	Discount FacilityDiscount_Discount `json:"discount"`

	// FacilityRef The id of the facility the discount belongs to. It is generated during creation automatically and suits as the primary identifier of the described entity.
	//
	// Example: 5d35d4b8-8a07-40c5-8486-eae2de902597
	FacilityRef string `json:"facilityRef"`

	// Id The id of the supplier discount. It is generated during creation automatically and suits as the primary identifier of the described entity.
	//
	// Example: 5d35d4b8-8a07-40c5-8486-eae2de902597
	Id string `json:"id"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Priority The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.
	//
	// Example: 1
	Priority int `json:"priority"`

	// Type Determines the price type this discount can be applied to.
	Type FacilityDiscountPriceType `json:"type"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

FacilityDiscount FacilityDiscount

type FacilityDiscountAbsolute

type FacilityDiscountAbsolute struct {
	Type   FacilityDiscountAbsoluteType      `json:"type"`
	Values []FacilityDiscountAbsoluteElement `json:"values"`
}

FacilityDiscountAbsolute FacilityDiscountAbsolute

type FacilityDiscountAbsoluteElement

type FacilityDiscountAbsoluteElement struct {
	// Currency The currency of the price as an ISO 4217 code.
	//
	// Example: EUR
	Currency CurrencyCode `json:"currency"`

	// DecimalPlaces Number of decimal places for the given currency
	//
	// Example: 2
	DecimalPlaces int `json:"decimalPlaces"`

	// Value Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.
	//
	// Example: 5
	Value int `json:"value"`
}

FacilityDiscountAbsoluteElement FacilityDiscountAbsoluteElement

type FacilityDiscountAbsoluteForCreation

type FacilityDiscountAbsoluteForCreation struct {
	Type   FacilityDiscountAbsoluteForCreationType `json:"type"`
	Values []FacilityDiscountAbsoluteElement       `json:"values"`
}

FacilityDiscountAbsoluteForCreation FacilityDiscountAbsoluteForCreation

type FacilityDiscountAbsoluteForCreationType

type FacilityDiscountAbsoluteForCreationType string

FacilityDiscountAbsoluteForCreationType defines model for FacilityDiscountAbsoluteForCreation.Type.

const (
	FacilityDiscountAbsoluteForCreationTypeABSOLUTE FacilityDiscountAbsoluteForCreationType = "ABSOLUTE"
)

Defines values for FacilityDiscountAbsoluteForCreationType.

func (FacilityDiscountAbsoluteForCreationType) Valid

Valid indicates whether the value is a known member of the FacilityDiscountAbsoluteForCreationType enum.

type FacilityDiscountAbsoluteType

type FacilityDiscountAbsoluteType string

FacilityDiscountAbsoluteType defines model for FacilityDiscountAbsolute.Type.

const (
	FacilityDiscountAbsoluteTypeABSOLUTE FacilityDiscountAbsoluteType = "ABSOLUTE"
)

Defines values for FacilityDiscountAbsoluteType.

func (FacilityDiscountAbsoluteType) Valid

Valid indicates whether the value is a known member of the FacilityDiscountAbsoluteType enum.

type FacilityDiscountContext

type FacilityDiscountContext struct {
	// Operator The operator used to define how the context values are evaluated or compared.
	Operator *ContextOperator `json:"operator,omitempty"`

	// Type The context type of the discount. This is used to determine the conditions  under which the discount can be applied.
	Type FacilityDiscountContextTypes `json:"type"`

	// Values The values of the context. This is used to determine the conditions  under which the discount can be applied.
	Values []string `json:"values"`
}

FacilityDiscountContext The context of the discount. This is used to determine the conditions under which the discount can be applied.

type FacilityDiscountContextTypes

type FacilityDiscountContextTypes string

FacilityDiscountContextTypes The context type of the discount. This is used to determine the conditions under which the discount can be applied.

const (
	FacilityDiscountContextTypesCATEGORY      FacilityDiscountContextTypes = "CATEGORY"
	FacilityDiscountContextTypesFACILITY      FacilityDiscountContextTypes = "FACILITY"
	FacilityDiscountContextTypesFACILITYGROUP FacilityDiscountContextTypes = "FACILITY_GROUP"
)

Defines values for FacilityDiscountContextTypes.

func (FacilityDiscountContextTypes) Valid

Valid indicates whether the value is a known member of the FacilityDiscountContextTypes enum.

type FacilityDiscountForCreation

type FacilityDiscountForCreation struct {
	// Context The context of the discount. This is used to determine the conditions  under which the discount can be applied.
	Context  *[]FacilityDiscountContext           `json:"context,omitempty"`
	Discount FacilityDiscountForCreation_Discount `json:"discount"`

	// Priority The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.
	//
	// Example: 1
	Priority int `json:"priority"`

	// Type Determines the price type this discount can be applied to.
	Type FacilityDiscountPriceType `json:"type"`
}

FacilityDiscountForCreation FacilityDiscountForCreation

type FacilityDiscountForCreation_Discount

type FacilityDiscountForCreation_Discount struct {
	// contains filtered or unexported fields
}

FacilityDiscountForCreation_Discount defines model for FacilityDiscountForCreation.Discount.

func (FacilityDiscountForCreation_Discount) AsFacilityDiscountAbsoluteForCreation

func (t FacilityDiscountForCreation_Discount) AsFacilityDiscountAbsoluteForCreation() (FacilityDiscountAbsoluteForCreation, error)

AsFacilityDiscountAbsoluteForCreation returns the union data inside the FacilityDiscountForCreation_Discount as a FacilityDiscountAbsoluteForCreation

func (FacilityDiscountForCreation_Discount) AsFacilityDiscountRelative

func (t FacilityDiscountForCreation_Discount) AsFacilityDiscountRelative() (FacilityDiscountRelative, error)

AsFacilityDiscountRelative returns the union data inside the FacilityDiscountForCreation_Discount as a FacilityDiscountRelative

func (*FacilityDiscountForCreation_Discount) FromFacilityDiscountAbsoluteForCreation

func (t *FacilityDiscountForCreation_Discount) FromFacilityDiscountAbsoluteForCreation(v FacilityDiscountAbsoluteForCreation) error

FromFacilityDiscountAbsoluteForCreation overwrites any union data inside the FacilityDiscountForCreation_Discount as the provided FacilityDiscountAbsoluteForCreation

func (*FacilityDiscountForCreation_Discount) FromFacilityDiscountRelative

func (t *FacilityDiscountForCreation_Discount) FromFacilityDiscountRelative(v FacilityDiscountRelative) error

FromFacilityDiscountRelative overwrites any union data inside the FacilityDiscountForCreation_Discount as the provided FacilityDiscountRelative

func (FacilityDiscountForCreation_Discount) MarshalJSON

func (t FacilityDiscountForCreation_Discount) MarshalJSON() ([]byte, error)

func (*FacilityDiscountForCreation_Discount) MergeFacilityDiscountAbsoluteForCreation

func (t *FacilityDiscountForCreation_Discount) MergeFacilityDiscountAbsoluteForCreation(v FacilityDiscountAbsoluteForCreation) error

MergeFacilityDiscountAbsoluteForCreation performs a merge with any union data inside the FacilityDiscountForCreation_Discount, using the provided FacilityDiscountAbsoluteForCreation

func (*FacilityDiscountForCreation_Discount) MergeFacilityDiscountRelative

func (t *FacilityDiscountForCreation_Discount) MergeFacilityDiscountRelative(v FacilityDiscountRelative) error

MergeFacilityDiscountRelative performs a merge with any union data inside the FacilityDiscountForCreation_Discount, using the provided FacilityDiscountRelative

func (*FacilityDiscountForCreation_Discount) UnmarshalJSON

func (t *FacilityDiscountForCreation_Discount) UnmarshalJSON(b []byte) error

type FacilityDiscountForUpdate

type FacilityDiscountForUpdate struct {
	// Context The context of the discount. This is used to determine the conditions  under which the discount can be applied.
	Context  *[]FacilityDiscountContext          `json:"context,omitempty"`
	Discount *FacilityDiscountForUpdate_Discount `json:"discount,omitempty"`

	// Priority The priority of the discount. Discounts with the lowest priority value are applied first. Must be greater than 0 and smaller than 1000.
	//
	// Example: 1
	Priority *int `json:"priority,omitempty"`

	// Type Determines the price type this discount can be applied to.
	Type *FacilityDiscountPriceType `json:"type,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

FacilityDiscountForUpdate FacilityDiscountForUpdate

type FacilityDiscountForUpdate_Discount

type FacilityDiscountForUpdate_Discount struct {
	// contains filtered or unexported fields
}

FacilityDiscountForUpdate_Discount defines model for FacilityDiscountForUpdate.Discount.

func (FacilityDiscountForUpdate_Discount) AsFacilityDiscountAbsoluteForCreation

func (t FacilityDiscountForUpdate_Discount) AsFacilityDiscountAbsoluteForCreation() (FacilityDiscountAbsoluteForCreation, error)

AsFacilityDiscountAbsoluteForCreation returns the union data inside the FacilityDiscountForUpdate_Discount as a FacilityDiscountAbsoluteForCreation

func (FacilityDiscountForUpdate_Discount) AsFacilityDiscountRelative

func (t FacilityDiscountForUpdate_Discount) AsFacilityDiscountRelative() (FacilityDiscountRelative, error)

AsFacilityDiscountRelative returns the union data inside the FacilityDiscountForUpdate_Discount as a FacilityDiscountRelative

func (*FacilityDiscountForUpdate_Discount) FromFacilityDiscountAbsoluteForCreation

func (t *FacilityDiscountForUpdate_Discount) FromFacilityDiscountAbsoluteForCreation(v FacilityDiscountAbsoluteForCreation) error

FromFacilityDiscountAbsoluteForCreation overwrites any union data inside the FacilityDiscountForUpdate_Discount as the provided FacilityDiscountAbsoluteForCreation

func (*FacilityDiscountForUpdate_Discount) FromFacilityDiscountRelative

func (t *FacilityDiscountForUpdate_Discount) FromFacilityDiscountRelative(v FacilityDiscountRelative) error

FromFacilityDiscountRelative overwrites any union data inside the FacilityDiscountForUpdate_Discount as the provided FacilityDiscountRelative

func (FacilityDiscountForUpdate_Discount) MarshalJSON

func (t FacilityDiscountForUpdate_Discount) MarshalJSON() ([]byte, error)

func (*FacilityDiscountForUpdate_Discount) MergeFacilityDiscountAbsoluteForCreation

func (t *FacilityDiscountForUpdate_Discount) MergeFacilityDiscountAbsoluteForCreation(v FacilityDiscountAbsoluteForCreation) error

MergeFacilityDiscountAbsoluteForCreation performs a merge with any union data inside the FacilityDiscountForUpdate_Discount, using the provided FacilityDiscountAbsoluteForCreation

func (*FacilityDiscountForUpdate_Discount) MergeFacilityDiscountRelative

func (t *FacilityDiscountForUpdate_Discount) MergeFacilityDiscountRelative(v FacilityDiscountRelative) error

MergeFacilityDiscountRelative performs a merge with any union data inside the FacilityDiscountForUpdate_Discount, using the provided FacilityDiscountRelative

func (*FacilityDiscountForUpdate_Discount) UnmarshalJSON

func (t *FacilityDiscountForUpdate_Discount) UnmarshalJSON(b []byte) error

type FacilityDiscountPaginatedResult

type FacilityDiscountPaginatedResult struct {
	// Items The list of discounts that match the search criteria. The list might be empty if no discounts match the search criteria.
	Items []FacilityDiscount `json:"items"`

	// Total The total number of discounts that match the search criteria. This number is not limited by the page size.
	//
	// Example: 42
	Total int64 `json:"total"`
}

FacilityDiscountPaginatedResult FacilityDiscountPaginatedResult

type FacilityDiscountPriceType

type FacilityDiscountPriceType string

FacilityDiscountPriceType Determines the price type this discount can be applied to.

const (
	SALESPRICE FacilityDiscountPriceType = "SALES_PRICE"
)

Defines values for FacilityDiscountPriceType.

func (FacilityDiscountPriceType) Valid

func (e FacilityDiscountPriceType) Valid() bool

Valid indicates whether the value is a known member of the FacilityDiscountPriceType enum.

type FacilityDiscountRelative

type FacilityDiscountRelative struct {
	Type FacilityDiscountRelativeType `json:"type"`

	// Value Provided discount in percent.
	//
	// Example: 7.1
	Value float32 `json:"value"`
}

FacilityDiscountRelative FacilityDiscountRelative

type FacilityDiscountRelativeType

type FacilityDiscountRelativeType string

FacilityDiscountRelativeType defines model for FacilityDiscountRelative.Type.

const (
	RELATIVE FacilityDiscountRelativeType = "RELATIVE"
)

Defines values for FacilityDiscountRelativeType.

func (FacilityDiscountRelativeType) Valid

Valid indicates whether the value is a known member of the FacilityDiscountRelativeType enum.

type FacilityDiscount_Discount

type FacilityDiscount_Discount struct {
	// contains filtered or unexported fields
}

FacilityDiscount_Discount defines model for FacilityDiscount.Discount.

func (FacilityDiscount_Discount) AsFacilityDiscountAbsolute added in v0.8.0

func (t FacilityDiscount_Discount) AsFacilityDiscountAbsolute() (FacilityDiscountAbsolute, error)

AsFacilityDiscountAbsolute returns the union data inside the FacilityDiscount_Discount as a FacilityDiscountAbsolute

func (FacilityDiscount_Discount) AsFacilityDiscountRelative

func (t FacilityDiscount_Discount) AsFacilityDiscountRelative() (FacilityDiscountRelative, error)

AsFacilityDiscountRelative returns the union data inside the FacilityDiscount_Discount as a FacilityDiscountRelative

func (*FacilityDiscount_Discount) FromFacilityDiscountAbsolute added in v0.8.0

func (t *FacilityDiscount_Discount) FromFacilityDiscountAbsolute(v FacilityDiscountAbsolute) error

FromFacilityDiscountAbsolute overwrites any union data inside the FacilityDiscount_Discount as the provided FacilityDiscountAbsolute

func (*FacilityDiscount_Discount) FromFacilityDiscountRelative

func (t *FacilityDiscount_Discount) FromFacilityDiscountRelative(v FacilityDiscountRelative) error

FromFacilityDiscountRelative overwrites any union data inside the FacilityDiscount_Discount as the provided FacilityDiscountRelative

func (FacilityDiscount_Discount) MarshalJSON

func (t FacilityDiscount_Discount) MarshalJSON() ([]byte, error)

func (*FacilityDiscount_Discount) MergeFacilityDiscountAbsolute added in v0.8.0

func (t *FacilityDiscount_Discount) MergeFacilityDiscountAbsolute(v FacilityDiscountAbsolute) error

MergeFacilityDiscountAbsolute performs a merge with any union data inside the FacilityDiscount_Discount, using the provided FacilityDiscountAbsolute

func (*FacilityDiscount_Discount) MergeFacilityDiscountRelative

func (t *FacilityDiscount_Discount) MergeFacilityDiscountRelative(v FacilityDiscountRelative) error

MergeFacilityDiscountRelative performs a merge with any union data inside the FacilityDiscount_Discount, using the provided FacilityDiscountRelative

func (*FacilityDiscount_Discount) UnmarshalJSON

func (t *FacilityDiscount_Discount) UnmarshalJSON(b []byte) error

type FacilityFacilityCarrierConnectionFilter

type FacilityFacilityCarrierConnectionFilter struct {
	// CarrierKey Filter facilities by configured carrier key
	CarrierKey *StringFilter `json:"carrierKey,omitempty"`
}

FacilityFacilityCarrierConnectionFilter FacilityFacilityCarrierConnectionFilter

type FacilityForCreation

type FacilityForCreation struct {
	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Name Example: Hamburg NW2
	Name           string                              `json:"name"`
	OperativeCosts *[]FacilityOperativeCostForCreation `json:"operativeCosts,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status *FacilityStatus `json:"status,omitempty"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type *FacilityType `json:"type,omitempty"`
}

FacilityForCreation FacilityForCreation

type FacilityGroupSearchQuery

type FacilityGroupSearchQuery struct {
	And *[]FacilityGroupSearchQuery `json:"and,omitempty"`

	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Name Search by name
	Name *LocalizedStringSearchFilter `json:"name,omitempty"`
	Or   *[]FacilityGroupSearchQuery  `json:"or,omitempty"`

	// TenantFacilityGroupId Search by tenantFacilityGroupId
	//
	// Example: MY_FACILITYGROUP_ID
	TenantFacilityGroupId *StringFilter `json:"tenantFacilityGroupId,omitempty"`
}

FacilityGroupSearchQuery FacilityGroupSearchQuery

type FacilityLocationType

type FacilityLocationType string

FacilityLocationType FacilityLocationType

const (
	FacilityLocationTypeEXTERNAL  FacilityLocationType = "EXTERNAL"
	FacilityLocationTypeSTORE     FacilityLocationType = "STORE"
	FacilityLocationTypeWAREHOUSE FacilityLocationType = "WAREHOUSE"
)

Defines values for FacilityLocationType.

func (FacilityLocationType) Valid

func (e FacilityLocationType) Valid() bool

Valid indicates whether the value is a known member of the FacilityLocationType enum.

type FacilityLocationTypeEnumFilter

type FacilityLocationTypeEnumFilter struct {
	// Eq Search by locationType
	Eq *FacilityLocationTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by locationType
	In *[]FacilityLocationTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by locationType
	NotEq *FacilityLocationTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

FacilityLocationTypeEnumFilter FacilityLocationTypeEnumFilter

type FacilityLocationTypeEnumFilterEq

type FacilityLocationTypeEnumFilterEq string

FacilityLocationTypeEnumFilterEq Search by locationType

const (
	FacilityLocationTypeEnumFilterEqEXTERNAL  FacilityLocationTypeEnumFilterEq = "EXTERNAL"
	FacilityLocationTypeEnumFilterEqSTORE     FacilityLocationTypeEnumFilterEq = "STORE"
	FacilityLocationTypeEnumFilterEqWAREHOUSE FacilityLocationTypeEnumFilterEq = "WAREHOUSE"
)

Defines values for FacilityLocationTypeEnumFilterEq.

func (FacilityLocationTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the FacilityLocationTypeEnumFilterEq enum.

type FacilityLocationTypeEnumFilterIn

type FacilityLocationTypeEnumFilterIn string

FacilityLocationTypeEnumFilterIn defines model for FacilityLocationTypeEnumFilter.In.

const (
	FacilityLocationTypeEnumFilterInEXTERNAL  FacilityLocationTypeEnumFilterIn = "EXTERNAL"
	FacilityLocationTypeEnumFilterInSTORE     FacilityLocationTypeEnumFilterIn = "STORE"
	FacilityLocationTypeEnumFilterInWAREHOUSE FacilityLocationTypeEnumFilterIn = "WAREHOUSE"
)

Defines values for FacilityLocationTypeEnumFilterIn.

func (FacilityLocationTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the FacilityLocationTypeEnumFilterIn enum.

type FacilityLocationTypeEnumFilterNotEq

type FacilityLocationTypeEnumFilterNotEq string

FacilityLocationTypeEnumFilterNotEq Search by locationType

const (
	FacilityLocationTypeEnumFilterNotEqEXTERNAL  FacilityLocationTypeEnumFilterNotEq = "EXTERNAL"
	FacilityLocationTypeEnumFilterNotEqSTORE     FacilityLocationTypeEnumFilterNotEq = "STORE"
	FacilityLocationTypeEnumFilterNotEqWAREHOUSE FacilityLocationTypeEnumFilterNotEq = "WAREHOUSE"
)

Defines values for FacilityLocationTypeEnumFilterNotEq.

func (FacilityLocationTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the FacilityLocationTypeEnumFilterNotEq enum.

type FacilityOperativeCost

type FacilityOperativeCost struct {
	// Currency The currency of the price as an ISO 4217 code.
	//
	// Example: EUR
	Currency *CurrencyCode `json:"currency"`

	// DecimalPlaces Number of decimal places for the given currency
	//
	// Example: 2
	DecimalPlaces int `json:"decimalPlaces"`

	// Value Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.
	//
	// Example: 25000
	Value int `json:"value"`
}

FacilityOperativeCost FacilityOperativeCost

type FacilityOperativeCostForCreation

type FacilityOperativeCostForCreation struct {
	// Currency The currency of the price as an ISO 4217 code.
	//
	// Example: EUR
	Currency *CurrencyCode `json:"currency"`

	// DecimalPlaces Number of decimal places for the given currency. We be defaulted according to the currency if missing.
	//
	// Example: 2
	DecimalPlaces *int `json:"decimalPlaces,omitempty"`

	// Value Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.
	//
	// Example: 25000
	Value int `json:"value"`
}

FacilityOperativeCostForCreation FacilityOperativeCostForCreation

type FacilityOrderBy

type FacilityOrderBy string

FacilityOrderBy Attribute to order a facility list

const (
	FacilityOrderByCREATED       FacilityOrderBy = "CREATED"
	FacilityOrderByNAME          FacilityOrderBy = "NAME"
	FacilityOrderByPOSTALCODEASC FacilityOrderBy = "POSTAL_CODE_ASC"
)

Defines values for FacilityOrderBy.

func (FacilityOrderBy) Valid

func (e FacilityOrderBy) Valid() bool

Valid indicates whether the value is a known member of the FacilityOrderBy enum.

type FacilityPaginatedResult

type FacilityPaginatedResult struct {
	Facilities []FacilityPaginatedResult_Facilities_Item `json:"facilities"`

	// PageInfo Pagination information for the search result.
	PageInfo PageInfo `json:"pageInfo"`

	// Total The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
	Total *float32 `json:"total,omitempty"`
}

FacilityPaginatedResult FacilityPaginatedResult

type FacilityPaginatedResult_Facilities_Item

type FacilityPaginatedResult_Facilities_Item struct {
	// contains filtered or unexported fields
}

FacilityPaginatedResult_Facilities_Item defines model for FacilityPaginatedResult.facilities.Item.

func (FacilityPaginatedResult_Facilities_Item) AsManagedFacility

AsManagedFacility returns the union data inside the FacilityPaginatedResult_Facilities_Item as a ManagedFacility

func (FacilityPaginatedResult_Facilities_Item) AsSupplier

AsSupplier returns the union data inside the FacilityPaginatedResult_Facilities_Item as a Supplier

func (*FacilityPaginatedResult_Facilities_Item) FromManagedFacility

FromManagedFacility overwrites any union data inside the FacilityPaginatedResult_Facilities_Item as the provided ManagedFacility

func (*FacilityPaginatedResult_Facilities_Item) FromSupplier

FromSupplier overwrites any union data inside the FacilityPaginatedResult_Facilities_Item as the provided Supplier

func (FacilityPaginatedResult_Facilities_Item) MarshalJSON

func (t FacilityPaginatedResult_Facilities_Item) MarshalJSON() ([]byte, error)

func (*FacilityPaginatedResult_Facilities_Item) MergeManagedFacility

MergeManagedFacility performs a merge with any union data inside the FacilityPaginatedResult_Facilities_Item, using the provided ManagedFacility

func (*FacilityPaginatedResult_Facilities_Item) MergeSupplier

MergeSupplier performs a merge with any union data inside the FacilityPaginatedResult_Facilities_Item, using the provided Supplier

func (*FacilityPaginatedResult_Facilities_Item) UnmarshalJSON

func (t *FacilityPaginatedResult_Facilities_Item) UnmarshalJSON(b []byte) error

type FacilityPatchActions deprecated

type FacilityPatchActions struct {
	Actions []ModifyFacility `json:"actions"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

FacilityPatchActions This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Deprecated; works only on managed facilities. Prefer to use ManagedFacilityForModification / SupplierForModification for full compatibility.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type FacilityRefSelector

type FacilityRefSelector struct {
	// FacilityRef Resolves a facility by its reference. This is the preferred way to resolve a facility.
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef string `json:"facilityRef"`
}

FacilityRefSelector FacilityRefSelector

type FacilityReferenceFilter

type FacilityReferenceFilter struct {
	// FacilityCarrierConnection The referenced entity
	FacilityCarrierConnection *FacilityFacilityCarrierConnectionFilter `json:"facilityCarrierConnection,omitempty"`
}

FacilityReferenceFilter FacilityReferenceFilter

type FacilitySearchPayload

type FacilitySearchPayload struct {
	// After 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`.
	After *string `json:"after,omitempty"`

	// Before 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).
	Before *string `json:"before,omitempty"`

	// Last Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
	Last *float32 `json:"last,omitempty"`

	// Options SearchOptions
	Options *SearchOptions `json:"options,omitempty"`

	// Query FacilitySearchQuery
	Query FacilitySearchQuery `json:"query"`

	// Size Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
	//
	// Example: 10
	Size *float32 `json:"size,omitempty"`

	// Sort Use for sorting the result.
	Sort *[]FacilitySort `json:"sort,omitempty"`

	// StartAfterId The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	StartAfterId *string `json:"startAfterId,omitempty"`
}

FacilitySearchPayload FacilitySearchPayload

type FacilitySearchQuery

type FacilitySearchQuery struct {
	// Address Nested search by address
	Address *FacilityAddressFilter `json:"address,omitempty"`
	And     *[]FacilitySearchQuery `json:"and,omitempty"`

	// Contact Nested search by contact
	Contact *FacilityContactFilter `json:"contact,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]FacilitySearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// FacilityGroupIds Filter facilities by facility group membership
	FacilityGroupIds *StringListFilter `json:"facilityGroupIds,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// LocationType Search by locationType
	LocationType *FacilityLocationTypeEnumFilter `json:"locationType,omitempty"`

	// Name Search by name
	Name *StringSearchFilter    `json:"name,omitempty"`
	Or   *[]FacilitySearchQuery `json:"or,omitempty"`

	// Referenced References to other entities
	Referenced *FacilityReferenceFilter `json:"referenced,omitempty"`

	// Services Nested list search by services
	Services *FacilityServicesListFilter `json:"services,omitempty"`

	// Status Search by status
	Status *FacilityStatusEnumFilter `json:"status,omitempty"`

	// Tags Nested list search by tags
	Tags *FacilityTagsListFilter `json:"tags,omitempty"`

	// TenantFacilityId Search by tenantFacilityId
	//
	// Example: MY_FACILITY_ID
	TenantFacilityId *StringFilter `json:"tenantFacilityId,omitempty"`

	// Type Search by type
	Type *FacilityTypeEnumFilter `json:"type,omitempty"`
}

FacilitySearchQuery FacilitySearchQuery

type FacilitySearchQuery_CustomAttributes_AdditionalProperties

type FacilitySearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

FacilitySearchQuery_CustomAttributes_AdditionalProperties defines model for FacilitySearchQuery.customAttributes.AdditionalProperties.

func (FacilitySearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (FacilitySearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (FacilitySearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (FacilitySearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*FacilitySearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*FacilitySearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*FacilitySearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*FacilitySearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (FacilitySearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*FacilitySearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*FacilitySearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*FacilitySearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*FacilitySearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the FacilitySearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*FacilitySearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type FacilityService

type FacilityService struct {
	// Type The description of the service this facility offers.
	Type FacilityServiceType `json:"type"`
}

FacilityService FacilityService

type FacilityServiceType

type FacilityServiceType string

FacilityServiceType The description of the service this facility offers.

const (
	FacilityServiceTypePICKUP        FacilityServiceType = "PICKUP"
	FacilityServiceTypeSHIPFROMSTORE FacilityServiceType = "SHIP_FROM_STORE"
)

Defines values for FacilityServiceType.

func (FacilityServiceType) Valid

func (e FacilityServiceType) Valid() bool

Valid indicates whether the value is a known member of the FacilityServiceType enum.

type FacilityServicesFacilityServiceTypeEnumFilter

type FacilityServicesFacilityServiceTypeEnumFilter struct {
	// Eq Search by type
	Eq *FacilityServicesFacilityServiceTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by type
	In *[]FacilityServicesFacilityServiceTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by type
	NotEq *FacilityServicesFacilityServiceTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

FacilityServicesFacilityServiceTypeEnumFilter FacilityServicesFacilityServiceTypeEnumFilter

type FacilityServicesFacilityServiceTypeEnumFilterEq

type FacilityServicesFacilityServiceTypeEnumFilterEq string

FacilityServicesFacilityServiceTypeEnumFilterEq Search by type

const (
	FacilityServicesFacilityServiceTypeEnumFilterEqPICKUP        FacilityServicesFacilityServiceTypeEnumFilterEq = "PICKUP"
	FacilityServicesFacilityServiceTypeEnumFilterEqSHIPFROMSTORE FacilityServicesFacilityServiceTypeEnumFilterEq = "SHIP_FROM_STORE"
)

Defines values for FacilityServicesFacilityServiceTypeEnumFilterEq.

func (FacilityServicesFacilityServiceTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the FacilityServicesFacilityServiceTypeEnumFilterEq enum.

type FacilityServicesFacilityServiceTypeEnumFilterIn

type FacilityServicesFacilityServiceTypeEnumFilterIn string

FacilityServicesFacilityServiceTypeEnumFilterIn defines model for FacilityServicesFacilityServiceTypeEnumFilter.In.

const (
	FacilityServicesFacilityServiceTypeEnumFilterInPICKUP        FacilityServicesFacilityServiceTypeEnumFilterIn = "PICKUP"
	FacilityServicesFacilityServiceTypeEnumFilterInSHIPFROMSTORE FacilityServicesFacilityServiceTypeEnumFilterIn = "SHIP_FROM_STORE"
)

Defines values for FacilityServicesFacilityServiceTypeEnumFilterIn.

func (FacilityServicesFacilityServiceTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the FacilityServicesFacilityServiceTypeEnumFilterIn enum.

type FacilityServicesFacilityServiceTypeEnumFilterNotEq

type FacilityServicesFacilityServiceTypeEnumFilterNotEq string

FacilityServicesFacilityServiceTypeEnumFilterNotEq Search by type

const (
	FacilityServicesFacilityServiceTypeEnumFilterNotEqPICKUP        FacilityServicesFacilityServiceTypeEnumFilterNotEq = "PICKUP"
	FacilityServicesFacilityServiceTypeEnumFilterNotEqSHIPFROMSTORE FacilityServicesFacilityServiceTypeEnumFilterNotEq = "SHIP_FROM_STORE"
)

Defines values for FacilityServicesFacilityServiceTypeEnumFilterNotEq.

func (FacilityServicesFacilityServiceTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the FacilityServicesFacilityServiceTypeEnumFilterNotEq enum.

type FacilityServicesFilter

type FacilityServicesFilter struct {
	// Type Search by type
	Type *FacilityServicesFacilityServiceTypeEnumFilter `json:"type,omitempty"`
}

FacilityServicesFilter FacilityServicesFilter

type FacilityServicesListFilter

type FacilityServicesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *FacilityServicesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

FacilityServicesListFilter FacilityServicesListFilter

type FacilityServicesSort

type FacilityServicesSort struct {
	Type *FacilityServicesSortType `json:"type,omitempty"`
}

FacilityServicesSort FacilityServicesSort

type FacilityServicesSortType

type FacilityServicesSortType string

FacilityServicesSortType defines model for FacilityServicesSort.Type.

const (
	FacilityServicesSortTypeASC  FacilityServicesSortType = "ASC"
	FacilityServicesSortTypeDESC FacilityServicesSortType = "DESC"
)

Defines values for FacilityServicesSortType.

func (FacilityServicesSortType) Valid

func (e FacilityServicesSortType) Valid() bool

Valid indicates whether the value is a known member of the FacilityServicesSortType enum.

type FacilitySort

type FacilitySort struct {
	// Address FacilityAddressSort
	Address          *FacilityAddressSort      `json:"address,omitempty"`
	CustomAttributes *map[string]interface{}   `json:"customAttributes,omitempty"`
	Id               *FacilitySortId           `json:"id,omitempty"`
	LastModified     *FacilitySortLastModified `json:"lastModified,omitempty"`
	LocationType     *FacilitySortLocationType `json:"locationType,omitempty"`
	Name             *FacilitySortName         `json:"name,omitempty"`

	// Services FacilityServicesSort
	Services         *FacilityServicesSort         `json:"services,omitempty"`
	Status           *FacilitySortStatus           `json:"status,omitempty"`
	TenantFacilityId *FacilitySortTenantFacilityId `json:"tenantFacilityId,omitempty"`
	Type             *FacilitySortType             `json:"type,omitempty"`
}

FacilitySort FacilitySort

type FacilitySortId

type FacilitySortId string

FacilitySortId defines model for FacilitySort.Id.

const (
	FacilitySortIdASC  FacilitySortId = "ASC"
	FacilitySortIdDESC FacilitySortId = "DESC"
)

Defines values for FacilitySortId.

func (FacilitySortId) Valid

func (e FacilitySortId) Valid() bool

Valid indicates whether the value is a known member of the FacilitySortId enum.

type FacilitySortLastModified

type FacilitySortLastModified string

FacilitySortLastModified defines model for FacilitySort.LastModified.

const (
	FacilitySortLastModifiedASC  FacilitySortLastModified = "ASC"
	FacilitySortLastModifiedDESC FacilitySortLastModified = "DESC"
)

Defines values for FacilitySortLastModified.

func (FacilitySortLastModified) Valid

func (e FacilitySortLastModified) Valid() bool

Valid indicates whether the value is a known member of the FacilitySortLastModified enum.

type FacilitySortLocationType

type FacilitySortLocationType string

FacilitySortLocationType defines model for FacilitySort.LocationType.

const (
	FacilitySortLocationTypeASC  FacilitySortLocationType = "ASC"
	FacilitySortLocationTypeDESC FacilitySortLocationType = "DESC"
)

Defines values for FacilitySortLocationType.

func (FacilitySortLocationType) Valid

func (e FacilitySortLocationType) Valid() bool

Valid indicates whether the value is a known member of the FacilitySortLocationType enum.

type FacilitySortName

type FacilitySortName string

FacilitySortName defines model for FacilitySort.Name.

const (
	FacilitySortNameASC  FacilitySortName = "ASC"
	FacilitySortNameDESC FacilitySortName = "DESC"
)

Defines values for FacilitySortName.

func (FacilitySortName) Valid

func (e FacilitySortName) Valid() bool

Valid indicates whether the value is a known member of the FacilitySortName enum.

type FacilitySortStatus

type FacilitySortStatus string

FacilitySortStatus defines model for FacilitySort.Status.

const (
	FacilitySortStatusASC  FacilitySortStatus = "ASC"
	FacilitySortStatusDESC FacilitySortStatus = "DESC"
)

Defines values for FacilitySortStatus.

func (FacilitySortStatus) Valid

func (e FacilitySortStatus) Valid() bool

Valid indicates whether the value is a known member of the FacilitySortStatus enum.

type FacilitySortTenantFacilityId

type FacilitySortTenantFacilityId string

FacilitySortTenantFacilityId defines model for FacilitySort.TenantFacilityId.

const (
	FacilitySortTenantFacilityIdASC  FacilitySortTenantFacilityId = "ASC"
	FacilitySortTenantFacilityIdDESC FacilitySortTenantFacilityId = "DESC"
)

Defines values for FacilitySortTenantFacilityId.

func (FacilitySortTenantFacilityId) Valid

Valid indicates whether the value is a known member of the FacilitySortTenantFacilityId enum.

type FacilitySortType

type FacilitySortType string

FacilitySortType defines model for FacilitySort.Type.

const (
	FacilitySortTypeASC  FacilitySortType = "ASC"
	FacilitySortTypeDESC FacilitySortType = "DESC"
)

Defines values for FacilitySortType.

func (FacilitySortType) Valid

func (e FacilitySortType) Valid() bool

Valid indicates whether the value is a known member of the FacilitySortType enum.

type FacilityStatus

type FacilityStatus string

FacilityStatus The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.

const (
	FacilityStatusOFFLINE   FacilityStatus = "OFFLINE"
	FacilityStatusONLINE    FacilityStatus = "ONLINE"
	FacilityStatusSUSPENDED FacilityStatus = "SUSPENDED"
)

Defines values for FacilityStatus.

func (FacilityStatus) Valid

func (e FacilityStatus) Valid() bool

Valid indicates whether the value is a known member of the FacilityStatus enum.

type FacilityStatusEnumFilter

type FacilityStatusEnumFilter struct {
	// Eq Search by status
	Eq *FacilityStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]FacilityStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *FacilityStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

FacilityStatusEnumFilter FacilityStatusEnumFilter

type FacilityStatusEnumFilterEq

type FacilityStatusEnumFilterEq string

FacilityStatusEnumFilterEq Search by status

const (
	FacilityStatusEnumFilterEqOFFLINE   FacilityStatusEnumFilterEq = "OFFLINE"
	FacilityStatusEnumFilterEqONLINE    FacilityStatusEnumFilterEq = "ONLINE"
	FacilityStatusEnumFilterEqSUSPENDED FacilityStatusEnumFilterEq = "SUSPENDED"
)

Defines values for FacilityStatusEnumFilterEq.

func (FacilityStatusEnumFilterEq) Valid

func (e FacilityStatusEnumFilterEq) Valid() bool

Valid indicates whether the value is a known member of the FacilityStatusEnumFilterEq enum.

type FacilityStatusEnumFilterIn

type FacilityStatusEnumFilterIn string

FacilityStatusEnumFilterIn defines model for FacilityStatusEnumFilter.In.

const (
	FacilityStatusEnumFilterInOFFLINE   FacilityStatusEnumFilterIn = "OFFLINE"
	FacilityStatusEnumFilterInONLINE    FacilityStatusEnumFilterIn = "ONLINE"
	FacilityStatusEnumFilterInSUSPENDED FacilityStatusEnumFilterIn = "SUSPENDED"
)

Defines values for FacilityStatusEnumFilterIn.

func (FacilityStatusEnumFilterIn) Valid

func (e FacilityStatusEnumFilterIn) Valid() bool

Valid indicates whether the value is a known member of the FacilityStatusEnumFilterIn enum.

type FacilityStatusEnumFilterNotEq

type FacilityStatusEnumFilterNotEq string

FacilityStatusEnumFilterNotEq Search by status

const (
	FacilityStatusEnumFilterNotEqOFFLINE   FacilityStatusEnumFilterNotEq = "OFFLINE"
	FacilityStatusEnumFilterNotEqONLINE    FacilityStatusEnumFilterNotEq = "ONLINE"
	FacilityStatusEnumFilterNotEqSUSPENDED FacilityStatusEnumFilterNotEq = "SUSPENDED"
)

Defines values for FacilityStatusEnumFilterNotEq.

func (FacilityStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the FacilityStatusEnumFilterNotEq enum.

type FacilityStockDistribution

type FacilityStockDistribution struct {
	// Available This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Available           float32 `json:"available"`
	AvailableForPicking float32 `json:"availableForPicking"`
	AvailableOnStock    float32 `json:"availableOnStock"`

	// AvailableToPromise This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AvailableToPromise float32 `json:"availableToPromise"`

	// ByTrait ByTrait
	ByTrait              ByTrait                     `json:"byTrait"`
	ChannelAdjusted      *[]ChannelStockAvailability `json:"channelAdjusted,omitempty"`
	FacilityId           string                      `json:"facilityId"`
	FacilityName         string                      `json:"facilityName"`
	FacilityServiceTypes *[]FacilityServiceType      `json:"facilityServiceTypes,omitempty"`

	// FacilityStatus The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	FacilityStatus *FacilityStatus `json:"facilityStatus,omitempty"`

	// Price Use listings attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Price *float32 `json:"price,omitempty"`

	// ReadyToPick This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ReadyToPick float32                      `json:"readyToPick"`
	Reserved    float32                      `json:"reserved"`
	SafetyStock float32                      `json:"safetyStock"`
	StockOnHand float32                      `json:"stockOnHand"`
	Thresholds  []StockAvailabilityThreshold `json:"thresholds"`
	TotalAmount float32                      `json:"totalAmount"`
}

FacilityStockDistribution FacilityStockDistribution

type FacilityTagsFilter

type FacilityTagsFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Value Search by value
	Value *StringFilter `json:"value,omitempty"`
}

FacilityTagsFilter FacilityTagsFilter

type FacilityTagsListFilter

type FacilityTagsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *FacilityTagsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

FacilityTagsListFilter FacilityTagsListFilter

type FacilityType

type FacilityType string

FacilityType FacilityType

const (
	FacilityTypeMANAGEDFACILITY FacilityType = "MANAGED_FACILITY"
	FacilityTypeSUPPLIER        FacilityType = "SUPPLIER"
)

Defines values for FacilityType.

func (FacilityType) Valid

func (e FacilityType) Valid() bool

Valid indicates whether the value is a known member of the FacilityType enum.

type FacilityTypeEnumFilter

type FacilityTypeEnumFilter struct {
	// Eq Search by type
	Eq *FacilityTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by type
	In *[]FacilityTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by type
	NotEq *FacilityTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

FacilityTypeEnumFilter FacilityTypeEnumFilter

type FacilityTypeEnumFilterEq

type FacilityTypeEnumFilterEq string

FacilityTypeEnumFilterEq Search by type

const (
	FacilityTypeEnumFilterEqMANAGEDFACILITY FacilityTypeEnumFilterEq = "MANAGED_FACILITY"
	FacilityTypeEnumFilterEqSUPPLIER        FacilityTypeEnumFilterEq = "SUPPLIER"
)

Defines values for FacilityTypeEnumFilterEq.

func (FacilityTypeEnumFilterEq) Valid

func (e FacilityTypeEnumFilterEq) Valid() bool

Valid indicates whether the value is a known member of the FacilityTypeEnumFilterEq enum.

type FacilityTypeEnumFilterIn

type FacilityTypeEnumFilterIn string

FacilityTypeEnumFilterIn defines model for FacilityTypeEnumFilter.In.

const (
	FacilityTypeEnumFilterInMANAGEDFACILITY FacilityTypeEnumFilterIn = "MANAGED_FACILITY"
	FacilityTypeEnumFilterInSUPPLIER        FacilityTypeEnumFilterIn = "SUPPLIER"
)

Defines values for FacilityTypeEnumFilterIn.

func (FacilityTypeEnumFilterIn) Valid

func (e FacilityTypeEnumFilterIn) Valid() bool

Valid indicates whether the value is a known member of the FacilityTypeEnumFilterIn enum.

type FacilityTypeEnumFilterNotEq

type FacilityTypeEnumFilterNotEq string

FacilityTypeEnumFilterNotEq Search by type

const (
	FacilityTypeEnumFilterNotEqMANAGEDFACILITY FacilityTypeEnumFilterNotEq = "MANAGED_FACILITY"
	FacilityTypeEnumFilterNotEqSUPPLIER        FacilityTypeEnumFilterNotEq = "SUPPLIER"
)

Defines values for FacilityTypeEnumFilterNotEq.

func (FacilityTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the FacilityTypeEnumFilterNotEq enum.

type FenceImplementation

type FenceImplementation string

FenceImplementation <i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview">API lifecycle documentation</a></i>

const (
	FenceImplementationAVOIDZEROSTOCK              FenceImplementation = "AVOID-ZERO-STOCK"
	FenceImplementationFACILITYBUSINESSTYPE        FenceImplementation = "FACILITY-BUSINESSTYPE"
	FenceImplementationFACILITYCARRIERAVAILABILITY FenceImplementation = "FACILITY-CARRIERAVAILABILITY"
	FenceImplementationFACILITYCOUNTRY             FenceImplementation = "FACILITY-COUNTRY"
	FenceImplementationFACILITYPICKINGTIMECAPACITY FenceImplementation = "FACILITY-PICKING-TIME-CAPACITY"
	FenceImplementationPACKAGINGPOSSIBLE           FenceImplementation = "PACKAGING-POSSIBLE"
	FenceImplementationPRESELECTEDFACILITY         FenceImplementation = "PRESELECTED-FACILITY"
	FenceImplementationSAMEDAYPOSSIBLE             FenceImplementation = "SAMEDAY-POSSIBLE"
	FenceImplementationSTOCKAVAILABILITY           FenceImplementation = "STOCK-AVAILABILITY"
)

Defines values for FenceImplementation.

func (FenceImplementation) Valid

func (e FenceImplementation) Valid() bool

Valid indicates whether the value is a known member of the FenceImplementation enum.

type FenceMode

type FenceMode string

FenceMode FenceMode

const (
	Reactive FenceMode = "reactive"
	Static   FenceMode = "static"
)

Defines values for FenceMode.

func (FenceMode) Valid

func (e FenceMode) Valid() bool

Valid indicates whether the value is a known member of the FenceMode enum.

type GetAllFacilitiesParams

type GetAllFacilitiesParams struct {
	// StartAfterId all entities after given Id
	StartAfterId *string `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// Status Reference to the status you want to get the corresponding facilities
	Status *[]string `form:"status,omitempty" json:"status,omitempty"`

	// Size number of facilities to show
	Size *int `form:"size,omitempty" json:"size,omitempty"`

	// TenantFacilityId query facilities with the given tenantFacilityId
	TenantFacilityId *string `form:"tenantFacilityId,omitempty" json:"tenantFacilityId,omitempty"`

	// OrderBy query facilities orderBy
	OrderBy *FacilityOrderBy `form:"orderBy,omitempty" json:"orderBy,omitempty"`

	// Type Filters the facilities by type
	Type *[]FacilityType `form:"type,omitempty" json:"type,omitempty"`
}

GetAllFacilitiesParams defines parameters for GetAllFacilities.

type GetAllFacilitiesResponse

type GetAllFacilitiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StrippedFacilities
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetAllFacilitiesResponse

func ParseGetAllFacilitiesResponse(rsp *http.Response) (*GetAllFacilitiesResponse, error)

ParseGetAllFacilitiesResponse parses an HTTP response from a GetAllFacilitiesWithResponse call

func (GetAllFacilitiesResponse) ContentType

func (r GetAllFacilitiesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetAllFacilitiesResponse) GetBody added in v0.8.0

func (r GetAllFacilitiesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAllFacilitiesResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAllFacilitiesResponse) GetJSON401 added in v0.8.0

func (r GetAllFacilitiesResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetAllFacilitiesResponse) GetJSON403 added in v0.8.0

func (r GetAllFacilitiesResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetAllFacilitiesResponse) Status

func (r GetAllFacilitiesResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllFacilitiesResponse) StatusCode

func (r GetAllFacilitiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllOrdersParams added in v0.3.0

type GetAllOrdersParams struct {
	// StartAfterId all entities after given Id
	StartAfterId *string `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// Size number of entities to show
	Size *int `form:"size,omitempty" json:"size,omitempty"`

	// TenantOrderId filter orders by tenantOrderId
	TenantOrderId *string `form:"tenantOrderId,omitempty" json:"tenantOrderId,omitempty"`

	// ConsumerId filter orders by consumerId
	ConsumerId *string `form:"consumerId,omitempty" json:"consumerId,omitempty"`
}

GetAllOrdersParams defines parameters for GetAllOrders.

type GetAllOrdersResponse added in v0.3.0

type GetAllOrdersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StrippedOrders
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetAllOrdersResponse added in v0.3.0

func ParseGetAllOrdersResponse(rsp *http.Response) (*GetAllOrdersResponse, error)

ParseGetAllOrdersResponse parses an HTTP response from a GetAllOrdersWithResponse call

func (GetAllOrdersResponse) ContentType added in v0.3.0

func (r GetAllOrdersResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetAllOrdersResponse) GetBody added in v0.8.0

func (r GetAllOrdersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAllOrdersResponse) GetJSON200 added in v0.8.0

func (r GetAllOrdersResponse) GetJSON200() *StrippedOrders

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAllOrdersResponse) GetJSON401 added in v0.8.0

func (r GetAllOrdersResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetAllOrdersResponse) GetJSON403 added in v0.8.0

func (r GetAllOrdersResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetAllOrdersResponse) Status added in v0.3.0

func (r GetAllOrdersResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllOrdersResponse) StatusCode added in v0.3.0

func (r GetAllOrdersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllRolesResponse

type GetAllRolesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]Role
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetAllRolesResponse

func ParseGetAllRolesResponse(rsp *http.Response) (*GetAllRolesResponse, error)

ParseGetAllRolesResponse parses an HTTP response from a GetAllRolesWithResponse call

func (GetAllRolesResponse) ContentType

func (r GetAllRolesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetAllRolesResponse) GetBody added in v0.8.0

func (r GetAllRolesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAllRolesResponse) GetJSON200 added in v0.8.0

func (r GetAllRolesResponse) GetJSON200() *[]Role

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAllRolesResponse) GetJSON401 added in v0.8.0

func (r GetAllRolesResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetAllRolesResponse) GetJSON403 added in v0.8.0

func (r GetAllRolesResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetAllRolesResponse) Status

func (r GetAllRolesResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllRolesResponse) StatusCode

func (r GetAllRolesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllUsersParams

type GetAllUsersParams struct {
	Size         *float32 `form:"size,omitempty" json:"size,omitempty"`
	StartAfterId *string  `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// OrderBy Order the users by this field
	OrderBy *string `form:"orderBy,omitempty" json:"orderBy,omitempty"`

	// FacilityId Filter the users by this facility
	FacilityId *string `form:"facilityId,omitempty" json:"facilityId,omitempty"`

	// IncludeAdminUsers Include all admins in the result (only applicable if facilityId is set)
	IncludeAdminUsers *bool `form:"includeAdminUsers,omitempty" json:"includeAdminUsers,omitempty"`
}

GetAllUsersParams defines parameters for GetAllUsers.

type GetAllUsersResponse

type GetAllUsersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *User
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetAllUsersResponse

func ParseGetAllUsersResponse(rsp *http.Response) (*GetAllUsersResponse, error)

ParseGetAllUsersResponse parses an HTTP response from a GetAllUsersWithResponse call

func (GetAllUsersResponse) ContentType

func (r GetAllUsersResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetAllUsersResponse) GetBody added in v0.8.0

func (r GetAllUsersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAllUsersResponse) GetJSON200 added in v0.8.0

func (r GetAllUsersResponse) GetJSON200() *User

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAllUsersResponse) GetJSON401 added in v0.8.0

func (r GetAllUsersResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetAllUsersResponse) GetJSON403 added in v0.8.0

func (r GetAllUsersResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetAllUsersResponse) GetJSON404 added in v0.8.0

func (r GetAllUsersResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetAllUsersResponse) Status

func (r GetAllUsersResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllUsersResponse) StatusCode

func (r GetAllUsersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetArticlesParams

type GetArticlesParams struct {
	Size            *float32         `form:"size,omitempty" json:"size,omitempty"`
	StartAfterId    *string          `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`
	FacilityRef     *string          `form:"facilityRef,omitempty" json:"facilityRef,omitempty"`
	SearchTerm      *string          `form:"searchTerm,omitempty" json:"searchTerm,omitempty"`
	Locale          *SupportedLocale `form:"locale,omitempty" json:"locale,omitempty"`
	TenantArticleId *string          `form:"tenantArticleId,omitempty" json:"tenantArticleId,omitempty"`
}

GetArticlesParams defines parameters for GetArticles.

type GetArticlesResponse

type GetArticlesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *InventoryArticlePaginatedResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetArticlesResponse

func ParseGetArticlesResponse(rsp *http.Response) (*GetArticlesResponse, error)

ParseGetArticlesResponse parses an HTTP response from a GetArticlesWithResponse call

func (GetArticlesResponse) ContentType

func (r GetArticlesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetArticlesResponse) GetBody added in v0.8.0

func (r GetArticlesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetArticlesResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetArticlesResponse) GetJSON401 added in v0.8.0

func (r GetArticlesResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetArticlesResponse) GetJSON403 added in v0.8.0

func (r GetArticlesResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetArticlesResponse) Status

func (r GetArticlesResponse) Status() string

Status returns HTTPResponse.Status

func (GetArticlesResponse) StatusCode

func (r GetArticlesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDiscountForFacilityResponse

type GetDiscountForFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FacilityDiscount
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetDiscountForFacilityResponse

func ParseGetDiscountForFacilityResponse(rsp *http.Response) (*GetDiscountForFacilityResponse, error)

ParseGetDiscountForFacilityResponse parses an HTTP response from a GetDiscountForFacilityWithResponse call

func (GetDiscountForFacilityResponse) ContentType

func (r GetDiscountForFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetDiscountForFacilityResponse) GetBody added in v0.8.0

func (r GetDiscountForFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetDiscountForFacilityResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetDiscountForFacilityResponse) GetJSON401 added in v0.8.0

func (r GetDiscountForFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetDiscountForFacilityResponse) GetJSON403 added in v0.8.0

func (r GetDiscountForFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetDiscountForFacilityResponse) GetJSON404 added in v0.8.0

func (r GetDiscountForFacilityResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetDiscountForFacilityResponse) Status

Status returns HTTPResponse.Status

func (GetDiscountForFacilityResponse) StatusCode

func (r GetDiscountForFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDiscountsForFacilityParams

type GetDiscountsForFacilityParams struct {
	// StartAfterId all entities after given Id
	StartAfterId *string `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// Size number of facilities to show
	Size *int `form:"size,omitempty" json:"size,omitempty"`
}

GetDiscountsForFacilityParams defines parameters for GetDiscountsForFacility.

type GetDiscountsForFacilityResponse

type GetDiscountsForFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *interface{}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetDiscountsForFacilityResponse

func ParseGetDiscountsForFacilityResponse(rsp *http.Response) (*GetDiscountsForFacilityResponse, error)

ParseGetDiscountsForFacilityResponse parses an HTTP response from a GetDiscountsForFacilityWithResponse call

func (GetDiscountsForFacilityResponse) ContentType

func (r GetDiscountsForFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetDiscountsForFacilityResponse) GetBody added in v0.8.0

func (r GetDiscountsForFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetDiscountsForFacilityResponse) GetJSON200 added in v0.8.0

func (r GetDiscountsForFacilityResponse) GetJSON200() *interface{}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetDiscountsForFacilityResponse) GetJSON401 added in v0.8.0

func (r GetDiscountsForFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetDiscountsForFacilityResponse) GetJSON403 added in v0.8.0

func (r GetDiscountsForFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetDiscountsForFacilityResponse) GetJSON404 added in v0.8.0

func (r GetDiscountsForFacilityResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetDiscountsForFacilityResponse) Status

Status returns HTTPResponse.Status

func (GetDiscountsForFacilityResponse) StatusCode

func (r GetDiscountsForFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEffectivePermissionsResponse

type GetEffectivePermissionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EffectivePermissionsResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
}

func ParseGetEffectivePermissionsResponse

func ParseGetEffectivePermissionsResponse(rsp *http.Response) (*GetEffectivePermissionsResponse, error)

ParseGetEffectivePermissionsResponse parses an HTTP response from a GetEffectivePermissionsWithResponse call

func (GetEffectivePermissionsResponse) ContentType

func (r GetEffectivePermissionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetEffectivePermissionsResponse) GetBody added in v0.8.0

func (r GetEffectivePermissionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetEffectivePermissionsResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetEffectivePermissionsResponse) GetJSON401 added in v0.8.0

func (r GetEffectivePermissionsResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetEffectivePermissionsResponse) Status

Status returns HTTPResponse.Status

func (GetEffectivePermissionsResponse) StatusCode

func (r GetEffectivePermissionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFacility200JSONResponseBody

type GetFacility200JSONResponseBody struct {
	// contains filtered or unexported fields
}

GetFacility200JSONResponseBody defines parameters for GetFacility.

func (GetFacility200JSONResponseBody) AsManagedFacility

func (t GetFacility200JSONResponseBody) AsManagedFacility() (ManagedFacility, error)

AsManagedFacility returns the union data inside the GetFacility200JSONResponseBody as a ManagedFacility

func (GetFacility200JSONResponseBody) AsSupplier

func (t GetFacility200JSONResponseBody) AsSupplier() (Supplier, error)

AsSupplier returns the union data inside the GetFacility200JSONResponseBody as a Supplier

func (*GetFacility200JSONResponseBody) FromManagedFacility

func (t *GetFacility200JSONResponseBody) FromManagedFacility(v ManagedFacility) error

FromManagedFacility overwrites any union data inside the GetFacility200JSONResponseBody as the provided ManagedFacility

func (*GetFacility200JSONResponseBody) FromSupplier

func (t *GetFacility200JSONResponseBody) FromSupplier(v Supplier) error

FromSupplier overwrites any union data inside the GetFacility200JSONResponseBody as the provided Supplier

func (GetFacility200JSONResponseBody) MarshalJSON

func (t GetFacility200JSONResponseBody) MarshalJSON() ([]byte, error)

func (*GetFacility200JSONResponseBody) MergeManagedFacility

func (t *GetFacility200JSONResponseBody) MergeManagedFacility(v ManagedFacility) error

MergeManagedFacility performs a merge with any union data inside the GetFacility200JSONResponseBody, using the provided ManagedFacility

func (*GetFacility200JSONResponseBody) MergeSupplier

func (t *GetFacility200JSONResponseBody) MergeSupplier(v Supplier) error

MergeSupplier performs a merge with any union data inside the GetFacility200JSONResponseBody, using the provided Supplier

func (*GetFacility200JSONResponseBody) UnmarshalJSON

func (t *GetFacility200JSONResponseBody) UnmarshalJSON(b []byte) error

type GetFacilityCarrierResponse

type GetFacilityCarrierResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FacilityCarrierConnection
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetFacilityCarrierResponse

func ParseGetFacilityCarrierResponse(rsp *http.Response) (*GetFacilityCarrierResponse, error)

ParseGetFacilityCarrierResponse parses an HTTP response from a GetFacilityCarrierWithResponse call

func (GetFacilityCarrierResponse) ContentType

func (r GetFacilityCarrierResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetFacilityCarrierResponse) GetBody added in v0.8.0

func (r GetFacilityCarrierResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFacilityCarrierResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFacilityCarrierResponse) GetJSON401 added in v0.8.0

func (r GetFacilityCarrierResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetFacilityCarrierResponse) GetJSON403 added in v0.8.0

func (r GetFacilityCarrierResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetFacilityCarrierResponse) GetJSON404 added in v0.8.0

func (r GetFacilityCarrierResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetFacilityCarrierResponse) Status

Status returns HTTPResponse.Status

func (GetFacilityCarrierResponse) StatusCode

func (r GetFacilityCarrierResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFacilityConnectionParams

type GetFacilityConnectionParams struct {
	// Locale Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.
	Locale *string `form:"locale,omitempty" json:"locale,omitempty"`
}

GetFacilityConnectionParams defines parameters for GetFacilityConnection.

type GetFacilityConnectionResponse

type GetFacilityConnectionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *InterFacilityConnection
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetFacilityConnectionResponse

func ParseGetFacilityConnectionResponse(rsp *http.Response) (*GetFacilityConnectionResponse, error)

ParseGetFacilityConnectionResponse parses an HTTP response from a GetFacilityConnectionWithResponse call

func (GetFacilityConnectionResponse) ContentType

func (r GetFacilityConnectionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetFacilityConnectionResponse) GetBody added in v0.8.0

func (r GetFacilityConnectionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFacilityConnectionResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFacilityConnectionResponse) GetJSON401 added in v0.8.0

func (r GetFacilityConnectionResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetFacilityConnectionResponse) GetJSON403 added in v0.8.0

func (r GetFacilityConnectionResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetFacilityConnectionResponse) GetJSON404 added in v0.8.0

func (r GetFacilityConnectionResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetFacilityConnectionResponse) Status

Status returns HTTPResponse.Status

func (GetFacilityConnectionResponse) StatusCode

func (r GetFacilityConnectionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFacilityConnectionsParams

type GetFacilityConnectionsParams struct {
	// TargetFacilityRef The targetFacilityRef of the connection
	TargetFacilityRef *string `form:"targetFacilityRef,omitempty" json:"targetFacilityRef,omitempty"`

	// StartAfterId all entities
	StartAfterId *string `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// Size number of entities to show
	Size *int `form:"size,omitempty" json:"size,omitempty"`

	// Locale Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.
	Locale *string `form:"locale,omitempty" json:"locale,omitempty"`
}

GetFacilityConnectionsParams defines parameters for GetFacilityConnections.

type GetFacilityConnectionsResponse

type GetFacilityConnectionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *InterFacilityConnections
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetFacilityConnectionsResponse

func ParseGetFacilityConnectionsResponse(rsp *http.Response) (*GetFacilityConnectionsResponse, error)

ParseGetFacilityConnectionsResponse parses an HTTP response from a GetFacilityConnectionsWithResponse call

func (GetFacilityConnectionsResponse) ContentType

func (r GetFacilityConnectionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetFacilityConnectionsResponse) GetBody added in v0.8.0

func (r GetFacilityConnectionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFacilityConnectionsResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFacilityConnectionsResponse) GetJSON401 added in v0.8.0

func (r GetFacilityConnectionsResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetFacilityConnectionsResponse) GetJSON403 added in v0.8.0

func (r GetFacilityConnectionsResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetFacilityConnectionsResponse) Status

Status returns HTTPResponse.Status

func (GetFacilityConnectionsResponse) StatusCode

func (r GetFacilityConnectionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFacilityListingParams

type GetFacilityListingParams struct {
	// StartAfterId all entities after given Id
	StartAfterId *string `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// Size number of facilities to show
	Size *int `form:"size,omitempty" json:"size,omitempty"`

	// TenantArticleIds Array of tenantArticleIds
	TenantArticleIds *[]string `form:"tenantArticleIds,omitempty" json:"tenantArticleIds,omitempty"`

	// ScannableCode limit results to this scannableCode
	ScannableCode *string `form:"scannableCode,omitempty" json:"scannableCode,omitempty"`
}

GetFacilityListingParams defines parameters for GetFacilityListing.

type GetFacilityListingPartialStockResponse

type GetFacilityListingPartialStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]PartialStock
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetFacilityListingPartialStockResponse

func ParseGetFacilityListingPartialStockResponse(rsp *http.Response) (*GetFacilityListingPartialStockResponse, error)

ParseGetFacilityListingPartialStockResponse parses an HTTP response from a GetFacilityListingPartialStockWithResponse call

func (GetFacilityListingPartialStockResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetFacilityListingPartialStockResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (GetFacilityListingPartialStockResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFacilityListingPartialStockResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetFacilityListingPartialStockResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetFacilityListingPartialStockResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetFacilityListingPartialStockResponse) Status

Status returns HTTPResponse.Status

func (GetFacilityListingPartialStockResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetFacilityListingResponse

type GetFacilityListingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StrippedListings
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetFacilityListingResponse

func ParseGetFacilityListingResponse(rsp *http.Response) (*GetFacilityListingResponse, error)

ParseGetFacilityListingResponse parses an HTTP response from a GetFacilityListingWithResponse call

func (GetFacilityListingResponse) ContentType

func (r GetFacilityListingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetFacilityListingResponse) GetBody added in v0.8.0

func (r GetFacilityListingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFacilityListingResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFacilityListingResponse) GetJSON401 added in v0.8.0

func (r GetFacilityListingResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetFacilityListingResponse) GetJSON403 added in v0.8.0

func (r GetFacilityListingResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetFacilityListingResponse) GetJSON404 added in v0.8.0

func (r GetFacilityListingResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetFacilityListingResponse) Status

Status returns HTTPResponse.Status

func (GetFacilityListingResponse) StatusCode

func (r GetFacilityListingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFacilityResponse

type GetFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetFacility200JSONResponseBody
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetFacilityResponse

func ParseGetFacilityResponse(rsp *http.Response) (*GetFacilityResponse, error)

ParseGetFacilityResponse parses an HTTP response from a GetFacilityWithResponse call

func (GetFacilityResponse) ContentType

func (r GetFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetFacilityResponse) GetBody added in v0.8.0

func (r GetFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFacilityResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFacilityResponse) GetJSON401 added in v0.8.0

func (r GetFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetFacilityResponse) GetJSON403 added in v0.8.0

func (r GetFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetFacilityResponse) GetJSON404 added in v0.8.0

func (r GetFacilityResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetFacilityResponse) Status

func (r GetFacilityResponse) Status() string

Status returns HTTPResponse.Status

func (GetFacilityResponse) StatusCode

func (r GetFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetForecastsForArticleParams

type GetForecastsForArticleParams struct {
	Period *GetForecastsForArticleParamsPeriod `form:"period,omitempty" json:"period,omitempty"`
}

GetForecastsForArticleParams defines parameters for GetForecastsForArticle.

type GetForecastsForArticleParamsPeriod

type GetForecastsForArticleParamsPeriod string

GetForecastsForArticleParamsPeriod defines parameters for GetForecastsForArticle.

const (
	GetForecastsForArticleParamsPeriodDAILY GetForecastsForArticleParamsPeriod = "DAILY"
)

Defines values for GetForecastsForArticleParamsPeriod.

func (GetForecastsForArticleParamsPeriod) Valid

Valid indicates whether the value is a known member of the GetForecastsForArticleParamsPeriod enum.

type GetForecastsForArticleResponse

type GetForecastsForArticleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ArticleStockForecast
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetForecastsForArticleResponse

func ParseGetForecastsForArticleResponse(rsp *http.Response) (*GetForecastsForArticleResponse, error)

ParseGetForecastsForArticleResponse parses an HTTP response from a GetForecastsForArticleWithResponse call

func (GetForecastsForArticleResponse) ContentType

func (r GetForecastsForArticleResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetForecastsForArticleResponse) GetBody added in v0.8.0

func (r GetForecastsForArticleResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetForecastsForArticleResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetForecastsForArticleResponse) GetJSON401 added in v0.8.0

func (r GetForecastsForArticleResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetForecastsForArticleResponse) GetJSON403 added in v0.8.0

func (r GetForecastsForArticleResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetForecastsForArticleResponse) GetJSON404 added in v0.8.0

func (r GetForecastsForArticleResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetForecastsForArticleResponse) Status

Status returns HTTPResponse.Status

func (GetForecastsForArticleResponse) StatusCode

func (r GetForecastsForArticleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetListingParams

type GetListingParams struct {
	// Locale Provide the localized names and descriptions for the listing. If not provided the default locale is used., for example de_DE.
	Locale *string `form:"locale,omitempty" json:"locale,omitempty"`
}

GetListingParams defines parameters for GetListing.

type GetListingResponse

type GetListingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Listing
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetListingResponse

func ParseGetListingResponse(rsp *http.Response) (*GetListingResponse, error)

ParseGetListingResponse parses an HTTP response from a GetListingWithResponse call

func (GetListingResponse) ContentType

func (r GetListingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetListingResponse) GetBody added in v0.8.0

func (r GetListingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetListingResponse) GetJSON200 added in v0.8.0

func (r GetListingResponse) GetJSON200() *Listing

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetListingResponse) GetJSON401 added in v0.8.0

func (r GetListingResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetListingResponse) GetJSON403 added in v0.8.0

func (r GetListingResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetListingResponse) GetJSON404 added in v0.8.0

func (r GetListingResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetListingResponse) Status

func (r GetListingResponse) Status() string

Status returns HTTPResponse.Status

func (GetListingResponse) StatusCode

func (r GetListingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderResponse added in v0.3.0

type GetOrderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Order
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetOrderResponse added in v0.3.0

func ParseGetOrderResponse(rsp *http.Response) (*GetOrderResponse, error)

ParseGetOrderResponse parses an HTTP response from a GetOrderWithResponse call

func (GetOrderResponse) ContentType added in v0.3.0

func (r GetOrderResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetOrderResponse) GetBody added in v0.8.0

func (r GetOrderResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOrderResponse) GetJSON200 added in v0.8.0

func (r GetOrderResponse) GetJSON200() *Order

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetOrderResponse) GetJSON401 added in v0.8.0

func (r GetOrderResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetOrderResponse) GetJSON403 added in v0.8.0

func (r GetOrderResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetOrderResponse) GetJSON404 added in v0.8.0

func (r GetOrderResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetOrderResponse) Status added in v0.3.0

func (r GetOrderResponse) Status() string

Status returns HTTPResponse.Status

func (GetOrderResponse) StatusCode added in v0.3.0

func (r GetOrderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPermissionsParams

type GetPermissionsParams struct {
	Size         *float32 `form:"size,omitempty" json:"size,omitempty"`
	StartAfterId *string  `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// Key The key of the permission to filter by
	Key *GetPermissionsParamsKey `form:"key,omitempty" json:"key,omitempty"`

	// Group The group of the permission to filter by
	Group *GetPermissionsParamsGroup `form:"group,omitempty" json:"group,omitempty"`
}

GetPermissionsParams defines parameters for GetPermissions.

type GetPermissionsParamsGroup

type GetPermissionsParamsGroup string

GetPermissionsParamsGroup defines parameters for GetPermissions.

const (
	GetPermissionsParamsGroupADMIN                GetPermissionsParamsGroup = "ADMIN"
	GetPermissionsParamsGroupCORE                 GetPermissionsParamsGroup = "CORE"
	GetPermissionsParamsGroupFOUNDATION           GetPermissionsParamsGroup = "FOUNDATION"
	GetPermissionsParamsGroupINVENTORY            GetPermissionsParamsGroup = "INVENTORY"
	GetPermissionsParamsGroupOPERATIONS           GetPermissionsParamsGroup = "OPERATIONS"
	GetPermissionsParamsGroupORDERMANAGEMENT      GetPermissionsParamsGroup = "ORDER_MANAGEMENT"
	GetPermissionsParamsGroupSYSTEMADMINISTRATION GetPermissionsParamsGroup = "SYSTEM_ADMINISTRATION"
	GetPermissionsParamsGroupUSERMANAGEMENT       GetPermissionsParamsGroup = "USER_MANAGEMENT"
)

Defines values for GetPermissionsParamsGroup.

func (GetPermissionsParamsGroup) Valid

func (e GetPermissionsParamsGroup) Valid() bool

Valid indicates whether the value is a known member of the GetPermissionsParamsGroup enum.

type GetPermissionsParamsKey

type GetPermissionsParamsKey string

GetPermissionsParamsKey defines parameters for GetPermissions.

const (
	GetPermissionsParamsKeyADMINDATARESET                        GetPermissionsParamsKey = "ADMIN_DATA_RESET"
	GetPermissionsParamsKeyADMININTERFACILITYCONNECTIONMIGRATION GetPermissionsParamsKey = "ADMIN_INTER_FACILITY_CONNECTION_MIGRATION"
	GetPermissionsParamsKeyADMINMODULESREAD                      GetPermissionsParamsKey = "ADMIN_MODULES_READ"
	GetPermissionsParamsKeyADMINMODULESWRITE                     GetPermissionsParamsKey = "ADMIN_MODULES_WRITE"
	GetPermissionsParamsKeyADMINROUTINGPLANANALYSIS              GetPermissionsParamsKey = "ADMIN_ROUTING_PLAN_ANALYSIS"
	GetPermissionsParamsKeyAIASSISTANTACCESS                     GetPermissionsParamsKey = "AI_ASSISTANT_ACCESS"
	GetPermissionsParamsKeyANALYTICSDASHBOARDREAD                GetPermissionsParamsKey = "ANALYTICS_DASHBOARD_READ"
	GetPermissionsParamsKeyAUDITREAD                             GetPermissionsParamsKey = "AUDIT_READ"
	GetPermissionsParamsKeyAVAILABILITYCHANNELREAD               GetPermissionsParamsKey = "AVAILABILITY_CHANNEL_READ"
	GetPermissionsParamsKeyAVAILABILITYCHANNELWRITE              GetPermissionsParamsKey = "AVAILABILITY_CHANNEL_WRITE"
	GetPermissionsParamsKeyAVAILABILITYTHRESHOLDSREAD            GetPermissionsParamsKey = "AVAILABILITY_THRESHOLDS_READ"
	GetPermissionsParamsKeyAVAILABILITYTHRESHOLDSWRITE           GetPermissionsParamsKey = "AVAILABILITY_THRESHOLDS_WRITE"
	GetPermissionsParamsKeyBRANDREAD                             GetPermissionsParamsKey = "BRAND_READ"
	GetPermissionsParamsKeyCARRIERREAD                           GetPermissionsParamsKey = "CARRIER_READ"
	GetPermissionsParamsKeyCARRIERWRITE                          GetPermissionsParamsKey = "CARRIER_WRITE"
	GetPermissionsParamsKeyCATEGORYREAD                          GetPermissionsParamsKey = "CATEGORY_READ"
	GetPermissionsParamsKeyCATEGORYWRITE                         GetPermissionsParamsKey = "CATEGORY_WRITE"
	GetPermissionsParamsKeyCONFIGREAD                            GetPermissionsParamsKey = "CONFIG_READ"
	GetPermissionsParamsKeyCONFIGWRITE                           GetPermissionsParamsKey = "CONFIG_WRITE"
	GetPermissionsParamsKeyCURRENTUSERMODIFY                     GetPermissionsParamsKey = "CURRENT_USER_MODIFY"
	GetPermissionsParamsKeyCURRENTUSERREAD                       GetPermissionsParamsKey = "CURRENT_USER_READ"
	GetPermissionsParamsKeyCUSTOMSERVICEREAD                     GetPermissionsParamsKey = "CUSTOM_SERVICE_READ"
	GetPermissionsParamsKeyCUSTOMSERVICEWRITE                    GetPermissionsParamsKey = "CUSTOM_SERVICE_WRITE"
	GetPermissionsParamsKeyDELIVERYNOTEWRITE                     GetPermissionsParamsKey = "DELIVERYNOTE_WRITE"
	GetPermissionsParamsKeyDOCUMENTSETREAD                       GetPermissionsParamsKey = "DOCUMENT_SET_READ"
	GetPermissionsParamsKeyDOCUMENTSETWRITE                      GetPermissionsParamsKey = "DOCUMENT_SET_WRITE"
	GetPermissionsParamsKeyDOMSSTATISTICSREAD                    GetPermissionsParamsKey = "DOMS_STATISTICS_READ"
	GetPermissionsParamsKeyDOMSTOOLKITREAD                       GetPermissionsParamsKey = "DOMS_TOOLKIT_READ"
	GetPermissionsParamsKeyDOMSTOOLKITWRITE                      GetPermissionsParamsKey = "DOMS_TOOLKIT_WRITE"
	GetPermissionsParamsKeyEVENTREAD                             GetPermissionsParamsKey = "EVENT_READ"
	GetPermissionsParamsKeyEXPIRIESREAD                          GetPermissionsParamsKey = "EXPIRIES_READ"
	GetPermissionsParamsKeyEXPIRIESWRITE                         GetPermissionsParamsKey = "EXPIRIES_WRITE"
	GetPermissionsParamsKeyEXPORTREAD                            GetPermissionsParamsKey = "EXPORT_READ"
	GetPermissionsParamsKeyEXPORTWRITE                           GetPermissionsParamsKey = "EXPORT_WRITE"
	GetPermissionsParamsKeyEXTERNALACTIONSREAD                   GetPermissionsParamsKey = "EXTERNAL_ACTIONS_READ"
	GetPermissionsParamsKeyEXTERNALACTIONSWRITE                  GetPermissionsParamsKey = "EXTERNAL_ACTIONS_WRITE"
	GetPermissionsParamsKeyEXTERNALSTOCKCHANGEREASONSREAD        GetPermissionsParamsKey = "EXTERNAL_STOCK_CHANGE_REASONS_READ"
	GetPermissionsParamsKeyEXTERNALSTOCKCHANGEREASONSWRITE       GetPermissionsParamsKey = "EXTERNAL_STOCK_CHANGE_REASONS_WRITE"
	GetPermissionsParamsKeyFACILITYCREATE                        GetPermissionsParamsKey = "FACILITY_CREATE"
	GetPermissionsParamsKeyFACILITYDELETE                        GetPermissionsParamsKey = "FACILITY_DELETE"
	GetPermissionsParamsKeyFACILITYGROUPREAD                     GetPermissionsParamsKey = "FACILITY_GROUP_READ"
	GetPermissionsParamsKeyFACILITYGROUPWRITE                    GetPermissionsParamsKey = "FACILITY_GROUP_WRITE"
	GetPermissionsParamsKeyFACILITYREAD                          GetPermissionsParamsKey = "FACILITY_READ"
	GetPermissionsParamsKeyFACILITYWRITE                         GetPermissionsParamsKey = "FACILITY_WRITE"
	GetPermissionsParamsKeyFILTERENTITYREAD                      GetPermissionsParamsKey = "FILTER_ENTITY_READ"
	GetPermissionsParamsKeyHANDOVERCONTAINERREAD                 GetPermissionsParamsKey = "HANDOVER_CONTAINER_READ"
	GetPermissionsParamsKeyHANDOVERCONTAINERWRITE                GetPermissionsParamsKey = "HANDOVER_CONTAINER_WRITE"
	GetPermissionsParamsKeyHANDOVERJOBREAD                       GetPermissionsParamsKey = "HANDOVERJOB_READ"
	GetPermissionsParamsKeyHANDOVERJOBWRITE                      GetPermissionsParamsKey = "HANDOVERJOB_WRITE"
	GetPermissionsParamsKeyINBOUNDPROCESSREAD                    GetPermissionsParamsKey = "INBOUND_PROCESS_READ"
	GetPermissionsParamsKeyINBOUNDPROCESSWRITE                   GetPermissionsParamsKey = "INBOUND_PROCESS_WRITE"
	GetPermissionsParamsKeyKPIREAD                               GetPermissionsParamsKey = "KPI_READ"
	GetPermissionsParamsKeyLINEITEMADD                           GetPermissionsParamsKey = "LINE_ITEM_ADD"
	GetPermissionsParamsKeyLINEITEMDELETE                        GetPermissionsParamsKey = "LINE_ITEM_DELETE"
	GetPermissionsParamsKeyLINEITEMPRICINGREAD                   GetPermissionsParamsKey = "LINE_ITEM_PRICING_READ"
	GetPermissionsParamsKeyLINEITEMQUANTITYDECREASE              GetPermissionsParamsKey = "LINE_ITEM_QUANTITY_DECREASE"
	GetPermissionsParamsKeyLINEITEMQUANTITYINCREASE              GetPermissionsParamsKey = "LINE_ITEM_QUANTITY_INCREASE"
	GetPermissionsParamsKeyLINKEDSERVICEJOBSREAD                 GetPermissionsParamsKey = "LINKED_SERVICE_JOBS_READ"
	GetPermissionsParamsKeyLINKEDSERVICEJOBSWRITE                GetPermissionsParamsKey = "LINKED_SERVICE_JOBS_WRITE"
	GetPermissionsParamsKeyLISTINGDELETE                         GetPermissionsParamsKey = "LISTING_DELETE"
	GetPermissionsParamsKeyLISTINGREAD                           GetPermissionsParamsKey = "LISTING_READ"
	GetPermissionsParamsKeyLISTINGWRITE                          GetPermissionsParamsKey = "LISTING_WRITE"
	GetPermissionsParamsKeyLOADUNITREAD                          GetPermissionsParamsKey = "LOADUNIT_READ"
	GetPermissionsParamsKeyLOADUNITTYPEREAD                      GetPermissionsParamsKey = "LOADUNITTYPE_READ"
	GetPermissionsParamsKeyLOADUNITTYPEWRITE                     GetPermissionsParamsKey = "LOADUNITTYPE_WRITE"
	GetPermissionsParamsKeyLOADUNITWRITE                         GetPermissionsParamsKey = "LOADUNIT_WRITE"
	GetPermissionsParamsKeyLOCALEWRITE                           GetPermissionsParamsKey = "LOCALE_WRITE"
	GetPermissionsParamsKeyLOOKUPRECORDREAD                      GetPermissionsParamsKey = "LOOKUP_RECORD_READ"
	GetPermissionsParamsKeyLOOKUPRECORDWRITE                     GetPermissionsParamsKey = "LOOKUP_RECORD_WRITE"
	GetPermissionsParamsKeyMEASUREMENTUNITREAD                   GetPermissionsParamsKey = "MEASUREMENTUNIT_READ"
	GetPermissionsParamsKeyMEASUREMENTUNITWRITE                  GetPermissionsParamsKey = "MEASUREMENTUNIT_WRITE"
	GetPermissionsParamsKeyNOTIFICATIONCENTERCONFIGREAD          GetPermissionsParamsKey = "NOTIFICATION_CENTER_CONFIG_READ"
	GetPermissionsParamsKeyNOTIFICATIONCENTERCONFIGWRITE         GetPermissionsParamsKey = "NOTIFICATION_CENTER_CONFIG_WRITE"
	GetPermissionsParamsKeyNOTIFICATIONREAD                      GetPermissionsParamsKey = "NOTIFICATION_READ"
	GetPermissionsParamsKeyNOTIFICATIONWRITE                     GetPermissionsParamsKey = "NOTIFICATION_WRITE"
	GetPermissionsParamsKeyOIDCPROVIDERSCONFIGREAD               GetPermissionsParamsKey = "OIDC_PROVIDERS_CONFIG_READ"
	GetPermissionsParamsKeyOIDCPROVIDERSCONFIGWRITE              GetPermissionsParamsKey = "OIDC_PROVIDERS_CONFIG_WRITE"
	GetPermissionsParamsKeyOPERATIONSTATISTICSREAD               GetPermissionsParamsKey = "OPERATION_STATISTICS_READ"
	GetPermissionsParamsKeyOPERATIVEPROCESSREAD                  GetPermissionsParamsKey = "OPERATIVE_PROCESS_READ"
	GetPermissionsParamsKeyOPERATIVEPROCESSWRITE                 GetPermissionsParamsKey = "OPERATIVE_PROCESS_WRITE"
	GetPermissionsParamsKeyORDERCANCEL                           GetPermissionsParamsKey = "ORDER_CANCEL"
	GetPermissionsParamsKeyORDERCONSUMERWRITE                    GetPermissionsParamsKey = "ORDER_CONSUMER_WRITE"
	GetPermissionsParamsKeyORDERCUSTOMATTRIBUTESWRITE            GetPermissionsParamsKey = "ORDER_CUSTOM_ATTRIBUTES_WRITE"
	GetPermissionsParamsKeyORDERDELIVERYPROMISEWRITE             GetPermissionsParamsKey = "ORDER_DELIVERY_PROMISE_WRITE"
	GetPermissionsParamsKeyORDERFORCECANCEL                      GetPermissionsParamsKey = "ORDER_FORCE_CANCEL"
	GetPermissionsParamsKeyORDERLINEITEMWRITE                    GetPermissionsParamsKey = "ORDER_LINEITEM_WRITE"
	GetPermissionsParamsKeyORDERREAD                             GetPermissionsParamsKey = "ORDER_READ"
	GetPermissionsParamsKeyORDERRECORDREAD                       GetPermissionsParamsKey = "ORDER_RECORD_READ"
	GetPermissionsParamsKeyORDERRECORDWRITE                      GetPermissionsParamsKey = "ORDER_RECORD_WRITE"
	GetPermissionsParamsKeyORDERTOTALREAD                        GetPermissionsParamsKey = "ORDER_TOTAL_READ"
	GetPermissionsParamsKeyORDERUNLOCK                           GetPermissionsParamsKey = "ORDER_UNLOCK"
	GetPermissionsParamsKeyORDERWRITE                            GetPermissionsParamsKey = "ORDER_WRITE"
	GetPermissionsParamsKeyPACKAGINGUNITSREAD                    GetPermissionsParamsKey = "PACKAGING_UNITS_READ"
	GetPermissionsParamsKeyPACKAGINGUNITSWRITE                   GetPermissionsParamsKey = "PACKAGING_UNITS_WRITE"
	GetPermissionsParamsKeyPACKINGCONTAINERTYPEWRITE             GetPermissionsParamsKey = "PACKINGCONTAINER_TYPE_WRITE"
	GetPermissionsParamsKeyPACKINGSOURCECONTAINERREAD            GetPermissionsParamsKey = "PACKING_SOURCE_CONTAINER_READ"
	GetPermissionsParamsKeyPACKINGSOURCECONTAINERWRITE           GetPermissionsParamsKey = "PACKING_SOURCE_CONTAINER_WRITE"
	GetPermissionsParamsKeyPACKJOBREAD                           GetPermissionsParamsKey = "PACKJOB_READ"
	GetPermissionsParamsKeyPACKJOBWRITE                          GetPermissionsParamsKey = "PACKJOB_WRITE"
	GetPermissionsParamsKeyPARCELREAD                            GetPermissionsParamsKey = "PARCEL_READ"
	GetPermissionsParamsKeyPARCELWRITE                           GetPermissionsParamsKey = "PARCEL_WRITE"
	GetPermissionsParamsKeyPERMISSIONREAD                        GetPermissionsParamsKey = "PERMISSION_READ"
	GetPermissionsParamsKeyPICKJOBREAD                           GetPermissionsParamsKey = "PICKJOB_READ"
	GetPermissionsParamsKeyPICKJOBREROUTE                        GetPermissionsParamsKey = "PICKJOB_REROUTE"
	GetPermissionsParamsKeyPICKJOBWRITE                          GetPermissionsParamsKey = "PICKJOB_WRITE"
	GetPermissionsParamsKeyPICKRUNREAD                           GetPermissionsParamsKey = "PICKRUN_READ"
	GetPermissionsParamsKeyPICKRUNWRITE                          GetPermissionsParamsKey = "PICKRUN_WRITE"
	GetPermissionsParamsKeyPICKUPSERVICEREAD                     GetPermissionsParamsKey = "PICKUP_SERVICE_READ"
	GetPermissionsParamsKeyPICKUPSERVICEWRITE                    GetPermissionsParamsKey = "PICKUP_SERVICE_WRITE"
	GetPermissionsParamsKeyPROCESSLOGREAD                        GetPermissionsParamsKey = "PROCESS_LOG_READ"
	GetPermissionsParamsKeyPROCESSREAD                           GetPermissionsParamsKey = "PROCESS_READ"
	GetPermissionsParamsKeyPROCESSREROUTE                        GetPermissionsParamsKey = "PROCESS_REROUTE"
	GetPermissionsParamsKeyPROCESSWRITE                          GetPermissionsParamsKey = "PROCESS_WRITE"
	GetPermissionsParamsKeyPROMISESCONFIGREAD                    GetPermissionsParamsKey = "PROMISES_CONFIG_READ"
	GetPermissionsParamsKeyPROMISESCONFIGWRITE                   GetPermissionsParamsKey = "PROMISES_CONFIG_WRITE"
	GetPermissionsParamsKeyPURCHASEPRICEREAD                     GetPermissionsParamsKey = "PURCHASE_PRICE_READ"
	GetPermissionsParamsKeyREMOTECONFIGREAD                      GetPermissionsParamsKey = "REMOTE_CONFIG_READ"
	GetPermissionsParamsKeyREMOTECONFIGWRITE                     GetPermissionsParamsKey = "REMOTE_CONFIG_WRITE"
	GetPermissionsParamsKeyRESERVATIONREAD                       GetPermissionsParamsKey = "RESERVATION_READ"
	GetPermissionsParamsKeyRESERVATIONWRITE                      GetPermissionsParamsKey = "RESERVATION_WRITE"
	GetPermissionsParamsKeyRESTOWITEMREAD                        GetPermissionsParamsKey = "RESTOW_ITEM_READ"
	GetPermissionsParamsKeyRESTOWITEMWRITE                       GetPermissionsParamsKey = "RESTOW_ITEM_WRITE"
	GetPermissionsParamsKeyRETURNREAD                            GetPermissionsParamsKey = "RETURN_READ"
	GetPermissionsParamsKeyRETURNWRITE                           GetPermissionsParamsKey = "RETURN_WRITE"
	GetPermissionsParamsKeyROLEREAD                              GetPermissionsParamsKey = "ROLE_READ"
	GetPermissionsParamsKeyROLEWRITE                             GetPermissionsParamsKey = "ROLE_WRITE"
	GetPermissionsParamsKeyROUTINGCONFIGREAD                     GetPermissionsParamsKey = "ROUTING_CONFIG_READ"
	GetPermissionsParamsKeyROUTINGCONFIGWRITE                    GetPermissionsParamsKey = "ROUTING_CONFIG_WRITE"
	GetPermissionsParamsKeyROUTINGREAD                           GetPermissionsParamsKey = "ROUTING_READ"
	GetPermissionsParamsKeyROUTINGWRITE                          GetPermissionsParamsKey = "ROUTING_WRITE"
	GetPermissionsParamsKeySAFETYSTOCKREAD                       GetPermissionsParamsKey = "SAFETY_STOCK_READ"
	GetPermissionsParamsKeySAFETYSTOCKWRITE                      GetPermissionsParamsKey = "SAFETY_STOCK_WRITE"
	GetPermissionsParamsKeySERVICEJOBREAD                        GetPermissionsParamsKey = "SERVICE_JOB_READ"
	GetPermissionsParamsKeySERVICEJOBWRITE                       GetPermissionsParamsKey = "SERVICE_JOB_WRITE"
	GetPermissionsParamsKeySHIPMENTREAD                          GetPermissionsParamsKey = "SHIPMENT_READ"
	GetPermissionsParamsKeySHIPMENTWRITE                         GetPermissionsParamsKey = "SHIPMENT_WRITE"
	GetPermissionsParamsKeySIMULATIONORDERREAD                   GetPermissionsParamsKey = "SIMULATION_ORDER_READ"
	GetPermissionsParamsKeySIMULATIONORDERWRITE                  GetPermissionsParamsKey = "SIMULATION_ORDER_WRITE"
	GetPermissionsParamsKeySTACKSREAD                            GetPermissionsParamsKey = "STACKS_READ"
	GetPermissionsParamsKeySTACKSWRITE                           GetPermissionsParamsKey = "STACKS_WRITE"
	GetPermissionsParamsKeySTOCKAVAILABILITIESREAD               GetPermissionsParamsKey = "STOCK_AVAILABILITIES_READ"
	GetPermissionsParamsKeySTOCKREAD                             GetPermissionsParamsKey = "STOCK_READ"
	GetPermissionsParamsKeySTOCKWRITE                            GetPermissionsParamsKey = "STOCK_WRITE"
	GetPermissionsParamsKeySTORAGELOCATIONREAD                   GetPermissionsParamsKey = "STORAGE_LOCATION_READ"
	GetPermissionsParamsKeySTORAGELOCATIONWRITE                  GetPermissionsParamsKey = "STORAGE_LOCATION_WRITE"
	GetPermissionsParamsKeySTOWJOBFULLWRITE                      GetPermissionsParamsKey = "STOW_JOB_FULL_WRITE"
	GetPermissionsParamsKeySTOWJOBOPERATIVEWRITE                 GetPermissionsParamsKey = "STOW_JOB_OPERATIVE_WRITE"
	GetPermissionsParamsKeySTOWJOBREAD                           GetPermissionsParamsKey = "STOW_JOB_READ"
	GetPermissionsParamsKeySUBSCRIPTIONREAD                      GetPermissionsParamsKey = "SUBSCRIPTION_READ"
	GetPermissionsParamsKeySUBSCRIPTIONWRITE                     GetPermissionsParamsKey = "SUBSCRIPTION_WRITE"
	GetPermissionsParamsKeySUBSTITUTEREAD                        GetPermissionsParamsKey = "SUBSTITUTE_READ"
	GetPermissionsParamsKeySUBSTITUTEWRITE                       GetPermissionsParamsKey = "SUBSTITUTE_WRITE"
	GetPermissionsParamsKeyTAGREAD                               GetPermissionsParamsKey = "TAG_READ"
	GetPermissionsParamsKeyTAGWRITE                              GetPermissionsParamsKey = "TAG_WRITE"
	GetPermissionsParamsKeyTENANTCONNECTORCONFIGREAD             GetPermissionsParamsKey = "TENANT_CONNECTOR_CONFIG_READ"
	GetPermissionsParamsKeyUSERMODIFY                            GetPermissionsParamsKey = "USER_MODIFY"
	GetPermissionsParamsKeyUSERREAD                              GetPermissionsParamsKey = "USER_READ"
	GetPermissionsParamsKeyUSERSREAD                             GetPermissionsParamsKey = "USERS_READ"
	GetPermissionsParamsKeyUSERWRITE                             GetPermissionsParamsKey = "USER_WRITE"
	GetPermissionsParamsKeyVALIDATIONSREAD                       GetPermissionsParamsKey = "VALIDATIONS_READ"
	GetPermissionsParamsKeyWORKFLOWDEFINITIONREAD                GetPermissionsParamsKey = "WORKFLOW_DEFINITION_READ"
	GetPermissionsParamsKeyWORKFLOWDEFINITIONWRITE               GetPermissionsParamsKey = "WORKFLOW_DEFINITION_WRITE"
	GetPermissionsParamsKeyZONEREAD                              GetPermissionsParamsKey = "ZONE_READ"
	GetPermissionsParamsKeyZONEWRITE                             GetPermissionsParamsKey = "ZONE_WRITE"
)

Defines values for GetPermissionsParamsKey.

func (GetPermissionsParamsKey) Valid

func (e GetPermissionsParamsKey) Valid() bool

Valid indicates whether the value is a known member of the GetPermissionsParamsKey enum.

type GetPermissionsResponse

type GetPermissionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PermissionsResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetPermissionsResponse

func ParseGetPermissionsResponse(rsp *http.Response) (*GetPermissionsResponse, error)

ParseGetPermissionsResponse parses an HTTP response from a GetPermissionsWithResponse call

func (GetPermissionsResponse) ContentType

func (r GetPermissionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetPermissionsResponse) GetBody added in v0.8.0

func (r GetPermissionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPermissionsResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetPermissionsResponse) GetJSON401 added in v0.8.0

func (r GetPermissionsResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetPermissionsResponse) GetJSON403 added in v0.8.0

func (r GetPermissionsResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetPermissionsResponse) Status

func (r GetPermissionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetPermissionsResponse) StatusCode

func (r GetPermissionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRoleResponse

type GetRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Role
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetRoleResponse

func ParseGetRoleResponse(rsp *http.Response) (*GetRoleResponse, error)

ParseGetRoleResponse parses an HTTP response from a GetRoleWithResponse call

func (GetRoleResponse) ContentType

func (r GetRoleResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetRoleResponse) GetBody added in v0.8.0

func (r GetRoleResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetRoleResponse) GetJSON200 added in v0.8.0

func (r GetRoleResponse) GetJSON200() *Role

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRoleResponse) GetJSON401 added in v0.8.0

func (r GetRoleResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRoleResponse) GetJSON403 added in v0.8.0

func (r GetRoleResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetRoleResponse) GetJSON404 added in v0.8.0

func (r GetRoleResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetRoleResponse) Status

func (r GetRoleResponse) Status() string

Status returns HTTPResponse.Status

func (GetRoleResponse) StatusCode

func (r GetRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRoutingDecisionLogsParams added in v0.6.0

type GetRoutingDecisionLogsParams struct {
	// SourcingOptionRef All decision logs for given sourcingOptionRef
	SourcingOptionRef *string `form:"sourcingOptionRef,omitempty" json:"sourcingOptionRef,omitempty"`

	// ProcessRef All decision logs for given processRef
	ProcessRef *string `form:"processRef,omitempty" json:"processRef,omitempty"`

	// OrderRef All decision logs for given orderRef
	OrderRef *string `form:"orderRef,omitempty" json:"orderRef,omitempty"`

	// RoutingPlanRef All decision logs for given routingPlanRef
	RoutingPlanRef *string `form:"routingPlanRef,omitempty" json:"routingPlanRef,omitempty"`

	// SourcingOptionsRef All decision logs for given sourcingOptionsRef
	SourcingOptionsRef *string `form:"sourcingOptionsRef,omitempty" json:"sourcingOptionsRef,omitempty"`

	// TenantOrderId All decision logs for given tenantOrderId
	TenantOrderId *string `form:"tenantOrderId,omitempty" json:"tenantOrderId,omitempty"`

	// StartAfterId All decision logs after given Id
	StartAfterId *string `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// Size Number of decision logs to show
	Size *int `form:"size,omitempty" json:"size,omitempty"`
}

GetRoutingDecisionLogsParams defines parameters for GetRoutingDecisionLogs.

type GetRoutingDecisionLogsResponse added in v0.6.0

type GetRoutingDecisionLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingDecisionLogs
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetRoutingDecisionLogsResponse added in v0.6.0

func ParseGetRoutingDecisionLogsResponse(rsp *http.Response) (*GetRoutingDecisionLogsResponse, error)

ParseGetRoutingDecisionLogsResponse parses an HTTP response from a GetRoutingDecisionLogsWithResponse call

func (GetRoutingDecisionLogsResponse) ContentType added in v0.6.0

func (r GetRoutingDecisionLogsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetRoutingDecisionLogsResponse) GetBody added in v0.8.0

func (r GetRoutingDecisionLogsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetRoutingDecisionLogsResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRoutingDecisionLogsResponse) GetJSON401 added in v0.8.0

func (r GetRoutingDecisionLogsResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRoutingDecisionLogsResponse) GetJSON403 added in v0.8.0

func (r GetRoutingDecisionLogsResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetRoutingDecisionLogsResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (GetRoutingDecisionLogsResponse) StatusCode added in v0.6.0

func (r GetRoutingDecisionLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRoutingStrategiesParams added in v0.6.0

type GetRoutingStrategiesParams struct {
	// StartAfterId All entities
	StartAfterId *string `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// Size Number of entities to show
	Size *int `form:"size,omitempty" json:"size,omitempty"`
}

GetRoutingStrategiesParams defines parameters for GetRoutingStrategies.

type GetRoutingStrategiesResponse added in v0.6.0

type GetRoutingStrategiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingStrategyTransporter
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetRoutingStrategiesResponse added in v0.6.0

func ParseGetRoutingStrategiesResponse(rsp *http.Response) (*GetRoutingStrategiesResponse, error)

ParseGetRoutingStrategiesResponse parses an HTTP response from a GetRoutingStrategiesWithResponse call

func (GetRoutingStrategiesResponse) ContentType added in v0.6.0

func (r GetRoutingStrategiesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetRoutingStrategiesResponse) GetBody added in v0.8.0

func (r GetRoutingStrategiesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetRoutingStrategiesResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRoutingStrategiesResponse) GetJSON401 added in v0.8.0

func (r GetRoutingStrategiesResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRoutingStrategiesResponse) GetJSON403 added in v0.8.0

func (r GetRoutingStrategiesResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetRoutingStrategiesResponse) GetJSON404 added in v0.8.0

func (r GetRoutingStrategiesResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetRoutingStrategiesResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (GetRoutingStrategiesResponse) StatusCode added in v0.6.0

func (r GetRoutingStrategiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRoutingStrategyNodeConfigCategoriesParams added in v0.6.0

type GetRoutingStrategyNodeConfigCategoriesParams struct {
	// StartAfterId All entities
	StartAfterId *string `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`

	// Size Number of entities to show
	Size *int `form:"size,omitempty" json:"size,omitempty"`
}

GetRoutingStrategyNodeConfigCategoriesParams defines parameters for GetRoutingStrategyNodeConfigCategories.

type GetRoutingStrategyNodeConfigCategoriesResponse added in v0.6.0

type GetRoutingStrategyNodeConfigCategoriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingStrategyNodeConfigCategoryTransporter
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetRoutingStrategyNodeConfigCategoriesResponse added in v0.6.0

func ParseGetRoutingStrategyNodeConfigCategoriesResponse(rsp *http.Response) (*GetRoutingStrategyNodeConfigCategoriesResponse, error)

ParseGetRoutingStrategyNodeConfigCategoriesResponse parses an HTTP response from a GetRoutingStrategyNodeConfigCategoriesWithResponse call

func (GetRoutingStrategyNodeConfigCategoriesResponse) ContentType added in v0.6.0

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetRoutingStrategyNodeConfigCategoriesResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (GetRoutingStrategyNodeConfigCategoriesResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRoutingStrategyNodeConfigCategoriesResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRoutingStrategyNodeConfigCategoriesResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetRoutingStrategyNodeConfigCategoriesResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetRoutingStrategyNodeConfigCategoriesResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (GetRoutingStrategyNodeConfigCategoriesResponse) StatusCode added in v0.6.0

StatusCode returns HTTPResponse.StatusCode

type GetRoutingStrategyNodeConfigCategoryResponse added in v0.6.0

type GetRoutingStrategyNodeConfigCategoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingStrategyNodeConfigCategoryForResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetRoutingStrategyNodeConfigCategoryResponse added in v0.6.0

func ParseGetRoutingStrategyNodeConfigCategoryResponse(rsp *http.Response) (*GetRoutingStrategyNodeConfigCategoryResponse, error)

ParseGetRoutingStrategyNodeConfigCategoryResponse parses an HTTP response from a GetRoutingStrategyNodeConfigCategoryWithResponse call

func (GetRoutingStrategyNodeConfigCategoryResponse) ContentType added in v0.6.0

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetRoutingStrategyNodeConfigCategoryResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (GetRoutingStrategyNodeConfigCategoryResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRoutingStrategyNodeConfigCategoryResponse) GetJSON400 added in v0.8.0

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetRoutingStrategyNodeConfigCategoryResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRoutingStrategyNodeConfigCategoryResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetRoutingStrategyNodeConfigCategoryResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (GetRoutingStrategyNodeConfigCategoryResponse) StatusCode added in v0.6.0

StatusCode returns HTTPResponse.StatusCode

type GetRoutingStrategyResponse added in v0.6.0

type GetRoutingStrategyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingStrategy
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetRoutingStrategyResponse added in v0.6.0

func ParseGetRoutingStrategyResponse(rsp *http.Response) (*GetRoutingStrategyResponse, error)

ParseGetRoutingStrategyResponse parses an HTTP response from a GetRoutingStrategyWithResponse call

func (GetRoutingStrategyResponse) ContentType added in v0.6.0

func (r GetRoutingStrategyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetRoutingStrategyResponse) GetBody added in v0.8.0

func (r GetRoutingStrategyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetRoutingStrategyResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRoutingStrategyResponse) GetJSON400 added in v0.8.0

func (r GetRoutingStrategyResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetRoutingStrategyResponse) GetJSON401 added in v0.8.0

func (r GetRoutingStrategyResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRoutingStrategyResponse) GetJSON403 added in v0.8.0

func (r GetRoutingStrategyResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetRoutingStrategyResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (GetRoutingStrategyResponse) StatusCode added in v0.6.0

func (r GetRoutingStrategyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSafetyStocksParams

type GetSafetyStocksParams struct {
	Size            *float32 `form:"size,omitempty" json:"size,omitempty"`
	StartAfterId    *string  `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`
	TenantArticleId *string  `form:"tenantArticleId,omitempty" json:"tenantArticleId,omitempty"`
	FacilityRef     *string  `form:"facilityRef,omitempty" json:"facilityRef,omitempty"`
}

GetSafetyStocksParams defines parameters for GetSafetyStocks.

type GetSafetyStocksResponse

type GetSafetyStocksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SafetyStocksPaginatedResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetSafetyStocksResponse

func ParseGetSafetyStocksResponse(rsp *http.Response) (*GetSafetyStocksResponse, error)

ParseGetSafetyStocksResponse parses an HTTP response from a GetSafetyStocksWithResponse call

func (GetSafetyStocksResponse) ContentType

func (r GetSafetyStocksResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetSafetyStocksResponse) GetBody added in v0.8.0

func (r GetSafetyStocksResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSafetyStocksResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSafetyStocksResponse) GetJSON401 added in v0.8.0

func (r GetSafetyStocksResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetSafetyStocksResponse) GetJSON403 added in v0.8.0

func (r GetSafetyStocksResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetSafetyStocksResponse) Status

func (r GetSafetyStocksResponse) Status() string

Status returns HTTPResponse.Status

func (GetSafetyStocksResponse) StatusCode

func (r GetSafetyStocksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSourcingOptionResponse added in v0.2.0

type GetSourcingOptionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SourcingOptionsResponse
	// XML200 the response for an HTTP 200 `application/xml` response
	XML200 *SourcingOptionsResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetSourcingOptionResponse added in v0.2.0

func ParseGetSourcingOptionResponse(rsp *http.Response) (*GetSourcingOptionResponse, error)

ParseGetSourcingOptionResponse parses an HTTP response from a GetSourcingOptionWithResponse call

func (GetSourcingOptionResponse) ContentType added in v0.2.0

func (r GetSourcingOptionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetSourcingOptionResponse) GetBody added in v0.8.0

func (r GetSourcingOptionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSourcingOptionResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSourcingOptionResponse) GetJSON401 added in v0.8.0

func (r GetSourcingOptionResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetSourcingOptionResponse) GetJSON403 added in v0.8.0

func (r GetSourcingOptionResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetSourcingOptionResponse) GetXML200 added in v0.8.0

GetXML200 returns the response for an HTTP 200 `application/xml` response

func (GetSourcingOptionResponse) Status added in v0.2.0

func (r GetSourcingOptionResponse) Status() string

Status returns HTTPResponse.Status

func (GetSourcingOptionResponse) StatusCode added in v0.2.0

func (r GetSourcingOptionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStockDistributionParams

type GetStockDistributionParams struct {
	FacilityServiceTypes *[]GetStockDistributionParamsFacilityServiceTypes `form:"facilityServiceTypes,omitempty" json:"facilityServiceTypes,omitempty"`
	FacilityStatus       *[]GetStockDistributionParamsFacilityStatus       `form:"facilityStatus,omitempty" json:"facilityStatus,omitempty"`
	FacilityName         *string                                           `form:"facilityName,omitempty" json:"facilityName,omitempty"`
	FacilityIds          *[]string                                         `form:"facilityIds,omitempty" json:"facilityIds,omitempty"`
	FacilityGroupRefs    *[]string                                         `form:"facilityGroupRefs,omitempty" json:"facilityGroupRefs,omitempty"`

	// ChannelRefs The channels to included under "channelAdjusted" in each summary and facility stock. Provide up to 50 channelRefs, specify "UNALLOCATED for unallocated stock."
	ChannelRefs *[]string `form:"channelRefs,omitempty" json:"channelRefs,omitempty"`

	// IncludeThresholds Additionaly calculate the current thresholds for each facilityStock entry
	IncludeThresholds *bool `form:"includeThresholds,omitempty" json:"includeThresholds,omitempty"`
}

GetStockDistributionParams defines parameters for GetStockDistribution.

type GetStockDistributionParamsFacilityServiceTypes

type GetStockDistributionParamsFacilityServiceTypes string

GetStockDistributionParamsFacilityServiceTypes defines parameters for GetStockDistribution.

const (
	GetStockDistributionParamsFacilityServiceTypesPICKUP        GetStockDistributionParamsFacilityServiceTypes = "PICKUP"
	GetStockDistributionParamsFacilityServiceTypesSHIPFROMSTORE GetStockDistributionParamsFacilityServiceTypes = "SHIP_FROM_STORE"
)

Defines values for GetStockDistributionParamsFacilityServiceTypes.

func (GetStockDistributionParamsFacilityServiceTypes) Valid

Valid indicates whether the value is a known member of the GetStockDistributionParamsFacilityServiceTypes enum.

type GetStockDistributionParamsFacilityStatus

type GetStockDistributionParamsFacilityStatus string

GetStockDistributionParamsFacilityStatus defines parameters for GetStockDistribution.

const (
	GetStockDistributionParamsFacilityStatusOFFLINE   GetStockDistributionParamsFacilityStatus = "OFFLINE"
	GetStockDistributionParamsFacilityStatusONLINE    GetStockDistributionParamsFacilityStatus = "ONLINE"
	GetStockDistributionParamsFacilityStatusSUSPENDED GetStockDistributionParamsFacilityStatus = "SUSPENDED"
)

Defines values for GetStockDistributionParamsFacilityStatus.

func (GetStockDistributionParamsFacilityStatus) Valid

Valid indicates whether the value is a known member of the GetStockDistributionParamsFacilityStatus enum.

type GetStockDistributionResponse

type GetStockDistributionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StockDistribution
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetStockDistributionResponse

func ParseGetStockDistributionResponse(rsp *http.Response) (*GetStockDistributionResponse, error)

ParseGetStockDistributionResponse parses an HTTP response from a GetStockDistributionWithResponse call

func (GetStockDistributionResponse) ContentType

func (r GetStockDistributionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetStockDistributionResponse) GetBody added in v0.8.0

func (r GetStockDistributionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetStockDistributionResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetStockDistributionResponse) GetJSON401 added in v0.8.0

func (r GetStockDistributionResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetStockDistributionResponse) GetJSON403 added in v0.8.0

func (r GetStockDistributionResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetStockDistributionResponse) Status

Status returns HTTPResponse.Status

func (GetStockDistributionResponse) StatusCode

func (r GetStockDistributionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStockResponse

type GetStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Stock
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetStockResponse

func ParseGetStockResponse(rsp *http.Response) (*GetStockResponse, error)

ParseGetStockResponse parses an HTTP response from a GetStockWithResponse call

func (GetStockResponse) ContentType

func (r GetStockResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetStockResponse) GetBody added in v0.8.0

func (r GetStockResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetStockResponse) GetJSON200 added in v0.8.0

func (r GetStockResponse) GetJSON200() *Stock

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetStockResponse) GetJSON401 added in v0.8.0

func (r GetStockResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetStockResponse) GetJSON403 added in v0.8.0

func (r GetStockResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetStockResponse) Status

func (r GetStockResponse) Status() string

Status returns HTTPResponse.Status

func (GetStockResponse) StatusCode

func (r GetStockResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStockSummariesParams

type GetStockSummariesParams struct {
	Size *float32 `form:"size,omitempty" json:"size,omitempty"`

	// StartAfterId The stockSummaries.article.tenantArticleId value should be used for pagination.
	StartAfterId         *string                                        `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`
	FacilityGroupRefs    *[]string                                      `form:"facilityGroupRefs,omitempty" json:"facilityGroupRefs,omitempty"`
	FacilityServiceTypes *[]GetStockSummariesParamsFacilityServiceTypes `form:"facilityServiceTypes,omitempty" json:"facilityServiceTypes,omitempty"`
	FacilityStatus       *[]GetStockSummariesParamsFacilityStatus       `form:"facilityStatus,omitempty" json:"facilityStatus,omitempty"`
	FacilityRefs         *[]string                                      `form:"facilityRefs,omitempty" json:"facilityRefs,omitempty"`
	AllowStale           *bool                                          `form:"allowStale,omitempty" json:"allowStale,omitempty"`
	TenantArticleIds     *[]string                                      `form:"tenantArticleIds,omitempty" json:"tenantArticleIds,omitempty"`

	// MaxPageSize Returns stock summaries using adaptive batching to reduce latency spikes, as a consequence response time will have a more consistent upper bound but page size may be reduced below the maximum - This overrides `size` argument.
	MaxPageSize *float32 `form:"maxPageSize,omitempty" json:"maxPageSize,omitempty"`

	// ChannelRefs The channels to included under "channelAdjusted" in the stock summary. Provide up to 50 channelRefs, specify "UNALLOCATED for unallocated stock."
	ChannelRefs *[]string `form:"channelRefs,omitempty" json:"channelRefs,omitempty"`
}

GetStockSummariesParams defines parameters for GetStockSummaries.

type GetStockSummariesParamsFacilityServiceTypes

type GetStockSummariesParamsFacilityServiceTypes string

GetStockSummariesParamsFacilityServiceTypes defines parameters for GetStockSummaries.

const (
	GetStockSummariesParamsFacilityServiceTypesPICKUP        GetStockSummariesParamsFacilityServiceTypes = "PICKUP"
	GetStockSummariesParamsFacilityServiceTypesSHIPFROMSTORE GetStockSummariesParamsFacilityServiceTypes = "SHIP_FROM_STORE"
)

Defines values for GetStockSummariesParamsFacilityServiceTypes.

func (GetStockSummariesParamsFacilityServiceTypes) Valid

Valid indicates whether the value is a known member of the GetStockSummariesParamsFacilityServiceTypes enum.

type GetStockSummariesParamsFacilityStatus

type GetStockSummariesParamsFacilityStatus string

GetStockSummariesParamsFacilityStatus defines parameters for GetStockSummaries.

const (
	GetStockSummariesParamsFacilityStatusOFFLINE   GetStockSummariesParamsFacilityStatus = "OFFLINE"
	GetStockSummariesParamsFacilityStatusONLINE    GetStockSummariesParamsFacilityStatus = "ONLINE"
	GetStockSummariesParamsFacilityStatusSUSPENDED GetStockSummariesParamsFacilityStatus = "SUSPENDED"
)

Defines values for GetStockSummariesParamsFacilityStatus.

func (GetStockSummariesParamsFacilityStatus) Valid

Valid indicates whether the value is a known member of the GetStockSummariesParamsFacilityStatus enum.

type GetStockSummariesResponse

type GetStockSummariesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StockSummaries
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetStockSummariesResponse

func ParseGetStockSummariesResponse(rsp *http.Response) (*GetStockSummariesResponse, error)

ParseGetStockSummariesResponse parses an HTTP response from a GetStockSummariesWithResponse call

func (GetStockSummariesResponse) ContentType

func (r GetStockSummariesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetStockSummariesResponse) GetBody added in v0.8.0

func (r GetStockSummariesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetStockSummariesResponse) GetJSON200 added in v0.8.0

func (r GetStockSummariesResponse) GetJSON200() *StockSummaries

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetStockSummariesResponse) GetJSON401 added in v0.8.0

func (r GetStockSummariesResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetStockSummariesResponse) GetJSON403 added in v0.8.0

func (r GetStockSummariesResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetStockSummariesResponse) Status

func (r GetStockSummariesResponse) Status() string

Status returns HTTPResponse.Status

func (GetStockSummariesResponse) StatusCode

func (r GetStockSummariesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStocksParams

type GetStocksParams struct {
	FacilityRef      *string   `form:"facilityRef,omitempty" json:"facilityRef,omitempty"`
	TenantFacilityId *string   `form:"tenantFacilityId,omitempty" json:"tenantFacilityId,omitempty"`
	TenantArticleId  *[]string `form:"tenantArticleId,omitempty" json:"tenantArticleId,omitempty"`
	LocationRef      *[]string `form:"locationRef,omitempty" json:"locationRef,omitempty"`
	Size             *float32  `form:"size,omitempty" json:"size,omitempty"`
	StartAfterId     *string   `form:"startAfterId,omitempty" json:"startAfterId,omitempty"`
}

GetStocksParams defines parameters for GetStocks.

type GetStocksResponse

type GetStocksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StockPaginatedResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseGetStocksResponse

func ParseGetStocksResponse(rsp *http.Response) (*GetStocksResponse, error)

ParseGetStocksResponse parses an HTTP response from a GetStocksWithResponse call

func (GetStocksResponse) ContentType

func (r GetStocksResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetStocksResponse) GetBody added in v0.8.0

func (r GetStocksResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetStocksResponse) GetJSON200 added in v0.8.0

func (r GetStocksResponse) GetJSON200() *StockPaginatedResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetStocksResponse) GetJSON401 added in v0.8.0

func (r GetStocksResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetStocksResponse) GetJSON403 added in v0.8.0

func (r GetStocksResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetStocksResponse) Status

func (r GetStocksResponse) Status() string

Status returns HTTPResponse.Status

func (GetStocksResponse) StatusCode

func (r GetStocksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUserResponse

type GetUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *User
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetUserResponse

func ParseGetUserResponse(rsp *http.Response) (*GetUserResponse, error)

ParseGetUserResponse parses an HTTP response from a GetUserWithResponse call

func (GetUserResponse) ContentType

func (r GetUserResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetUserResponse) GetBody added in v0.8.0

func (r GetUserResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetUserResponse) GetJSON200 added in v0.8.0

func (r GetUserResponse) GetJSON200() *User

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetUserResponse) GetJSON401 added in v0.8.0

func (r GetUserResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetUserResponse) GetJSON403 added in v0.8.0

func (r GetUserResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetUserResponse) GetJSON404 added in v0.8.0

func (r GetUserResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetUserResponse) Status

func (r GetUserResponse) Status() string

Status returns HTTPResponse.Status

func (GetUserResponse) StatusCode

func (r GetUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUserRolesResponse

type GetUserRolesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseGetUserRolesResponse

func ParseGetUserRolesResponse(rsp *http.Response) (*GetUserRolesResponse, error)

ParseGetUserRolesResponse parses an HTTP response from a GetUserRolesWithResponse call

func (GetUserRolesResponse) ContentType

func (r GetUserRolesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetUserRolesResponse) GetBody added in v0.8.0

func (r GetUserRolesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetUserRolesResponse) GetJSON401 added in v0.8.0

func (r GetUserRolesResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetUserRolesResponse) GetJSON403 added in v0.8.0

func (r GetUserRolesResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetUserRolesResponse) GetJSON404 added in v0.8.0

func (r GetUserRolesResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetUserRolesResponse) Status

func (r GetUserRolesResponse) Status() string

Status returns HTTPResponse.Status

func (GetUserRolesResponse) StatusCode

func (r GetUserRolesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HandledItem added in v0.2.0

type HandledItem struct {
	Quantity        float32 `json:"quantity"`
	TenantArticleId string  `json:"tenantArticleId"`
}

HandledItem HandledItem

type HandoverJobAdditionalHandoverJobLineItemsArticleFilter added in v0.8.0

type HandoverJobAdditionalHandoverJobLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringSearchFilter `json:"tenantArticleId,omitempty"`

	// Title Search by title
	Title *StringSearchFilter `json:"title,omitempty"`
}

HandoverJobAdditionalHandoverJobLineItemsArticleFilter HandoverJobAdditionalHandoverJobLineItemsArticleFilter

type HandoverJobAdditionalHandoverJobLineItemsFilter added in v0.8.0

type HandoverJobAdditionalHandoverJobLineItemsFilter struct {
	// Article Nested search by article
	Article *HandoverJobAdditionalHandoverJobLineItemsArticleFilter `json:"article,omitempty"`

	// ScannableCodes Search by scannableCodes
	ScannableCodes *StringListFilter `json:"scannableCodes,omitempty"`
}

HandoverJobAdditionalHandoverJobLineItemsFilter HandoverJobAdditionalHandoverJobLineItemsFilter

type HandoverJobAdditionalHandoverJobLineItemsListFilter added in v0.8.0

type HandoverJobAdditionalHandoverJobLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *HandoverJobAdditionalHandoverJobLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

HandoverJobAdditionalHandoverJobLineItemsListFilter HandoverJobAdditionalHandoverJobLineItemsListFilter

type HandoverJobAssignedUsersFilter

type HandoverJobAssignedUsersFilter struct {
	// UserId Search by userId
	UserId *StringFilter `json:"userId,omitempty"`

	// Username Search by username
	Username *StringSearchFilter `json:"username,omitempty"`
}

HandoverJobAssignedUsersFilter HandoverJobAssignedUsersFilter

type HandoverJobAssignedUsersListFilter

type HandoverJobAssignedUsersListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *HandoverJobAssignedUsersFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

HandoverJobAssignedUsersListFilter HandoverJobAssignedUsersListFilter

type HandoverJobChannelEnumEnumFilter

type HandoverJobChannelEnumEnumFilter struct {
	// Eq Search by channel
	Eq *HandoverJobChannelEnumEnumFilterEq `json:"eq,omitempty"`

	// In Search by channel
	In *[]HandoverJobChannelEnumEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by channel
	NotEq *HandoverJobChannelEnumEnumFilterNotEq `json:"notEq,omitempty"`
}

HandoverJobChannelEnumEnumFilter HandoverJobChannelEnumEnumFilter

type HandoverJobChannelEnumEnumFilterEq

type HandoverJobChannelEnumEnumFilterEq string

HandoverJobChannelEnumEnumFilterEq Search by channel

const (
	HandoverJobChannelEnumEnumFilterEqCOLLECT  HandoverJobChannelEnumEnumFilterEq = "COLLECT"
	HandoverJobChannelEnumEnumFilterEqDELIVERY HandoverJobChannelEnumEnumFilterEq = "DELIVERY"
)

Defines values for HandoverJobChannelEnumEnumFilterEq.

func (HandoverJobChannelEnumEnumFilterEq) Valid

Valid indicates whether the value is a known member of the HandoverJobChannelEnumEnumFilterEq enum.

type HandoverJobChannelEnumEnumFilterIn

type HandoverJobChannelEnumEnumFilterIn string

HandoverJobChannelEnumEnumFilterIn defines model for HandoverJobChannelEnumEnumFilter.In.

const (
	HandoverJobChannelEnumEnumFilterInCOLLECT  HandoverJobChannelEnumEnumFilterIn = "COLLECT"
	HandoverJobChannelEnumEnumFilterInDELIVERY HandoverJobChannelEnumEnumFilterIn = "DELIVERY"
)

Defines values for HandoverJobChannelEnumEnumFilterIn.

func (HandoverJobChannelEnumEnumFilterIn) Valid

Valid indicates whether the value is a known member of the HandoverJobChannelEnumEnumFilterIn enum.

type HandoverJobChannelEnumEnumFilterNotEq

type HandoverJobChannelEnumEnumFilterNotEq string

HandoverJobChannelEnumEnumFilterNotEq Search by channel

const (
	HandoverJobChannelEnumEnumFilterNotEqCOLLECT  HandoverJobChannelEnumEnumFilterNotEq = "COLLECT"
	HandoverJobChannelEnumEnumFilterNotEqDELIVERY HandoverJobChannelEnumEnumFilterNotEq = "DELIVERY"
)

Defines values for HandoverJobChannelEnumEnumFilterNotEq.

func (HandoverJobChannelEnumEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the HandoverJobChannelEnumEnumFilterNotEq enum.

type HandoverJobHandoverJobLineItemsArticleFilter

type HandoverJobHandoverJobLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringSearchFilter `json:"tenantArticleId,omitempty"`

	// Title Search by title
	Title *StringSearchFilter `json:"title,omitempty"`
}

HandoverJobHandoverJobLineItemsArticleFilter HandoverJobHandoverJobLineItemsArticleFilter

type HandoverJobHandoverJobLineItemsFilter

type HandoverJobHandoverJobLineItemsFilter struct {
	// Article Nested search by article
	Article *HandoverJobHandoverJobLineItemsArticleFilter `json:"article,omitempty"`

	// SubstituteLineItems Nested list search by substituteLineItems
	SubstituteLineItems *HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter `json:"substituteLineItems,omitempty"`
}

HandoverJobHandoverJobLineItemsFilter HandoverJobHandoverJobLineItemsFilter

type HandoverJobHandoverJobLineItemsListFilter

type HandoverJobHandoverJobLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *HandoverJobHandoverJobLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

HandoverJobHandoverJobLineItemsListFilter HandoverJobHandoverJobLineItemsListFilter

type HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter

type HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringSearchFilter `json:"tenantArticleId,omitempty"`

	// Title Search by title
	Title *StringSearchFilter `json:"title,omitempty"`
}

HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter

type HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter

type HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter struct {
	// Article Nested search by article
	Article *HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter `json:"article,omitempty"`
}

HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter

type HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter

type HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter

type HandoverJobHandoverJobParcelInfoFilter

type HandoverJobHandoverJobParcelInfoFilter struct {
	// CarrierKey Search by carrierKey
	CarrierKey *StringFilter `json:"carrierKey,omitempty"`

	// CarrierRef Search by carrierRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	CarrierRef *StringFilter `json:"carrierRef,omitempty"`

	// CarrierTrackingNumber Search by carrierTrackingNumber
	CarrierTrackingNumber *StringFilter `json:"carrierTrackingNumber,omitempty"`

	// ShipmentRef Search by shipmentRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	ShipmentRef *StringFilter `json:"shipmentRef,omitempty"`
}

HandoverJobHandoverJobParcelInfoFilter HandoverJobHandoverJobParcelInfoFilter

type HandoverJobHandoverjobStatusEnumFilter

type HandoverJobHandoverjobStatusEnumFilter struct {
	// Eq Search by status
	Eq *HandoverJobHandoverjobStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]HandoverJobHandoverjobStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *HandoverJobHandoverjobStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

HandoverJobHandoverjobStatusEnumFilter HandoverJobHandoverjobStatusEnumFilter

type HandoverJobHandoverjobStatusEnumFilterEq

type HandoverJobHandoverjobStatusEnumFilterEq string

HandoverJobHandoverjobStatusEnumFilterEq Search by status

const (
	HandoverJobHandoverjobStatusEnumFilterEqCANCELED        HandoverJobHandoverjobStatusEnumFilterEq = "CANCELED"
	HandoverJobHandoverjobStatusEnumFilterEqHANDEDOVER      HandoverJobHandoverjobStatusEnumFilterEq = "HANDED_OVER"
	HandoverJobHandoverjobStatusEnumFilterEqOBSOLETE        HandoverJobHandoverjobStatusEnumFilterEq = "OBSOLETE"
	HandoverJobHandoverjobStatusEnumFilterEqOPEN            HandoverJobHandoverjobStatusEnumFilterEq = "OPEN"
	HandoverJobHandoverjobStatusEnumFilterEqWAITINGFORINPUT HandoverJobHandoverjobStatusEnumFilterEq = "WAITING_FOR_INPUT"
)

Defines values for HandoverJobHandoverjobStatusEnumFilterEq.

func (HandoverJobHandoverjobStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the HandoverJobHandoverjobStatusEnumFilterEq enum.

type HandoverJobHandoverjobStatusEnumFilterIn

type HandoverJobHandoverjobStatusEnumFilterIn string

HandoverJobHandoverjobStatusEnumFilterIn defines model for HandoverJobHandoverjobStatusEnumFilter.In.

const (
	HandoverJobHandoverjobStatusEnumFilterInCANCELED        HandoverJobHandoverjobStatusEnumFilterIn = "CANCELED"
	HandoverJobHandoverjobStatusEnumFilterInHANDEDOVER      HandoverJobHandoverjobStatusEnumFilterIn = "HANDED_OVER"
	HandoverJobHandoverjobStatusEnumFilterInOBSOLETE        HandoverJobHandoverjobStatusEnumFilterIn = "OBSOLETE"
	HandoverJobHandoverjobStatusEnumFilterInOPEN            HandoverJobHandoverjobStatusEnumFilterIn = "OPEN"
	HandoverJobHandoverjobStatusEnumFilterInWAITINGFORINPUT HandoverJobHandoverjobStatusEnumFilterIn = "WAITING_FOR_INPUT"
)

Defines values for HandoverJobHandoverjobStatusEnumFilterIn.

func (HandoverJobHandoverjobStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the HandoverJobHandoverjobStatusEnumFilterIn enum.

type HandoverJobHandoverjobStatusEnumFilterNotEq

type HandoverJobHandoverjobStatusEnumFilterNotEq string

HandoverJobHandoverjobStatusEnumFilterNotEq Search by status

const (
	HandoverJobHandoverjobStatusEnumFilterNotEqCANCELED        HandoverJobHandoverjobStatusEnumFilterNotEq = "CANCELED"
	HandoverJobHandoverjobStatusEnumFilterNotEqHANDEDOVER      HandoverJobHandoverjobStatusEnumFilterNotEq = "HANDED_OVER"
	HandoverJobHandoverjobStatusEnumFilterNotEqOBSOLETE        HandoverJobHandoverjobStatusEnumFilterNotEq = "OBSOLETE"
	HandoverJobHandoverjobStatusEnumFilterNotEqOPEN            HandoverJobHandoverjobStatusEnumFilterNotEq = "OPEN"
	HandoverJobHandoverjobStatusEnumFilterNotEqWAITINGFORINPUT HandoverJobHandoverjobStatusEnumFilterNotEq = "WAITING_FOR_INPUT"
)

Defines values for HandoverJobHandoverjobStatusEnumFilterNotEq.

func (HandoverJobHandoverjobStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the HandoverJobHandoverjobStatusEnumFilterNotEq enum.

type HandoverJobInvoiceAddressFilter

type HandoverJobInvoiceAddressFilter struct {
	// CompanyName Search by companyName
	CompanyName *StringSearchFilter `json:"companyName,omitempty"`

	// Email Search by email
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *StringSearchFilter `json:"email,omitempty"`

	// FirstName Search by firstName
	FirstName *StringSearchFilter `json:"firstName,omitempty"`

	// LastName Search by lastName
	LastName *StringSearchFilter `json:"lastName,omitempty"`
}

HandoverJobInvoiceAddressFilter HandoverJobInvoiceAddressFilter

type HandoverJobRecipientAddressFilter

type HandoverJobRecipientAddressFilter struct {
	// CompanyName Search by companyName
	CompanyName *StringSearchFilter `json:"companyName,omitempty"`

	// Email Search by email
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *StringSearchFilter `json:"email,omitempty"`

	// FirstName Search by firstName
	FirstName *StringSearchFilter `json:"firstName,omitempty"`

	// LastName Search by lastName
	LastName *StringSearchFilter `json:"lastName,omitempty"`
}

HandoverJobRecipientAddressFilter HandoverJobRecipientAddressFilter

type HandoverJobSearchQuery

type HandoverJobSearchQuery struct {
	// AdditionalHandoverJobLineItems Nested list search by additionalHandoverJobLineItems
	AdditionalHandoverJobLineItems *HandoverJobAdditionalHandoverJobLineItemsListFilter `json:"additionalHandoverJobLineItems,omitempty"`
	And                            *[]HandoverJobSearchQuery                            `json:"and,omitempty"`

	// Anonymized Search by anonymized
	Anonymized *BooleanFilter `json:"anonymized,omitempty"`

	// AssignedUsers Nested list search by assignedUsers
	AssignedUsers *HandoverJobAssignedUsersListFilter `json:"assignedUsers,omitempty"`

	// Channel Search by channel
	Channel *HandoverJobChannelEnumEnumFilter `json:"channel,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// FullIdentifier Search by fullIdentifier
	FullIdentifier *StringSearchFilter `json:"fullIdentifier,omitempty"`

	// HandoverJobLineItems Nested list search by handoverJobLineItems
	HandoverJobLineItems *HandoverJobHandoverJobLineItemsListFilter `json:"handoverJobLineItems,omitempty"`

	// HandoverJobParcelInfo Nested search by handoverJobParcelInfo
	HandoverJobParcelInfo *HandoverJobHandoverJobParcelInfoFilter `json:"handoverJobParcelInfo,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// InvoiceAddress Nested search by invoiceAddress
	InvoiceAddress *HandoverJobInvoiceAddressFilter `json:"invoiceAddress,omitempty"`
	Or             *[]HandoverJobSearchQuery        `json:"or,omitempty"`

	// PickJobRef Search by pickJobRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	PickJobRef *StringEqFilter `json:"pickJobRef,omitempty"`

	// PickupIdentifier Search by pickupIdentifier
	PickupIdentifier *StringEqFilter `json:"pickupIdentifier,omitempty"`

	// RecipientAddress Nested search by recipientAddress
	RecipientAddress *HandoverJobRecipientAddressFilter `json:"recipientAddress,omitempty"`

	// ShortIdentifier Search by shortIdentifier
	ShortIdentifier *StringSearchFilter `json:"shortIdentifier,omitempty"`

	// Status Search by status
	Status *HandoverJobHandoverjobStatusEnumFilter `json:"status,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringSearchFilter `json:"tenantOrderId,omitempty"`
}

HandoverJobSearchQuery HandoverJobSearchQuery

type HealthCheckResponse

type HealthCheckResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HealthResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseHealthCheckResponse

func ParseHealthCheckResponse(rsp *http.Response) (*HealthCheckResponse, error)

ParseHealthCheckResponse parses an HTTP response from a HealthCheckWithResponse call

func (HealthCheckResponse) ContentType

func (r HealthCheckResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (HealthCheckResponse) GetBody added in v0.8.0

func (r HealthCheckResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (HealthCheckResponse) GetJSON200 added in v0.8.0

func (r HealthCheckResponse) GetJSON200() *HealthResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (HealthCheckResponse) GetJSON401 added in v0.8.0

func (r HealthCheckResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (HealthCheckResponse) GetJSON403 added in v0.8.0

func (r HealthCheckResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (HealthCheckResponse) GetJSON404 added in v0.8.0

func (r HealthCheckResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (HealthCheckResponse) Status

func (r HealthCheckResponse) Status() string

Status returns HTTPResponse.Status

func (HealthCheckResponse) StatusCode

func (r HealthCheckResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HealthDependencyStatus

type HealthDependencyStatus struct {
	// Name Name of the component that is checked to be healthy
	//
	// Example: database
	Name string `json:"name"`

	// Status HealthStatus
	Status HealthStatus `json:"status"`
}

HealthDependencyStatus HealthDependencyStatus

type HealthResult

type HealthResult struct {
	Dependencies []HealthDependencyStatus `json:"dependencies"`

	// Status HealthStatus
	Status HealthStatus `json:"status"`
}

HealthResult HealthResult

type HealthStatus

type HealthStatus string

HealthStatus HealthStatus

const (
	HealthStatusDOWN HealthStatus = "DOWN"
	HealthStatusUP   HealthStatus = "UP"
)

Defines values for HealthStatus.

func (HealthStatus) Valid

func (e HealthStatus) Valid() bool

Valid indicates whether the value is a known member of the HealthStatus enum.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InboundProcessPurchaseOrderFilter

type InboundProcessPurchaseOrderFilter struct {
	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// OrderDate Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	//
	// Example: 2026-06-17T12:00:00.000Z
	OrderDate *DateFilter `json:"orderDate,omitempty"`

	// RequestedDate Nested search by requestedDate
	//
	// Example: 2026-06-17T12:00:00.000Z
	RequestedDate *InboundProcessPurchaseOrderRequestedDateFilter `json:"requestedDate,omitempty"`

	// RequestedItems Nested list search by requestedItems
	RequestedItems *InboundProcessPurchaseOrderRequestedItemsListFilter `json:"requestedItems,omitempty"`

	// Status Search by status
	Status *InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter `json:"status,omitempty"`

	// Supplier Nested search by supplier
	Supplier *InboundProcessPurchaseOrderSupplierFilter `json:"supplier,omitempty"`

	// Transfer Nested search by transfer
	Transfer *InboundProcessPurchaseOrderTransferFilter `json:"transfer,omitempty"`
}

InboundProcessPurchaseOrderFilter InboundProcessPurchaseOrderFilter

type InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties

type InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties defines model for InboundProcessPurchaseOrderFilter.customAttributes.AdditionalProperties.

func (InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties as a BooleanFilter

func (InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties as a DateFilter

func (InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) MarshalJSON

func (*InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*InboundProcessPurchaseOrderFilter_CustomAttributes_AdditionalProperties) UnmarshalJSON

type InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter

type InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter struct {
	// Eq Search by status
	Eq *InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEq `json:"notEq,omitempty"`
}

InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter

type InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEq

type InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEq string

InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEq Search by status

const (
	InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEqCANCELED InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEq = "CANCELED"
	InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEqOPEN     InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEq = "OPEN"
)

Defines values for InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEq.

func (InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEq) Valid

Valid indicates whether the value is a known member of the InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterEq enum.

type InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterIn

type InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterIn string

InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterIn defines model for InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter.In.

const (
	InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterInCANCELED InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterIn = "CANCELED"
	InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterInOPEN     InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterIn = "OPEN"
)

Defines values for InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterIn.

func (InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterIn) Valid

Valid indicates whether the value is a known member of the InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterIn enum.

type InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEq

type InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEq string

InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEq Search by status

const (
	InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEqCANCELED InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEq = "CANCELED"
	InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEqOPEN     InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEq = "OPEN"
)

Defines values for InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEq.

func (InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilterNotEq enum.

type InboundProcessPurchaseOrderRequestedDateFilter

type InboundProcessPurchaseOrderRequestedDateFilter struct {
	// Type Search by type
	Type *InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter `json:"type,omitempty"`

	// Value Search by value
	Value *DateFilter `json:"value,omitempty"`
}

InboundProcessPurchaseOrderRequestedDateFilter InboundProcessPurchaseOrderRequestedDateFilter

type InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter

type InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter struct {
	// Eq Search by type
	Eq *InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by type
	In *[]InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by type
	NotEq *InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter

type InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEq

type InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEq string

InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEq Search by type

const (
	InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEqASAP      InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEq = "ASAP"
	InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEqTIMEPOINT InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEq = "TIME_POINT"
)

Defines values for InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEq.

func (InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterEq enum.

type InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterIn

type InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterIn string

InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterIn defines model for InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter.In.

const (
	InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterInASAP      InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterIn = "ASAP"
	InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterInTIMEPOINT InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterIn = "TIME_POINT"
)

Defines values for InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterIn.

func (InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterIn enum.

type InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEq

type InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEq string

InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEq Search by type

const (
	InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEqASAP      InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEq = "ASAP"
	InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEqTIMEPOINT InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEq = "TIME_POINT"
)

Defines values for InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEq.

func (InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilterNotEq enum.

type InboundProcessPurchaseOrderRequestedItemsFilter

type InboundProcessPurchaseOrderRequestedItemsFilter struct {
	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// StockProperties Search by stockProperties
	StockProperties *map[string]InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties `json:"stockProperties,omitempty"`

	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`
}

InboundProcessPurchaseOrderRequestedItemsFilter InboundProcessPurchaseOrderRequestedItemsFilter

type InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties

type InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties defines model for InboundProcessPurchaseOrderRequestedItemsFilter.customAttributes.AdditionalProperties.

func (InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties as a BooleanFilter

func (InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties as a DateFilter

func (InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) MarshalJSON

func (*InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_CustomAttributes_AdditionalProperties) UnmarshalJSON

type InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties

type InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties struct {
	// contains filtered or unexported fields
}

InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties defines model for InboundProcessPurchaseOrderRequestedItemsFilter.stockProperties.AdditionalProperties.

func (InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties) AsKeyExistsFilter

AsKeyExistsFilter returns the union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties as a KeyExistsFilter

func (InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties) AsStringFilter

AsStringFilter returns the union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties as a StringFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties) FromKeyExistsFilter

FromKeyExistsFilter overwrites any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties as the provided KeyExistsFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties) FromStringFilter

FromStringFilter overwrites any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties as the provided StringFilter

func (InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties) MarshalJSON

func (*InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties) MergeKeyExistsFilter

MergeKeyExistsFilter performs a merge with any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties, using the provided KeyExistsFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties) MergeStringFilter

MergeStringFilter performs a merge with any union data inside the InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties, using the provided StringFilter

func (*InboundProcessPurchaseOrderRequestedItemsFilter_StockProperties_AdditionalProperties) UnmarshalJSON

type InboundProcessPurchaseOrderRequestedItemsListFilter

type InboundProcessPurchaseOrderRequestedItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *InboundProcessPurchaseOrderRequestedItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

InboundProcessPurchaseOrderRequestedItemsListFilter InboundProcessPurchaseOrderRequestedItemsListFilter

type InboundProcessPurchaseOrderSupplierFilter

type InboundProcessPurchaseOrderSupplierFilter struct {
	// Name Search by name
	Name *StringFilter `json:"name,omitempty"`
}

InboundProcessPurchaseOrderSupplierFilter InboundProcessPurchaseOrderSupplierFilter

type InboundProcessPurchaseOrderTransferFilter

type InboundProcessPurchaseOrderTransferFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`
}

InboundProcessPurchaseOrderTransferFilter InboundProcessPurchaseOrderTransferFilter

type InboundProcessReceiptsFilter

type InboundProcessReceiptsFilter struct {
	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// ReceivedDate Search by receivedDate
	//
	// Example: 2026-06-17T12:00:00.000Z
	ReceivedDate *DateFilter `json:"receivedDate,omitempty"`

	// ReceivedItems Nested list search by receivedItems
	ReceivedItems *InboundProcessReceiptsReceivedItemsListFilter `json:"receivedItems,omitempty"`

	// Status Search by status
	Status *InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter `json:"status,omitempty"`
}

InboundProcessReceiptsFilter InboundProcessReceiptsFilter

type InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties

type InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties defines model for InboundProcessReceiptsFilter.customAttributes.AdditionalProperties.

func (InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties as a BooleanFilter

func (InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties as a DateFilter

func (InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) MarshalJSON

func (*InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*InboundProcessReceiptsFilter_CustomAttributes_AdditionalProperties) UnmarshalJSON

type InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter

type InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter struct {
	// Eq Search by status
	Eq *InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter

type InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq

type InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq string

InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq Search by status

const (
	InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEqFINISHED   InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq = "FINISHED"
	InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEqINPROGRESS InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq = "IN_PROGRESS"
	InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEqOPEN       InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq = "OPEN"
)

Defines values for InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq.

func (InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterEq enum.

type InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn

type InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn string

InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn defines model for InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter.In.

const (
	InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterInFINISHED   InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn = "FINISHED"
	InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterInINPROGRESS InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn = "IN_PROGRESS"
	InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterInOPEN       InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn = "OPEN"
)

Defines values for InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn.

func (InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterIn enum.

type InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq

type InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq string

InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq Search by status

const (
	InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEqFINISHED   InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq = "FINISHED"
	InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEqINPROGRESS InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq = "IN_PROGRESS"
	InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEqOPEN       InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq = "OPEN"
)

Defines values for InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq.

func (InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the InboundProcessReceiptsInboundReceiptStatusTypeEnumFilterNotEq enum.

type InboundProcessReceiptsListFilter

type InboundProcessReceiptsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *InboundProcessReceiptsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

InboundProcessReceiptsListFilter InboundProcessReceiptsListFilter

type InboundProcessReceiptsReceivedItemsFilter

type InboundProcessReceiptsReceivedItemsFilter struct {
	// StockProperties Search by stockProperties
	StockProperties *map[string]InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties `json:"stockProperties,omitempty"`

	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`
}

InboundProcessReceiptsReceivedItemsFilter InboundProcessReceiptsReceivedItemsFilter

type InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties

type InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties struct {
	// contains filtered or unexported fields
}

InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties defines model for InboundProcessReceiptsReceivedItemsFilter.stockProperties.AdditionalProperties.

func (InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties) AsKeyExistsFilter

AsKeyExistsFilter returns the union data inside the InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties as a KeyExistsFilter

func (InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties) AsStringFilter

AsStringFilter returns the union data inside the InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties as a StringFilter

func (*InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties) FromKeyExistsFilter

FromKeyExistsFilter overwrites any union data inside the InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties as the provided KeyExistsFilter

func (*InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties) FromStringFilter

FromStringFilter overwrites any union data inside the InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties as the provided StringFilter

func (InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties) MarshalJSON

func (*InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties) MergeKeyExistsFilter

MergeKeyExistsFilter performs a merge with any union data inside the InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties, using the provided KeyExistsFilter

func (*InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties) MergeStringFilter

MergeStringFilter performs a merge with any union data inside the InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties, using the provided StringFilter

func (*InboundProcessReceiptsReceivedItemsFilter_StockProperties_AdditionalProperties) UnmarshalJSON

type InboundProcessReceiptsReceivedItemsListFilter

type InboundProcessReceiptsReceivedItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *InboundProcessReceiptsReceivedItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

InboundProcessReceiptsReceivedItemsListFilter InboundProcessReceiptsReceivedItemsListFilter

type InboundProcessSearchQuery

type InboundProcessSearchQuery struct {
	And *[]InboundProcessSearchQuery `json:"and,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]InboundProcessSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// InboundDate Search by inboundDate
	//
	// Example: 2026-06-17T12:00:00.000Z
	InboundDate *DateListFilter              `json:"inboundDate,omitempty"`
	Or          *[]InboundProcessSearchQuery `json:"or,omitempty"`

	// PurchaseOrder Nested search by purchaseOrder
	PurchaseOrder *InboundProcessPurchaseOrderFilter `json:"purchaseOrder,omitempty"`

	// Receipts Nested list search by receipts
	Receipts *InboundProcessReceiptsListFilter `json:"receipts,omitempty"`

	// ScannableCodes Search by scannableCodes
	ScannableCodes *StringListFilter `json:"scannableCodes,omitempty"`

	// Status Search by status
	Status *InboundProcessStatusTypeEnumFilter `json:"status,omitempty"`

	// TenantInboundProcessId Search by tenantInboundProcessId
	//
	// Example: MY_INBOUNDPROCESS_ID
	TenantInboundProcessId *StringFilter `json:"tenantInboundProcessId,omitempty"`
}

InboundProcessSearchQuery InboundProcessSearchQuery

type InboundProcessSearchQuery_CustomAttributes_AdditionalProperties

type InboundProcessSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

InboundProcessSearchQuery_CustomAttributes_AdditionalProperties defines model for InboundProcessSearchQuery.customAttributes.AdditionalProperties.

func (InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the InboundProcessSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*InboundProcessSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type InboundProcessStatusTypeEnumFilter

type InboundProcessStatusTypeEnumFilter struct {
	// Eq Search by status
	Eq *InboundProcessStatusTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]InboundProcessStatusTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *InboundProcessStatusTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

InboundProcessStatusTypeEnumFilter InboundProcessStatusTypeEnumFilter

type InboundProcessStatusTypeEnumFilterEq

type InboundProcessStatusTypeEnumFilterEq string

InboundProcessStatusTypeEnumFilterEq Search by status

const (
	InboundProcessStatusTypeEnumFilterEqCLOSED          InboundProcessStatusTypeEnumFilterEq = "CLOSED"
	InboundProcessStatusTypeEnumFilterEqONHOLD          InboundProcessStatusTypeEnumFilterEq = "ON_HOLD"
	InboundProcessStatusTypeEnumFilterEqOPEN            InboundProcessStatusTypeEnumFilterEq = "OPEN"
	InboundProcessStatusTypeEnumFilterEqPARTIALDELIVERY InboundProcessStatusTypeEnumFilterEq = "PARTIAL_DELIVERY"
)

Defines values for InboundProcessStatusTypeEnumFilterEq.

func (InboundProcessStatusTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the InboundProcessStatusTypeEnumFilterEq enum.

type InboundProcessStatusTypeEnumFilterIn

type InboundProcessStatusTypeEnumFilterIn string

InboundProcessStatusTypeEnumFilterIn defines model for InboundProcessStatusTypeEnumFilter.In.

const (
	InboundProcessStatusTypeEnumFilterInCLOSED          InboundProcessStatusTypeEnumFilterIn = "CLOSED"
	InboundProcessStatusTypeEnumFilterInONHOLD          InboundProcessStatusTypeEnumFilterIn = "ON_HOLD"
	InboundProcessStatusTypeEnumFilterInOPEN            InboundProcessStatusTypeEnumFilterIn = "OPEN"
	InboundProcessStatusTypeEnumFilterInPARTIALDELIVERY InboundProcessStatusTypeEnumFilterIn = "PARTIAL_DELIVERY"
)

Defines values for InboundProcessStatusTypeEnumFilterIn.

func (InboundProcessStatusTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the InboundProcessStatusTypeEnumFilterIn enum.

type InboundProcessStatusTypeEnumFilterNotEq

type InboundProcessStatusTypeEnumFilterNotEq string

InboundProcessStatusTypeEnumFilterNotEq Search by status

const (
	InboundProcessStatusTypeEnumFilterNotEqCLOSED          InboundProcessStatusTypeEnumFilterNotEq = "CLOSED"
	InboundProcessStatusTypeEnumFilterNotEqONHOLD          InboundProcessStatusTypeEnumFilterNotEq = "ON_HOLD"
	InboundProcessStatusTypeEnumFilterNotEqOPEN            InboundProcessStatusTypeEnumFilterNotEq = "OPEN"
	InboundProcessStatusTypeEnumFilterNotEqPARTIALDELIVERY InboundProcessStatusTypeEnumFilterNotEq = "PARTIAL_DELIVERY"
)

Defines values for InboundProcessStatusTypeEnumFilterNotEq.

func (InboundProcessStatusTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the InboundProcessStatusTypeEnumFilterNotEq enum.

type InterFacilityConnection

type InterFacilityConnection struct {
	// CarrierKey The key of the carrier that is used for this connection. References known and configured carriers in the system.
	//
	// Example: DHL_V2
	CarrierKey *string `json:"carrierKey,omitempty"`

	// CarrierName The name of the carrier that is used for this connection.
	//
	// Example: DHL
	CarrierName *string                           `json:"carrierName,omitempty"`
	Context     *[]InterFacilityConnectionContext `json:"context,omitempty"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// CustomAttributes Custom attributes that can be used to store additional information about the connection.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes   *CarrierCutoffTimes                    `json:"cutoffTimes,omitempty"`
	FallbackCosts *[]InterFacilityConnectionDeliveryCost `json:"fallbackCosts,omitempty"`

	// FallbackTransitTime CarrierTransitTime
	FallbackTransitTime         *CarrierTransitTime                                  `json:"fallbackTransitTime,omitempty"`
	GeneralShipmentRestrictions *[]InterFacilityConnectionGeneralShipmentRestriction `json:"generalShipmentRestrictions,omitempty"`
	Id                          string                                               `json:"id"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified                            *time.Time                                                       `json:"lastModified,omitempty"`
	NonDeliveryDays                         *[]NonDeliveryDaysPerCountryAndProvince                          `json:"nonDeliveryDays,omitempty"`
	PackageTypeSpecificShipmentRestrictions *[]InterFacilityConnectionPackageTypeSpecificShipmentRestriction `json:"packageTypeSpecificShipmentRestrictions,omitempty"`
	PackagingUnitsByContexts                *[]PackagingUnitsByContext                                       `json:"packagingUnitsByContexts,omitempty"`

	// PricingPerTransfer Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.
	PricingPerTransfer *InterFacilityConnectionTransferPricing `json:"pricingPerTransfer,omitempty"`
	SourceFacilityRef  string                                  `json:"sourceFacilityRef"`

	// SurchargesPerTransfer This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />
	SurchargesPerTransfer *[]InterFacilityConnection_SurchargesPerTransfer_Item `json:"surchargesPerTransfer,omitempty"`
	Target                InterFacilityConnection_Target                        `json:"target"`

	// TransportDetails TransportDetails
	TransportDetails *TransportDetails `json:"transportDetails,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

InterFacilityConnection InterFacilityConnection

type InterFacilityConnectionBaseTarget

type InterFacilityConnectionBaseTarget struct {
	// Type ConnectionType
	Type ConnectionType `json:"type"`
}

InterFacilityConnectionBaseTarget InterFacilityConnectionBaseTarget

type InterFacilityConnectionContext

type InterFacilityConnectionContext struct {
	// Operator The operator used to define how the context values are evaluated or compared.
	Operator *ContextOperator `json:"operator,omitempty"`

	// Type InterFacilityConnectionContextTypes
	Type   InterFacilityConnectionContextTypes `json:"type"`
	Values []string                            `json:"values"`
}

InterFacilityConnectionContext InterFacilityConnectionContext

type InterFacilityConnectionContextTypes

type InterFacilityConnectionContextTypes string

InterFacilityConnectionContextTypes InterFacilityConnectionContextTypes

const (
	InterFacilityConnectionContextTypesCATEGORY         InterFacilityConnectionContextTypes = "CATEGORY"
	InterFacilityConnectionContextTypesFACILITY         InterFacilityConnectionContextTypes = "FACILITY"
	InterFacilityConnectionContextTypesFACILITYGROUP    InterFacilityConnectionContextTypes = "FACILITY_GROUP"
	InterFacilityConnectionContextTypesTAGREFERENCE     InterFacilityConnectionContextTypes = "TAG_REFERENCE"
	InterFacilityConnectionContextTypesTARGETCOUNTRY    InterFacilityConnectionContextTypes = "TARGET_COUNTRY"
	InterFacilityConnectionContextTypesTARGETPOSTALCODE InterFacilityConnectionContextTypes = "TARGET_POSTALCODE"
)

Defines values for InterFacilityConnectionContextTypes.

func (InterFacilityConnectionContextTypes) Valid

Valid indicates whether the value is a known member of the InterFacilityConnectionContextTypes enum.

type InterFacilityConnectionCostCoefficient added in v0.8.0

type InterFacilityConnectionCostCoefficient struct {
	// MeasurementUnit The unit of measurement for the cost coefficient.
	MeasurementUnit InterFacilityConnectionPricingMeasurementUnit `json:"measurementUnit"`

	// Value InterFacilityConnectionsMoney
	Value InterFacilityConnectionsMoney `json:"value"`
}

InterFacilityConnectionCostCoefficient The configured rate charged per measurement unit, applied to the measured value.

type InterFacilityConnectionCustomerTarget

type InterFacilityConnectionCustomerTarget = InterFacilityConnectionBaseTarget

InterFacilityConnectionCustomerTarget InterFacilityConnectionCustomerTarget

type InterFacilityConnectionDeliveryCost

type InterFacilityConnectionDeliveryCost struct {
	// Currency The currency code is a three-letter code that represents a currency in the ISO 4217 standard.
	Currency CurrencyCode `json:"currency"`

	// DecimalPlaces Number of decimal places for the given currency
	//
	// Example: 2
	DecimalPlaces *int `json:"decimalPlaces,omitempty"`

	// DeliveryCostCoefficient DeliverCostCoefficient
	DeliveryCostCoefficient *DeliverCostCoefficient `json:"deliveryCostCoefficient,omitempty"`

	// Value Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.
	//
	// Example: 25000
	Value int `json:"value"`
}

InterFacilityConnectionDeliveryCost InterFacilityConnectionDeliveryCost

type InterFacilityConnectionGeneralShipmentRestriction added in v0.8.0

type InterFacilityConnectionGeneralShipmentRestriction struct {
	// RestrictionType InterFacilityConnectionGeneralShipmentRestrictionType
	RestrictionType InterFacilityConnectionGeneralShipmentRestrictionType `json:"restrictionType"`
	Value           float32                                               `json:"value"`
}

InterFacilityConnectionGeneralShipmentRestriction InterFacilityConnectionGeneralShipmentRestriction

type InterFacilityConnectionGeneralShipmentRestrictionType added in v0.8.0

type InterFacilityConnectionGeneralShipmentRestrictionType string

InterFacilityConnectionGeneralShipmentRestrictionType InterFacilityConnectionGeneralShipmentRestrictionType

const (
	MAXLOADINGMETERSPERSHIPMENT  InterFacilityConnectionGeneralShipmentRestrictionType = "MAX_LOADING_METERS_PER_SHIPMENT"
	MAXPACKAGINGUNITSPERSHIPMENT InterFacilityConnectionGeneralShipmentRestrictionType = "MAX_PACKAGING_UNITS_PER_SHIPMENT"
	MAXWEIGHTPERLOADINGMETER     InterFacilityConnectionGeneralShipmentRestrictionType = "MAX_WEIGHT_PER_LOADING_METER"
	MAXWEIGHTPERSHIPMENT         InterFacilityConnectionGeneralShipmentRestrictionType = "MAX_WEIGHT_PER_SHIPMENT"
	MINPACKAGINGUNITSPERSHIPMENT InterFacilityConnectionGeneralShipmentRestrictionType = "MIN_PACKAGING_UNITS_PER_SHIPMENT"
)

Defines values for InterFacilityConnectionGeneralShipmentRestrictionType.

func (InterFacilityConnectionGeneralShipmentRestrictionType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionGeneralShipmentRestrictionType enum.

type InterFacilityConnectionManagedFacilityTarget

type InterFacilityConnectionManagedFacilityTarget struct {
	ExcludedFacilityGroupRefs *[]string `json:"excludedFacilityGroupRefs,omitempty"`
	ExcludedFacilityRefs      *[]string `json:"excludedFacilityRefs,omitempty"`
	FacilityRef               *string   `json:"facilityRef,omitempty"`

	// Type ConnectionType
	Type ConnectionType `json:"type"`
}

InterFacilityConnectionManagedFacilityTarget InterFacilityConnectionManagedFacilityTarget

type InterFacilityConnectionPackageTypeSpecificShipmentRestriction added in v0.8.0

type InterFacilityConnectionPackageTypeSpecificShipmentRestriction struct {
	PackagingUnitRefs *[]string `json:"packagingUnitRefs,omitempty"`

	// PackagingUnitType The type of the packagingUnit.
	PackagingUnitType PackagingUnitType `json:"packagingUnitType"`

	// RestrictionType InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType
	RestrictionType InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType `json:"restrictionType"`
	Value           float32                                                           `json:"value"`
}

InterFacilityConnectionPackageTypeSpecificShipmentRestriction InterFacilityConnectionPackageTypeSpecificShipmentRestriction

type InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType added in v0.8.0

type InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType string

InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType

const (
	MAXPACKAGINGUNITSPERTYPE InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType = "MAX_PACKAGING_UNITS_PER_TYPE"
)

Defines values for InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType.

func (InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType enum.

type InterFacilityConnectionPricesByTier added in v0.8.0

type InterFacilityConnectionPricesByTier struct {
	// Factor Charges price once per this many units of pricingUnit started, rounded up, instead of as a flat price for the tier. Use 1 to bill exactly. Omit it to charge price flat.
	//
	// Example: 100000
	Factor *float32 `json:"factor,omitempty"`

	// Price InterFacilityConnectionsMoney
	Price InterFacilityConnectionsMoney `json:"price"`

	// UpperThreshold The threshold in pricingUnit up to which this price applies.
	//
	// Example: 15000
	UpperThreshold int64 `json:"upperThreshold"`
}

InterFacilityConnectionPricesByTier InterFacilityConnectionPricesByTier

type InterFacilityConnectionPricingBasis added in v0.8.0

type InterFacilityConnectionPricingBasis struct {
	// PricingQuantities The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.
	PricingQuantities []InterFacilityConnectionPricingQuantity `json:"pricingQuantities"`

	// PricingUnit The unit the pricing quantities are converted to and priced in.
	PricingUnit InterFacilityConnectionPricingUnit `json:"pricingUnit"`
}

InterFacilityConnectionPricingBasis InterFacilityConnectionPricingBasis

type InterFacilityConnectionPricingByZone added in v0.8.0

type InterFacilityConnectionPricingByZone struct {
	// OverflowFactor Additional costs in case the price definition is exceeded.
	OverflowFactor *InterFacilityConnectionPricingOverflowFactor `json:"overflowFactor,omitempty"`

	// Prices The prices of this zone, by upper threshold.
	Prices []InterFacilityConnectionPricesByTier `json:"prices"`

	// Zone The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.
	//
	// Example: IT-20
	Zone *string `json:"zone,omitempty"`
}

InterFacilityConnectionPricingByZone InterFacilityConnectionPricingByZone

type InterFacilityConnectionPricingMeasurementUnit added in v0.8.0

type InterFacilityConnectionPricingMeasurementUnit string

InterFacilityConnectionPricingMeasurementUnit The unit of measurement for the cost coefficient.

const (
	InterFacilityConnectionPricingMeasurementUnitCUBICMETER InterFacilityConnectionPricingMeasurementUnit = "CUBIC_METER"
	InterFacilityConnectionPricingMeasurementUnitGRAM       InterFacilityConnectionPricingMeasurementUnit = "GRAM"
)

Defines values for InterFacilityConnectionPricingMeasurementUnit.

func (InterFacilityConnectionPricingMeasurementUnit) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionPricingMeasurementUnit enum.

type InterFacilityConnectionPricingOverflowFactor added in v0.8.0

type InterFacilityConnectionPricingOverflowFactor struct {
	// Factor The factor appliable when the highest configured threshold is exceeded.
	//
	// Example: 1.5
	Factor float32 `json:"factor"`

	// Price InterFacilityConnectionsMoney
	Price InterFacilityConnectionsMoney `json:"price"`
}

InterFacilityConnectionPricingOverflowFactor Additional costs in case the price definition is exceeded.

type InterFacilityConnectionPricingQuantity added in v0.8.0

type InterFacilityConnectionPricingQuantity string

InterFacilityConnectionPricingQuantity A quantity of the transfer that can determine the chargeable amount.

const (
	ACTUALWEIGHT           InterFacilityConnectionPricingQuantity = "ACTUAL_WEIGHT"
	LOADINGMETEREQUIVALENT InterFacilityConnectionPricingQuantity = "LOADING_METER_EQUIVALENT"
	VOLUMETRICWEIGHT       InterFacilityConnectionPricingQuantity = "VOLUMETRIC_WEIGHT"
)

Defines values for InterFacilityConnectionPricingQuantity.

func (InterFacilityConnectionPricingQuantity) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionPricingQuantity enum.

type InterFacilityConnectionPricingUnit added in v0.8.0

type InterFacilityConnectionPricingUnit string

InterFacilityConnectionPricingUnit The unit the pricing quantities are converted to and priced in.

const (
	InterFacilityConnectionPricingUnitCUBICMETER   InterFacilityConnectionPricingUnit = "CUBIC_METER"
	InterFacilityConnectionPricingUnitGRAM         InterFacilityConnectionPricingUnit = "GRAM"
	InterFacilityConnectionPricingUnitLOADINGMETER InterFacilityConnectionPricingUnit = "LOADING_METER"
)

Defines values for InterFacilityConnectionPricingUnit.

func (InterFacilityConnectionPricingUnit) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionPricingUnit enum.

type InterFacilityConnectionSupplierTarget

type InterFacilityConnectionSupplierTarget struct {
	ExcludedFacilityGroupRefs *[]string `json:"excludedFacilityGroupRefs,omitempty"`
	ExcludedFacilityRefs      *[]string `json:"excludedFacilityRefs,omitempty"`
	FacilityRef               *string   `json:"facilityRef,omitempty"`

	// Type ConnectionType
	Type ConnectionType `json:"type"`
}

InterFacilityConnectionSupplierTarget InterFacilityConnectionSupplierTarget

type InterFacilityConnectionSurchargeCalculationScope added in v0.8.0

type InterFacilityConnectionSurchargeCalculationScope struct {
	// Mode Whether a scope names the charges a percentage is calculated on, or the ones it is not calculated on.
	Mode       InterFacilityConnectionSurchargeScopeMode        `json:"mode"`
	References []InterFacilityConnectionSurchargeScopeReference `json:"references"`
}

InterFacilityConnectionSurchargeCalculationScope The charges a percentage is calculated against: exactly the referenced ones, or the charged price without them. A reference that matches nothing contributes nothing.

type InterFacilityConnectionSurchargeContext added in v0.8.0

type InterFacilityConnectionSurchargeContext struct {
	// Operator The operator used to define how the context values are evaluated or compared.
	Operator *ContextOperator `json:"operator,omitempty"`

	// Type InterFacilityConnectionSurchargeContextTypes
	Type   InterFacilityConnectionSurchargeContextTypes `json:"type"`
	Values []string                                     `json:"values"`
}

InterFacilityConnectionSurchargeContext InterFacilityConnectionSurchargeContext

type InterFacilityConnectionSurchargeContextTypes added in v0.8.0

type InterFacilityConnectionSurchargeContextTypes string

InterFacilityConnectionSurchargeContextTypes InterFacilityConnectionSurchargeContextTypes

const (
	InterFacilityConnectionSurchargeContextTypesCATEGORY         InterFacilityConnectionSurchargeContextTypes = "CATEGORY"
	InterFacilityConnectionSurchargeContextTypesTAGREFERENCE     InterFacilityConnectionSurchargeContextTypes = "TAG_REFERENCE"
	InterFacilityConnectionSurchargeContextTypesTARGETCOUNTRY    InterFacilityConnectionSurchargeContextTypes = "TARGET_COUNTRY"
	InterFacilityConnectionSurchargeContextTypesTARGETPOSTALCODE InterFacilityConnectionSurchargeContextTypes = "TARGET_POSTALCODE"
)

Defines values for InterFacilityConnectionSurchargeContextTypes.

func (InterFacilityConnectionSurchargeContextTypes) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionSurchargeContextTypes enum.

type InterFacilityConnectionSurchargeScopeLevel added in v0.8.0

type InterFacilityConnectionSurchargeScopeLevel string

InterFacilityConnectionSurchargeScopeLevel The pricing level that made a charge. PACKAGING_UNIT is what the packaging units of the transfer charged, TRANSFER what the transfer itself charged.

const (
	PACKAGINGUNIT InterFacilityConnectionSurchargeScopeLevel = "PACKAGING_UNIT"
	TRANSFER      InterFacilityConnectionSurchargeScopeLevel = "TRANSFER"
)

Defines values for InterFacilityConnectionSurchargeScopeLevel.

func (InterFacilityConnectionSurchargeScopeLevel) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionSurchargeScopeLevel enum.

type InterFacilityConnectionSurchargeScopeMode added in v0.8.0

type InterFacilityConnectionSurchargeScopeMode string

InterFacilityConnectionSurchargeScopeMode Whether a scope names the charges a percentage is calculated on, or the ones it is not calculated on.

Defines values for InterFacilityConnectionSurchargeScopeMode.

func (InterFacilityConnectionSurchargeScopeMode) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionSurchargeScopeMode enum.

type InterFacilityConnectionSurchargeScopeReference added in v0.8.0

type InterFacilityConnectionSurchargeScopeReference struct {
	// Kind What a scope reference selects. BASE_PRICE is the resolved base price of the transfer, TENANT_SURCHARGE every charge made under the reference's tenantSurchargeType, PACKAGING_UNITS everything the packaging units of the transfer charged, and GOODS_VALUE the order's goods value that ships with the transfer. PACKAGING_UNITS and GOODS_VALUE are only available on the transfer level.
	Kind InterFacilityConnectionSurchargeScopeReferenceKind `json:"kind"`

	// Level Restricts the reference to the charges made on one pricing level. If omitted, charges of both levels are selected, so a tenantSurchargeType configured on both matches both.
	Level *InterFacilityConnectionSurchargeScopeLevel `json:"level,omitempty"`

	// TenantSurchargeType The referenced tenant surcharge type. Only read for TENANT_SURCHARGE references.
	TenantSurchargeType *string `json:"tenantSurchargeType,omitempty"`
}

InterFacilityConnectionSurchargeScopeReference One entry of a calculation scope.

type InterFacilityConnectionSurchargeScopeReferenceKind added in v0.8.0

type InterFacilityConnectionSurchargeScopeReferenceKind string

InterFacilityConnectionSurchargeScopeReferenceKind What a scope reference selects. BASE_PRICE is the resolved base price of the transfer, TENANT_SURCHARGE every charge made under the reference's tenantSurchargeType, PACKAGING_UNITS everything the packaging units of the transfer charged, and GOODS_VALUE the order's goods value that ships with the transfer. PACKAGING_UNITS and GOODS_VALUE are only available on the transfer level.

const (
	InterFacilityConnectionSurchargeScopeReferenceKindBASEPRICE       InterFacilityConnectionSurchargeScopeReferenceKind = "BASE_PRICE"
	InterFacilityConnectionSurchargeScopeReferenceKindGOODSVALUE      InterFacilityConnectionSurchargeScopeReferenceKind = "GOODS_VALUE"
	InterFacilityConnectionSurchargeScopeReferenceKindPACKAGINGUNITS  InterFacilityConnectionSurchargeScopeReferenceKind = "PACKAGING_UNITS"
	InterFacilityConnectionSurchargeScopeReferenceKindTENANTSURCHARGE InterFacilityConnectionSurchargeScopeReferenceKind = "TENANT_SURCHARGE"
)

Defines values for InterFacilityConnectionSurchargeScopeReferenceKind.

func (InterFacilityConnectionSurchargeScopeReferenceKind) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionSurchargeScopeReferenceKind enum.

type InterFacilityConnectionToCustomerForCreation

type InterFacilityConnectionToCustomerForCreation struct {
	// CarrierKey The key of the carrier that is used for this connection. References known and configured carriers in the system.
	//
	// Example: DHL_V2
	CarrierKey *string `json:"carrierKey,omitempty"`

	// CarrierName The name of the carrier that is used for this connection.
	//
	// Example: DHL
	CarrierName *string                           `json:"carrierName,omitempty"`
	Context     *[]InterFacilityConnectionContext `json:"context,omitempty"`

	// CustomAttributes Custom attributes that can be used to store additional information about the connection.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes   *CarrierCutoffTimes                    `json:"cutoffTimes,omitempty"`
	FallbackCosts *[]InterFacilityConnectionDeliveryCost `json:"fallbackCosts,omitempty"`

	// FallbackTransitTime CarrierTransitTime
	FallbackTransitTime                     *CarrierTransitTime                                              `json:"fallbackTransitTime,omitempty"`
	GeneralShipmentRestrictions             *[]InterFacilityConnectionGeneralShipmentRestriction             `json:"generalShipmentRestrictions,omitempty"`
	NonDeliveryDays                         *[]NonDeliveryDaysPerCountryAndProvince                          `json:"nonDeliveryDays,omitempty"`
	PackageTypeSpecificShipmentRestrictions *[]InterFacilityConnectionPackageTypeSpecificShipmentRestriction `json:"packageTypeSpecificShipmentRestrictions,omitempty"`
	PackagingUnitsByContexts                *[]PackagingUnitsByContext                                       `json:"packagingUnitsByContexts,omitempty"`

	// PricingPerTransfer Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.
	PricingPerTransfer    *InterFacilityConnectionTransferPricing                                    `json:"pricingPerTransfer,omitempty"`
	SurchargesPerTransfer *[]InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item `json:"surchargesPerTransfer,omitempty"`

	// Target InterFacilityConnectionCustomerTarget
	Target InterFacilityConnectionCustomerTarget `json:"target"`

	// TransportDetails TransportDetails
	TransportDetails *TransportDetails `json:"transportDetails,omitempty"`

	// Type ConnectionType
	Type ConnectionType `json:"type"`
}

InterFacilityConnectionToCustomerForCreation InterFacilityConnectionToCustomerForCreation

type InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item added in v0.8.0

type InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item struct {
	// contains filtered or unexported fields
}

InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item defines model for InterFacilityConnectionToCustomerForCreation.surchargesPerTransfer.Item.

func (InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

AsInterFacilityConnectionTransferAbsoluteSurcharge returns the union data inside the InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferAbsoluteSurcharge

func (InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

AsInterFacilityConnectionTransferRelativeSurcharge returns the union data inside the InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferRelativeSurcharge

func (InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

AsInterFacilityConnectionTransferThresholdSurcharge returns the union data inside the InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) Discriminator added in v0.8.0

func (*InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

FromInterFacilityConnectionTransferAbsoluteSurcharge overwrites any union data inside the InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

FromInterFacilityConnectionTransferRelativeSurcharge overwrites any union data inside the InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

FromInterFacilityConnectionTransferThresholdSurcharge overwrites any union data inside the InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) MarshalJSON added in v0.8.0

func (*InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferAbsoluteSurcharge performs a merge with any union data inside the InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferRelativeSurcharge performs a merge with any union data inside the InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferThresholdSurcharge performs a merge with any union data inside the InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferThresholdSurcharge

func (*InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) UnmarshalJSON added in v0.8.0

func (InterFacilityConnectionToCustomerForCreation_SurchargesPerTransfer_Item) ValueByDiscriminator added in v0.8.0

type InterFacilityConnectionToCustomerForUpdate

type InterFacilityConnectionToCustomerForUpdate struct {
	// CarrierKey The key of the carrier that is used for this connection. References known and configured carriers in the system.
	//
	// Example: DHL_V2
	CarrierKey *string `json:"carrierKey,omitempty"`

	// CarrierName The name of the carrier that is used for this connection.
	//
	// Example: DHL
	CarrierName *string                           `json:"carrierName,omitempty"`
	Context     *[]InterFacilityConnectionContext `json:"context,omitempty"`

	// CustomAttributes Custom attributes that can be used to store additional information about the connection.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes   *CarrierCutoffTimes                    `json:"cutoffTimes,omitempty"`
	FallbackCosts *[]InterFacilityConnectionDeliveryCost `json:"fallbackCosts,omitempty"`

	// FallbackTransitTime CarrierTransitTime
	FallbackTransitTime                     *CarrierTransitTime                                              `json:"fallbackTransitTime,omitempty"`
	GeneralShipmentRestrictions             *[]InterFacilityConnectionGeneralShipmentRestriction             `json:"generalShipmentRestrictions,omitempty"`
	NonDeliveryDays                         *[]NonDeliveryDaysPerCountryAndProvince                          `json:"nonDeliveryDays,omitempty"`
	PackageTypeSpecificShipmentRestrictions *[]InterFacilityConnectionPackageTypeSpecificShipmentRestriction `json:"packageTypeSpecificShipmentRestrictions,omitempty"`
	PackagingUnitsByContexts                *[]PackagingUnitsByContext                                       `json:"packagingUnitsByContexts,omitempty"`

	// PricingPerTransfer Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.
	PricingPerTransfer    *InterFacilityConnectionTransferPricing                                  `json:"pricingPerTransfer,omitempty"`
	SurchargesPerTransfer *[]InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item `json:"surchargesPerTransfer,omitempty"`

	// Target InterFacilityConnectionCustomerTarget
	Target InterFacilityConnectionCustomerTarget `json:"target"`

	// TransportDetails TransportDetails
	TransportDetails *TransportDetails `json:"transportDetails,omitempty"`

	// Type ConnectionType
	Type    ConnectionType `json:"type"`
	Version float32        `json:"version"`
}

InterFacilityConnectionToCustomerForUpdate InterFacilityConnectionToCustomerForUpdate

type InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item added in v0.8.0

type InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item struct {
	// contains filtered or unexported fields
}

InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item defines model for InterFacilityConnectionToCustomerForUpdate.surchargesPerTransfer.Item.

func (InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

AsInterFacilityConnectionTransferAbsoluteSurcharge returns the union data inside the InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferAbsoluteSurcharge

func (InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

AsInterFacilityConnectionTransferRelativeSurcharge returns the union data inside the InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferRelativeSurcharge

func (InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

AsInterFacilityConnectionTransferThresholdSurcharge returns the union data inside the InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) Discriminator added in v0.8.0

func (*InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

FromInterFacilityConnectionTransferAbsoluteSurcharge overwrites any union data inside the InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

FromInterFacilityConnectionTransferRelativeSurcharge overwrites any union data inside the InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

FromInterFacilityConnectionTransferThresholdSurcharge overwrites any union data inside the InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) MarshalJSON added in v0.8.0

func (*InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferAbsoluteSurcharge performs a merge with any union data inside the InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferRelativeSurcharge performs a merge with any union data inside the InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferThresholdSurcharge performs a merge with any union data inside the InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferThresholdSurcharge

func (*InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) UnmarshalJSON added in v0.8.0

func (InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) ValueByDiscriminator added in v0.8.0

func (t InterFacilityConnectionToCustomerForUpdate_SurchargesPerTransfer_Item) ValueByDiscriminator() (interface{}, error)

type InterFacilityConnectionToManagedFacilityForCreation

type InterFacilityConnectionToManagedFacilityForCreation struct {
	// CarrierKey The key of the carrier that is used for this connection. References known and configured carriers in the system.
	//
	// Example: DHL_V2
	CarrierKey *string `json:"carrierKey,omitempty"`

	// CarrierName The name of the carrier that is used for this connection.
	//
	// Example: DHL
	CarrierName *string                           `json:"carrierName,omitempty"`
	Context     *[]InterFacilityConnectionContext `json:"context,omitempty"`

	// CustomAttributes Custom attributes that can be used to store additional information about the connection.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes   *CarrierCutoffTimes                    `json:"cutoffTimes,omitempty"`
	FallbackCosts *[]InterFacilityConnectionDeliveryCost `json:"fallbackCosts,omitempty"`

	// FallbackTransitTime CarrierTransitTime
	FallbackTransitTime                     *CarrierTransitTime                                              `json:"fallbackTransitTime,omitempty"`
	GeneralShipmentRestrictions             *[]InterFacilityConnectionGeneralShipmentRestriction             `json:"generalShipmentRestrictions,omitempty"`
	NonDeliveryDays                         *[]NonDeliveryDaysPerCountryAndProvince                          `json:"nonDeliveryDays,omitempty"`
	PackageTypeSpecificShipmentRestrictions *[]InterFacilityConnectionPackageTypeSpecificShipmentRestriction `json:"packageTypeSpecificShipmentRestrictions,omitempty"`
	PackagingUnitsByContexts                *[]PackagingUnitsByContext                                       `json:"packagingUnitsByContexts,omitempty"`

	// PricingPerTransfer Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.
	PricingPerTransfer    *InterFacilityConnectionTransferPricing                                           `json:"pricingPerTransfer,omitempty"`
	SurchargesPerTransfer *[]InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item `json:"surchargesPerTransfer,omitempty"`

	// Target InterFacilityConnectionManagedFacilityTarget
	Target InterFacilityConnectionManagedFacilityTarget `json:"target"`

	// TransportDetails TransportDetails
	TransportDetails *TransportDetails `json:"transportDetails,omitempty"`

	// Type ConnectionType
	Type ConnectionType `json:"type"`
}

InterFacilityConnectionToManagedFacilityForCreation InterFacilityConnectionToManagedFacilityForCreation

type InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item added in v0.8.0

type InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item struct {
	// contains filtered or unexported fields
}

InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item defines model for InterFacilityConnectionToManagedFacilityForCreation.surchargesPerTransfer.Item.

func (InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

AsInterFacilityConnectionTransferAbsoluteSurcharge returns the union data inside the InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferAbsoluteSurcharge

func (InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

AsInterFacilityConnectionTransferRelativeSurcharge returns the union data inside the InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferRelativeSurcharge

func (InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

AsInterFacilityConnectionTransferThresholdSurcharge returns the union data inside the InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) Discriminator added in v0.8.0

func (*InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

FromInterFacilityConnectionTransferAbsoluteSurcharge overwrites any union data inside the InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

FromInterFacilityConnectionTransferRelativeSurcharge overwrites any union data inside the InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

FromInterFacilityConnectionTransferThresholdSurcharge overwrites any union data inside the InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) MarshalJSON added in v0.8.0

func (*InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferAbsoluteSurcharge performs a merge with any union data inside the InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferRelativeSurcharge performs a merge with any union data inside the InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferThresholdSurcharge performs a merge with any union data inside the InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferThresholdSurcharge

func (*InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) UnmarshalJSON added in v0.8.0

func (InterFacilityConnectionToManagedFacilityForCreation_SurchargesPerTransfer_Item) ValueByDiscriminator added in v0.8.0

type InterFacilityConnectionToManagedFacilityForUpdate

type InterFacilityConnectionToManagedFacilityForUpdate struct {
	// CarrierKey The key of the carrier that is used for this connection. References known and configured carriers in the system.
	//
	// Example: DHL_V2
	CarrierKey *string `json:"carrierKey,omitempty"`

	// CarrierName The name of the carrier that is used for this connection.
	//
	// Example: DHL
	CarrierName *string                           `json:"carrierName,omitempty"`
	Context     *[]InterFacilityConnectionContext `json:"context,omitempty"`

	// CustomAttributes Custom attributes that can be used to store additional information about the connection.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes   *CarrierCutoffTimes                    `json:"cutoffTimes,omitempty"`
	FallbackCosts *[]InterFacilityConnectionDeliveryCost `json:"fallbackCosts,omitempty"`

	// FallbackTransitTime CarrierTransitTime
	FallbackTransitTime                     *CarrierTransitTime                                              `json:"fallbackTransitTime,omitempty"`
	GeneralShipmentRestrictions             *[]InterFacilityConnectionGeneralShipmentRestriction             `json:"generalShipmentRestrictions,omitempty"`
	NonDeliveryDays                         *[]NonDeliveryDaysPerCountryAndProvince                          `json:"nonDeliveryDays,omitempty"`
	PackageTypeSpecificShipmentRestrictions *[]InterFacilityConnectionPackageTypeSpecificShipmentRestriction `json:"packageTypeSpecificShipmentRestrictions,omitempty"`
	PackagingUnitsByContexts                *[]PackagingUnitsByContext                                       `json:"packagingUnitsByContexts,omitempty"`

	// PricingPerTransfer Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.
	PricingPerTransfer    *InterFacilityConnectionTransferPricing                                         `json:"pricingPerTransfer,omitempty"`
	SurchargesPerTransfer *[]InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item `json:"surchargesPerTransfer,omitempty"`

	// Target InterFacilityConnectionManagedFacilityTarget
	Target InterFacilityConnectionManagedFacilityTarget `json:"target"`

	// TransportDetails TransportDetails
	TransportDetails *TransportDetails `json:"transportDetails,omitempty"`

	// Type ConnectionType
	Type    ConnectionType `json:"type"`
	Version float32        `json:"version"`
}

InterFacilityConnectionToManagedFacilityForUpdate InterFacilityConnectionToManagedFacilityForUpdate

type InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item added in v0.8.0

type InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item struct {
	// contains filtered or unexported fields
}

InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item defines model for InterFacilityConnectionToManagedFacilityForUpdate.surchargesPerTransfer.Item.

func (InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

AsInterFacilityConnectionTransferAbsoluteSurcharge returns the union data inside the InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferAbsoluteSurcharge

func (InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

AsInterFacilityConnectionTransferRelativeSurcharge returns the union data inside the InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferRelativeSurcharge

func (InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

AsInterFacilityConnectionTransferThresholdSurcharge returns the union data inside the InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) Discriminator added in v0.8.0

func (*InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

FromInterFacilityConnectionTransferAbsoluteSurcharge overwrites any union data inside the InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

FromInterFacilityConnectionTransferRelativeSurcharge overwrites any union data inside the InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

FromInterFacilityConnectionTransferThresholdSurcharge overwrites any union data inside the InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) MarshalJSON added in v0.8.0

func (*InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferAbsoluteSurcharge performs a merge with any union data inside the InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferRelativeSurcharge performs a merge with any union data inside the InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferThresholdSurcharge performs a merge with any union data inside the InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferThresholdSurcharge

func (*InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) UnmarshalJSON added in v0.8.0

func (InterFacilityConnectionToManagedFacilityForUpdate_SurchargesPerTransfer_Item) ValueByDiscriminator added in v0.8.0

type InterFacilityConnectionToSupplierForCreation

type InterFacilityConnectionToSupplierForCreation struct {
	// CarrierKey The key of the carrier that is used for this connection. References known and configured carriers in the system.
	//
	// Example: DHL_V2
	CarrierKey *string `json:"carrierKey,omitempty"`

	// CarrierName The name of the carrier that is used for this connection.
	//
	// Example: DHL
	CarrierName *string                           `json:"carrierName,omitempty"`
	Context     *[]InterFacilityConnectionContext `json:"context,omitempty"`

	// CustomAttributes Custom attributes that can be used to store additional information about the connection.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes   *CarrierCutoffTimes                    `json:"cutoffTimes,omitempty"`
	FallbackCosts *[]InterFacilityConnectionDeliveryCost `json:"fallbackCosts,omitempty"`

	// FallbackTransitTime CarrierTransitTime
	FallbackTransitTime                     *CarrierTransitTime                                              `json:"fallbackTransitTime,omitempty"`
	GeneralShipmentRestrictions             *[]InterFacilityConnectionGeneralShipmentRestriction             `json:"generalShipmentRestrictions,omitempty"`
	NonDeliveryDays                         *[]NonDeliveryDaysPerCountryAndProvince                          `json:"nonDeliveryDays,omitempty"`
	PackageTypeSpecificShipmentRestrictions *[]InterFacilityConnectionPackageTypeSpecificShipmentRestriction `json:"packageTypeSpecificShipmentRestrictions,omitempty"`
	PackagingUnitsByContexts                *[]PackagingUnitsByContext                                       `json:"packagingUnitsByContexts,omitempty"`

	// PricingPerTransfer Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.
	PricingPerTransfer    *InterFacilityConnectionTransferPricing                                    `json:"pricingPerTransfer,omitempty"`
	SurchargesPerTransfer *[]InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item `json:"surchargesPerTransfer,omitempty"`

	// Target InterFacilityConnectionSupplierTarget
	Target InterFacilityConnectionSupplierTarget `json:"target"`

	// TransportDetails TransportDetails
	TransportDetails *TransportDetails `json:"transportDetails,omitempty"`

	// Type ConnectionType
	Type ConnectionType `json:"type"`
}

InterFacilityConnectionToSupplierForCreation InterFacilityConnectionToSupplierForCreation

type InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item added in v0.8.0

type InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item struct {
	// contains filtered or unexported fields
}

InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item defines model for InterFacilityConnectionToSupplierForCreation.surchargesPerTransfer.Item.

func (InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

AsInterFacilityConnectionTransferAbsoluteSurcharge returns the union data inside the InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferAbsoluteSurcharge

func (InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

AsInterFacilityConnectionTransferRelativeSurcharge returns the union data inside the InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferRelativeSurcharge

func (InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

AsInterFacilityConnectionTransferThresholdSurcharge returns the union data inside the InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) Discriminator added in v0.8.0

func (*InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

FromInterFacilityConnectionTransferAbsoluteSurcharge overwrites any union data inside the InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

FromInterFacilityConnectionTransferRelativeSurcharge overwrites any union data inside the InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

FromInterFacilityConnectionTransferThresholdSurcharge overwrites any union data inside the InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) MarshalJSON added in v0.8.0

func (*InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferAbsoluteSurcharge performs a merge with any union data inside the InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferRelativeSurcharge performs a merge with any union data inside the InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferThresholdSurcharge performs a merge with any union data inside the InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferThresholdSurcharge

func (*InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) UnmarshalJSON added in v0.8.0

func (InterFacilityConnectionToSupplierForCreation_SurchargesPerTransfer_Item) ValueByDiscriminator added in v0.8.0

type InterFacilityConnectionToSupplierForUpdate

type InterFacilityConnectionToSupplierForUpdate struct {
	// CarrierKey The key of the carrier that is used for this connection. References known and configured carriers in the system.
	//
	// Example: DHL_V2
	CarrierKey *string `json:"carrierKey,omitempty"`

	// CarrierName The name of the carrier that is used for this connection.
	//
	// Example: DHL
	CarrierName *string                           `json:"carrierName,omitempty"`
	Context     *[]InterFacilityConnectionContext `json:"context,omitempty"`

	// CustomAttributes Custom attributes that can be used to store additional information about the connection.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// CutoffTimes CarrierCutoffTimes
	CutoffTimes   *CarrierCutoffTimes                    `json:"cutoffTimes,omitempty"`
	FallbackCosts *[]InterFacilityConnectionDeliveryCost `json:"fallbackCosts,omitempty"`

	// FallbackTransitTime CarrierTransitTime
	FallbackTransitTime                     *CarrierTransitTime                                              `json:"fallbackTransitTime,omitempty"`
	GeneralShipmentRestrictions             *[]InterFacilityConnectionGeneralShipmentRestriction             `json:"generalShipmentRestrictions,omitempty"`
	NonDeliveryDays                         *[]NonDeliveryDaysPerCountryAndProvince                          `json:"nonDeliveryDays,omitempty"`
	PackageTypeSpecificShipmentRestrictions *[]InterFacilityConnectionPackageTypeSpecificShipmentRestriction `json:"packageTypeSpecificShipmentRestrictions,omitempty"`
	PackagingUnitsByContexts                *[]PackagingUnitsByContext                                       `json:"packagingUnitsByContexts,omitempty"`

	// PricingPerTransfer Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.
	PricingPerTransfer    *InterFacilityConnectionTransferPricing                                  `json:"pricingPerTransfer,omitempty"`
	SurchargesPerTransfer *[]InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item `json:"surchargesPerTransfer,omitempty"`

	// Target InterFacilityConnectionSupplierTarget
	Target InterFacilityConnectionSupplierTarget `json:"target"`

	// TransportDetails TransportDetails
	TransportDetails *TransportDetails `json:"transportDetails,omitempty"`

	// Type ConnectionType
	Type    ConnectionType `json:"type"`
	Version float32        `json:"version"`
}

InterFacilityConnectionToSupplierForUpdate InterFacilityConnectionToSupplierForUpdate

type InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item added in v0.8.0

type InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item struct {
	// contains filtered or unexported fields
}

InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item defines model for InterFacilityConnectionToSupplierForUpdate.surchargesPerTransfer.Item.

func (InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

AsInterFacilityConnectionTransferAbsoluteSurcharge returns the union data inside the InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferAbsoluteSurcharge

func (InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

AsInterFacilityConnectionTransferRelativeSurcharge returns the union data inside the InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferRelativeSurcharge

func (InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

AsInterFacilityConnectionTransferThresholdSurcharge returns the union data inside the InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) Discriminator added in v0.8.0

func (*InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

FromInterFacilityConnectionTransferAbsoluteSurcharge overwrites any union data inside the InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

FromInterFacilityConnectionTransferRelativeSurcharge overwrites any union data inside the InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

FromInterFacilityConnectionTransferThresholdSurcharge overwrites any union data inside the InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) MarshalJSON added in v0.8.0

func (*InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferAbsoluteSurcharge performs a merge with any union data inside the InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferRelativeSurcharge performs a merge with any union data inside the InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

MergeInterFacilityConnectionTransferThresholdSurcharge performs a merge with any union data inside the InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferThresholdSurcharge

func (*InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) UnmarshalJSON added in v0.8.0

func (InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) ValueByDiscriminator added in v0.8.0

func (t InterFacilityConnectionToSupplierForUpdate_SurchargesPerTransfer_Item) ValueByDiscriminator() (interface{}, error)

type InterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

type InterFacilityConnectionTransferAbsoluteSurcharge struct {
	// Amount InterFacilityConnectionsMoney
	Amount  InterFacilityConnectionsMoney              `json:"amount"`
	Context *[]InterFacilityConnectionSurchargeContext `json:"context,omitempty"`

	// Priority Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.
	Priority            *int                                         `json:"priority,omitempty"`
	TenantSurchargeType string                                       `json:"tenantSurchargeType"`
	Type                InterFacilityConnectionTransferSurchargeType `json:"type"`
}

InterFacilityConnectionTransferAbsoluteSurcharge InterFacilityConnectionTransferAbsoluteSurcharge

type InterFacilityConnectionTransferPricing added in v0.8.0

type InterFacilityConnectionTransferPricing struct {
	// CostCoefficient The configured rate charged per measurement unit, applied to the measured value.
	CostCoefficient *InterFacilityConnectionCostCoefficient `json:"costCoefficient,omitempty"`

	// LdmToWeightFactor The grams equivalent to 1 loading meter, converting between weight and loading meters.
	//
	// Example: 1850
	LdmToWeightFactor *float32 `json:"ldmToWeightFactor,omitempty"`

	// MaxVolumetricWeight Caps the chargeable volumetric weight in grams.
	//
	// Example: 30000
	MaxVolumetricWeight *int `json:"maxVolumetricWeight,omitempty"`

	// Pricing The price matrix of this connection, by zone.
	Pricing []InterFacilityConnectionPricingByZone `json:"pricing"`

	// PricingBasis InterFacilityConnectionPricingBasis
	PricingBasis *InterFacilityConnectionPricingBasis `json:"pricingBasis,omitempty"`

	// VolumeBufferInPercent The buffer in percent applied to the aggregated volume of all packaging units.
	//
	// Example: 10
	VolumeBufferInPercent *int `json:"volumeBufferInPercent,omitempty"`

	// VolumetricWeightFactor Converts the aggregated volume of all packaging units into a volumetric weight.
	//
	// Example: 0.2
	VolumetricWeightFactor *float32 `json:"volumetricWeightFactor,omitempty"`

	// WeightBasis The article weight the aggregated weight of the transfer is calculated from: WEIGHT (weightPerUnit) or BILLABLE_WEIGHT (billableWeightPerUnit). Defaults to WEIGHT.
	WeightBasis *InterFacilityConnectionWeightBasis `json:"weightBasis,omitempty"`

	// WeightToVolumeFactor Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.
	//
	// Example: 0.005
	WeightToVolumeFactor *float32 `json:"weightToVolumeFactor,omitempty"`
}

InterFacilityConnectionTransferPricing Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.

type InterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

type InterFacilityConnectionTransferRelativeSurcharge struct {
	// CalculationScope The charges a percentage is calculated against: exactly the referenced ones, or the charged price without them. A reference that matches nothing contributes nothing.
	CalculationScope *InterFacilityConnectionSurchargeCalculationScope `json:"calculationScope,omitempty"`
	Context          *[]InterFacilityConnectionSurchargeContext        `json:"context,omitempty"`
	Percentage       float32                                           `json:"percentage"`

	// Priority Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.
	Priority            *int                                         `json:"priority,omitempty"`
	TenantSurchargeType string                                       `json:"tenantSurchargeType"`
	Type                InterFacilityConnectionTransferSurchargeType `json:"type"`
}

InterFacilityConnectionTransferRelativeSurcharge InterFacilityConnectionTransferRelativeSurcharge

type InterFacilityConnectionTransferSurchargeType added in v0.8.0

type InterFacilityConnectionTransferSurchargeType string

InterFacilityConnectionTransferSurchargeType InterFacilityConnectionTransferSurchargeType

const (
	ABSOLUTESURCHARGETYPE  InterFacilityConnectionTransferSurchargeType = "ABSOLUTE_SURCHARGE_TYPE"
	RELATIVESURCHARGETYPE  InterFacilityConnectionTransferSurchargeType = "RELATIVE_SURCHARGE_TYPE"
	THRESHOLDSURCHARGETYPE InterFacilityConnectionTransferSurchargeType = "THRESHOLD_SURCHARGE_TYPE"
)

Defines values for InterFacilityConnectionTransferSurchargeType.

func (InterFacilityConnectionTransferSurchargeType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the InterFacilityConnectionTransferSurchargeType enum.

type InterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

type InterFacilityConnectionTransferThresholdSurcharge struct {
	// CalculationScope The charges a percentage is calculated against: exactly the referenced ones, or the charged price without them. A reference that matches nothing contributes nothing.
	CalculationScope *InterFacilityConnectionSurchargeCalculationScope `json:"calculationScope,omitempty"`
	Context          *[]InterFacilityConnectionSurchargeContext        `json:"context,omitempty"`

	// MinimumAmount InterFacilityConnectionsMoney
	MinimumAmount InterFacilityConnectionsMoney `json:"minimumAmount"`
	Percentage    float32                       `json:"percentage"`

	// Priority Places the surcharge in the transfer's application sequence, which all surcharge types share. Ascending; gaps are allowed. If no surcharge of a transfer declares one, every percentage is calculated on the base price and the packaging units together.
	Priority            *int                                         `json:"priority,omitempty"`
	TenantSurchargeType string                                       `json:"tenantSurchargeType"`
	Type                InterFacilityConnectionTransferSurchargeType `json:"type"`
}

InterFacilityConnectionTransferThresholdSurcharge A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.

type InterFacilityConnectionWeightBasis added in v0.9.0

type InterFacilityConnectionWeightBasis string

InterFacilityConnectionWeightBasis The article weight the aggregated weight of the transfer is calculated from: WEIGHT (weightPerUnit) or BILLABLE_WEIGHT (billableWeightPerUnit). Defaults to WEIGHT.

const (
	BILLABLEWEIGHT InterFacilityConnectionWeightBasis = "BILLABLE_WEIGHT"
	WEIGHT         InterFacilityConnectionWeightBasis = "WEIGHT"
)

Defines values for InterFacilityConnectionWeightBasis.

func (InterFacilityConnectionWeightBasis) Valid added in v0.9.0

Valid indicates whether the value is a known member of the InterFacilityConnectionWeightBasis enum.

type InterFacilityConnection_SurchargesPerTransfer_Item added in v0.8.0

type InterFacilityConnection_SurchargesPerTransfer_Item struct {
	// contains filtered or unexported fields
}

InterFacilityConnection_SurchargesPerTransfer_Item defines model for InterFacilityConnection.surchargesPerTransfer.Item.

func (InterFacilityConnection_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

func (t InterFacilityConnection_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferAbsoluteSurcharge() (InterFacilityConnectionTransferAbsoluteSurcharge, error)

AsInterFacilityConnectionTransferAbsoluteSurcharge returns the union data inside the InterFacilityConnection_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferAbsoluteSurcharge

func (InterFacilityConnection_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

func (t InterFacilityConnection_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferRelativeSurcharge() (InterFacilityConnectionTransferRelativeSurcharge, error)

AsInterFacilityConnectionTransferRelativeSurcharge returns the union data inside the InterFacilityConnection_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferRelativeSurcharge

func (InterFacilityConnection_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

func (t InterFacilityConnection_SurchargesPerTransfer_Item) AsInterFacilityConnectionTransferThresholdSurcharge() (InterFacilityConnectionTransferThresholdSurcharge, error)

AsInterFacilityConnectionTransferThresholdSurcharge returns the union data inside the InterFacilityConnection_SurchargesPerTransfer_Item as a InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnection_SurchargesPerTransfer_Item) Discriminator added in v0.8.0

func (*InterFacilityConnection_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

func (t *InterFacilityConnection_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferAbsoluteSurcharge(v InterFacilityConnectionTransferAbsoluteSurcharge) error

FromInterFacilityConnectionTransferAbsoluteSurcharge overwrites any union data inside the InterFacilityConnection_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnection_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

func (t *InterFacilityConnection_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferRelativeSurcharge(v InterFacilityConnectionTransferRelativeSurcharge) error

FromInterFacilityConnectionTransferRelativeSurcharge overwrites any union data inside the InterFacilityConnection_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnection_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

func (t *InterFacilityConnection_SurchargesPerTransfer_Item) FromInterFacilityConnectionTransferThresholdSurcharge(v InterFacilityConnectionTransferThresholdSurcharge) error

FromInterFacilityConnectionTransferThresholdSurcharge overwrites any union data inside the InterFacilityConnection_SurchargesPerTransfer_Item as the provided InterFacilityConnectionTransferThresholdSurcharge

func (InterFacilityConnection_SurchargesPerTransfer_Item) MarshalJSON added in v0.8.0

func (*InterFacilityConnection_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferAbsoluteSurcharge added in v0.8.0

func (t *InterFacilityConnection_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferAbsoluteSurcharge(v InterFacilityConnectionTransferAbsoluteSurcharge) error

MergeInterFacilityConnectionTransferAbsoluteSurcharge performs a merge with any union data inside the InterFacilityConnection_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferAbsoluteSurcharge

func (*InterFacilityConnection_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferRelativeSurcharge added in v0.8.0

func (t *InterFacilityConnection_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferRelativeSurcharge(v InterFacilityConnectionTransferRelativeSurcharge) error

MergeInterFacilityConnectionTransferRelativeSurcharge performs a merge with any union data inside the InterFacilityConnection_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferRelativeSurcharge

func (*InterFacilityConnection_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferThresholdSurcharge added in v0.8.0

func (t *InterFacilityConnection_SurchargesPerTransfer_Item) MergeInterFacilityConnectionTransferThresholdSurcharge(v InterFacilityConnectionTransferThresholdSurcharge) error

MergeInterFacilityConnectionTransferThresholdSurcharge performs a merge with any union data inside the InterFacilityConnection_SurchargesPerTransfer_Item, using the provided InterFacilityConnectionTransferThresholdSurcharge

func (*InterFacilityConnection_SurchargesPerTransfer_Item) UnmarshalJSON added in v0.8.0

func (InterFacilityConnection_SurchargesPerTransfer_Item) ValueByDiscriminator added in v0.8.0

func (t InterFacilityConnection_SurchargesPerTransfer_Item) ValueByDiscriminator() (interface{}, error)

type InterFacilityConnection_Target added in v0.8.0

type InterFacilityConnection_Target struct {
	// contains filtered or unexported fields
}

InterFacilityConnection_Target defines model for InterFacilityConnection.Target.

func (InterFacilityConnection_Target) AsInterFacilityConnectionCustomerTarget added in v0.8.0

func (t InterFacilityConnection_Target) AsInterFacilityConnectionCustomerTarget() (InterFacilityConnectionCustomerTarget, error)

AsInterFacilityConnectionCustomerTarget returns the union data inside the InterFacilityConnection_Target as a InterFacilityConnectionCustomerTarget

func (InterFacilityConnection_Target) AsInterFacilityConnectionManagedFacilityTarget added in v0.8.0

func (t InterFacilityConnection_Target) AsInterFacilityConnectionManagedFacilityTarget() (InterFacilityConnectionManagedFacilityTarget, error)

AsInterFacilityConnectionManagedFacilityTarget returns the union data inside the InterFacilityConnection_Target as a InterFacilityConnectionManagedFacilityTarget

func (InterFacilityConnection_Target) AsInterFacilityConnectionSupplierTarget added in v0.8.0

func (t InterFacilityConnection_Target) AsInterFacilityConnectionSupplierTarget() (InterFacilityConnectionSupplierTarget, error)

AsInterFacilityConnectionSupplierTarget returns the union data inside the InterFacilityConnection_Target as a InterFacilityConnectionSupplierTarget

func (InterFacilityConnection_Target) Discriminator added in v0.8.0

func (t InterFacilityConnection_Target) Discriminator() (string, error)

func (*InterFacilityConnection_Target) FromInterFacilityConnectionCustomerTarget added in v0.8.0

func (t *InterFacilityConnection_Target) FromInterFacilityConnectionCustomerTarget(v InterFacilityConnectionCustomerTarget) error

FromInterFacilityConnectionCustomerTarget overwrites any union data inside the InterFacilityConnection_Target as the provided InterFacilityConnectionCustomerTarget

func (*InterFacilityConnection_Target) FromInterFacilityConnectionManagedFacilityTarget added in v0.8.0

func (t *InterFacilityConnection_Target) FromInterFacilityConnectionManagedFacilityTarget(v InterFacilityConnectionManagedFacilityTarget) error

FromInterFacilityConnectionManagedFacilityTarget overwrites any union data inside the InterFacilityConnection_Target as the provided InterFacilityConnectionManagedFacilityTarget

func (*InterFacilityConnection_Target) FromInterFacilityConnectionSupplierTarget added in v0.8.0

func (t *InterFacilityConnection_Target) FromInterFacilityConnectionSupplierTarget(v InterFacilityConnectionSupplierTarget) error

FromInterFacilityConnectionSupplierTarget overwrites any union data inside the InterFacilityConnection_Target as the provided InterFacilityConnectionSupplierTarget

func (InterFacilityConnection_Target) MarshalJSON added in v0.8.0

func (t InterFacilityConnection_Target) MarshalJSON() ([]byte, error)

func (*InterFacilityConnection_Target) MergeInterFacilityConnectionCustomerTarget added in v0.8.0

func (t *InterFacilityConnection_Target) MergeInterFacilityConnectionCustomerTarget(v InterFacilityConnectionCustomerTarget) error

MergeInterFacilityConnectionCustomerTarget performs a merge with any union data inside the InterFacilityConnection_Target, using the provided InterFacilityConnectionCustomerTarget

func (*InterFacilityConnection_Target) MergeInterFacilityConnectionManagedFacilityTarget added in v0.8.0

func (t *InterFacilityConnection_Target) MergeInterFacilityConnectionManagedFacilityTarget(v InterFacilityConnectionManagedFacilityTarget) error

MergeInterFacilityConnectionManagedFacilityTarget performs a merge with any union data inside the InterFacilityConnection_Target, using the provided InterFacilityConnectionManagedFacilityTarget

func (*InterFacilityConnection_Target) MergeInterFacilityConnectionSupplierTarget added in v0.8.0

func (t *InterFacilityConnection_Target) MergeInterFacilityConnectionSupplierTarget(v InterFacilityConnectionSupplierTarget) error

MergeInterFacilityConnectionSupplierTarget performs a merge with any union data inside the InterFacilityConnection_Target, using the provided InterFacilityConnectionSupplierTarget

func (*InterFacilityConnection_Target) UnmarshalJSON added in v0.8.0

func (t *InterFacilityConnection_Target) UnmarshalJSON(b []byte) error

func (InterFacilityConnection_Target) ValueByDiscriminator added in v0.8.0

func (t InterFacilityConnection_Target) ValueByDiscriminator() (interface{}, error)

type InterFacilityConnections

type InterFacilityConnections struct {
	InterFacilityConnections []InterFacilityConnection `json:"interFacilityConnections"`

	// Total Total number of entities found for this query
	//
	// Example: 42
	Total int `json:"total"`
}

InterFacilityConnections InterFacilityConnections

type InterFacilityConnectionsMoney added in v0.8.0

type InterFacilityConnectionsMoney struct {
	// Currency The currency code is a three-letter code that represents a currency in the ISO 4217 standard.
	Currency CurrencyCode `json:"currency"`

	// DecimalPlaces Number of decimal places for the given currency
	//
	// Example: 2
	DecimalPlaces *int `json:"decimalPlaces,omitempty"`

	// Value Value in the smallest subunit of the given currency, e.g. cents.
	Value int `json:"value"`
}

InterFacilityConnectionsMoney InterFacilityConnectionsMoney

type InventoryArticle

type InventoryArticle struct {
	Attributes      *[]ListingAttributeItem `json:"attributes,omitempty"`
	ImageUrl        string                  `json:"imageUrl"`
	TenantArticleId string                  `json:"tenantArticleId"`
	Title           string                  `json:"title"`

	// TitleLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`
}

InventoryArticle InventoryArticle

type InventoryArticlePaginatedResult

type InventoryArticlePaginatedResult struct {
	Articles []InventoryArticle `json:"articles"`

	// PageInfo PageInfo
	PageInfo PageInfo `json:"pageInfo"`
	Total    float32  `json:"total"`
}

InventoryArticlePaginatedResult InventoryArticlePaginatedResult

type InventoryOutOfStockConfigRestock

type InventoryOutOfStockConfigRestock struct {
	RestockableInDays float32 `json:"restockableInDays"`
}

InventoryOutOfStockConfigRestock InventoryOutOfStockConfigRestock

type KeyExistsFilter

type KeyExistsFilter struct {
	// Exists Search all entities which have or do not have this key defined
	Exists *bool `json:"exists,omitempty"`
}

KeyExistsFilter KeyExistsFilter

type LabelSearchQuery added in v0.5.0

type LabelSearchQuery struct {
	And *[]LabelSearchQuery `json:"and,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter         `json:"lastModified,omitempty"`
	Or           *[]LabelSearchQuery `json:"or,omitempty"`

	// ProcessRef Search by processRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	ProcessRef *StringFilter `json:"processRef,omitempty"`

	// TenantLabelId Search by tenantLabelId
	//
	// Example: MY_LABEL_ID
	TenantLabelId *StringFilter `json:"tenantLabelId,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringFilter `json:"tenantOrderId,omitempty"`
}

LabelSearchQuery LabelSearchQuery

type LinkedConfiguration

type LinkedConfiguration struct {
	Ref *string `json:"ref,omitempty"`
	Rel *string `json:"rel,omitempty"`
}

LinkedConfiguration LinkedConfiguration

type LinkedServiceJobsSearchQuery

type LinkedServiceJobsSearchQuery struct {
	// AdditionalInformation Search by additionalInformation
	AdditionalInformation *StringListFilter               `json:"additionalInformation,omitempty"`
	And                   *[]LinkedServiceJobsSearchQuery `json:"and,omitempty"`

	// ArticleTitles Search by articleTitles
	ArticleTitles *StringListFilter `json:"articleTitles,omitempty"`

	// Channel Search by channel
	Channel *StringFilter `json:"channel,omitempty"`

	// ConsumerName Search by consumerName
	ConsumerName *StringSearchFilter `json:"consumerName,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// InvoiceAddress Search by invoiceAddress
	InvoiceAddress *StringSearchFilter `json:"invoiceAddress,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter `json:"lastModified,omitempty"`

	// LinkedServiceJobRef Search by linkedServiceJobRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	LinkedServiceJobRef *StringFilter                   `json:"linkedServiceJobRef,omitempty"`
	Or                  *[]LinkedServiceJobsSearchQuery `json:"or,omitempty"`

	// ServiceName Search by serviceName
	ServiceName *StringListFilter `json:"serviceName,omitempty"`

	// ShippingAddress Search by shippingAddress
	ShippingAddress *StringSearchFilter `json:"shippingAddress,omitempty"`

	// Status Search by status
	Status *StringFilter `json:"status,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringSearchFilter `json:"tenantOrderId,omitempty"`

	// UsersModificationHistory Nested list search by usersModificationHistory
	UsersModificationHistory *LinkedServiceJobsUsersModificationHistoryListFilter `json:"usersModificationHistory,omitempty"`
}

LinkedServiceJobsSearchQuery LinkedServiceJobsSearchQuery

type LinkedServiceJobsUsersModificationHistoryFilter

type LinkedServiceJobsUsersModificationHistoryFilter struct {
	// Username Search by username
	Username *StringFilter `json:"username,omitempty"`
}

LinkedServiceJobsUsersModificationHistoryFilter LinkedServiceJobsUsersModificationHistoryFilter

type LinkedServiceJobsUsersModificationHistoryListFilter

type LinkedServiceJobsUsersModificationHistoryListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *LinkedServiceJobsUsersModificationHistoryFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

LinkedServiceJobsUsersModificationHistoryListFilter LinkedServiceJobsUsersModificationHistoryListFilter

type ListFacilityCarriersResponse

type ListFacilityCarriersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StrippedCarriers
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseListFacilityCarriersResponse

func ParseListFacilityCarriersResponse(rsp *http.Response) (*ListFacilityCarriersResponse, error)

ParseListFacilityCarriersResponse parses an HTTP response from a ListFacilityCarriersWithResponse call

func (ListFacilityCarriersResponse) ContentType

func (r ListFacilityCarriersResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListFacilityCarriersResponse) GetBody added in v0.8.0

func (r ListFacilityCarriersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListFacilityCarriersResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListFacilityCarriersResponse) GetJSON401 added in v0.8.0

func (r ListFacilityCarriersResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListFacilityCarriersResponse) GetJSON403 added in v0.8.0

func (r ListFacilityCarriersResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListFacilityCarriersResponse) Status

Status returns HTTPResponse.Status

func (ListFacilityCarriersResponse) StatusCode

func (r ListFacilityCarriersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Listing

type Listing struct {
	Attributes *[]ListingAttributeItem `json:"attributes,omitempty"`

	// AvailabilityTimeframe AvailabilityTimeframe
	AvailabilityTimeframe *AvailabilityTimeframe `json:"availabilityTimeframe,omitempty"`

	// CategoryRefs References to categories the listing belongs to.
	CategoryRefs *[]string `json:"categoryRefs,omitempty"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// Currency This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).
	//
	// Example: EUR
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Currency *CurrencyCode `json:"currency,omitempty"`

	// CustomAttributes Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// FacilityId This is a reference to a facility
	//
	// Example: 4711
	FacilityId string `json:"facilityId"`

	// Id Example: fsfdsf87fsd
	Id string `json:"id"`

	// ImageUrl A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!
	ImageUrl *string `json:"imageUrl,omitempty"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Legal ListingLegal
	Legal *ListingLegal `json:"legal,omitempty"`

	// MeasurementUnitKey Identifier for items unit of measurement.
	//
	// Example: liter
	MeasurementUnitKey *string `json:"measurementUnitKey,omitempty"`

	// OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.
	// Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviour *OutOfStockBehaviour `json:"outOfStockBehaviour,omitempty"`

	// OutOfStockBehaviourByContexts The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviourByContexts *[]OutOfStockBehaviourByContext `json:"outOfStockBehaviourByContexts,omitempty"`

	// OutOfStockConfig OutOfStockConfig
	OutOfStockConfig *OutOfStockConfig `json:"outOfStockConfig,omitempty"`

	// PartialStocks This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PartialStocks *[]PartialStock `json:"partialStocks,omitempty"`

	// Price This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
	//
	// Example: 1200
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Price *float32 `json:"price,omitempty"`

	// RecordableAttributes Customizable information about the lineItem that can be set during the process.
	RecordableAttributes *[]ListingRecordableAttribute `json:"recordableAttributes,omitempty"`
	ScannableCodes       *[]string                     `json:"scannableCodes,omitempty"`

	// ScanningRule Configuration to show the client how the items should be scanned during picking
	ScanningRule *ScanningRuleConfiguration `json:"scanningRule,omitempty"`
	Status       ListingStatus              `json:"status"`

	// StockAvailableUntil AvailableUntilDefinition
	StockAvailableUntil *AvailableUntilDefinition           `json:"stockAvailableUntil,omitempty"`
	StockProperties     *map[string]StockPropertyDefinition `json:"stockProperties,omitempty"`

	// Stockinformation @deprecated This object is deprecated since 11th of September 2023.
	Stockinformation *StockInformation `json:"stockinformation,omitempty"`
	Tags             *[]TagReference   `json:"tags,omitempty"`

	// TenantArticleId This is a reference to an article Id
	//
	// Example: 4711
	TenantArticleId string `json:"tenantArticleId"`

	// Title a title describing the article
	//
	// Example: Adidas Superstar
	Title *string `json:"title,omitempty"`

	// TitleLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`

	// Weight This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Weight *float32 `json:"weight,omitempty"`
}

Listing Listing

type ListingAttributeItem

type ListingAttributeItem struct {
	// Category This category is used by fulfillmenttools to customize implemented processes.
	// Categorized attributes are used by various processes and tools
	// throughout fulfillmenttools. For a complete list of possible categories
	// and their correct use, refer to the documentation.
	// Default value: miscellaneous
	Category *ListingAttributeItemCategory `json:"category,omitempty"`

	// Context Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints.
	Context *ArticleAttributeItemContext `json:"context,omitempty"`

	// Key Providing the key %%subtitle%% (see example) here will cause the
	// value to appear, for example, in the App.
	// With all other attributes also the key will be displayed in the
	//  clients.
	//
	// Example: %%subtitle%%
	Key ListingAttributeItem_Key `json:"key"`

	// KeyLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	KeyLocalized *LocaleString `json:"keyLocalized,omitempty"`

	// Priority This value gives the priority in the respective attribute category.
	// The lower the value the higher is the priority, for example, priority 1 is
	// higher than priority 10. Attributes that have the highest priority
	// might be selected for display in different articles of fulfillmenttools. Default
	// value is 1001. For details please contact the product owners.
	//
	// Example: 100
	Priority *int64 `json:"priority,omitempty"`

	// Type The type of the attribute.
	//
	// Example: STRING
	Type *ListingAttributeItemType `json:"type,omitempty"`

	// Value Example: 585er Gold
	Value string `json:"value"`

	// ValueLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	ValueLocalized *LocaleString `json:"valueLocalized,omitempty"`
}

ListingAttributeItem ListingAttributeItem

type ListingAttributeItemCategory added in v0.8.0

type ListingAttributeItemCategory string

ListingAttributeItemCategory This category is used by fulfillmenttools to customize implemented processes. Categorized attributes are used by various processes and tools throughout fulfillmenttools. For a complete list of possible categories and their correct use, refer to the documentation. Default value: miscellaneous

const (
	ListingAttributeItemCategoryBasePrice               ListingAttributeItemCategory = "basePrice"
	ListingAttributeItemCategoryCarrierService          ListingAttributeItemCategory = "carrierService"
	ListingAttributeItemCategoryCustoms                 ListingAttributeItemCategory = "customs"
	ListingAttributeItemCategoryDescriptive             ListingAttributeItemCategory = "descriptive"
	ListingAttributeItemCategoryDimensions              ListingAttributeItemCategory = "dimensions"
	ListingAttributeItemCategoryDiscount                ListingAttributeItemCategory = "discount"
	ListingAttributeItemCategoryFinalLineItemPrice      ListingAttributeItemCategory = "finalLineItemPrice"
	ListingAttributeItemCategoryFinalUnitPrice          ListingAttributeItemCategory = "finalUnitPrice"
	ListingAttributeItemCategoryInsurance               ListingAttributeItemCategory = "insurance"
	ListingAttributeItemCategoryMiscellaneous           ListingAttributeItemCategory = "miscellaneous"
	ListingAttributeItemCategoryPickingSequence         ListingAttributeItemCategory = "pickingSequence"
	ListingAttributeItemCategorySalesPrice              ListingAttributeItemCategory = "salesPrice"
	ListingAttributeItemCategoryShop                    ListingAttributeItemCategory = "shop"
	ListingAttributeItemCategorySubtotalAfterDiscounts  ListingAttributeItemCategory = "subtotalAfterDiscounts"
	ListingAttributeItemCategorySubtotalBeforeDiscounts ListingAttributeItemCategory = "subtotalBeforeDiscounts"
	ListingAttributeItemCategorySurcharge               ListingAttributeItemCategory = "surcharge"
	ListingAttributeItemCategoryTax                     ListingAttributeItemCategory = "tax"
)

Defines values for ListingAttributeItemCategory.

func (ListingAttributeItemCategory) Valid added in v0.8.0

Valid indicates whether the value is a known member of the ListingAttributeItemCategory enum.

type ListingAttributeItemKey0 added in v0.9.0

type ListingAttributeItemKey0 = string

ListingAttributeItemKey0 defines model for ListingAttributeItem.Key.0.

type ListingAttributeItemKey1 added in v0.9.0

type ListingAttributeItemKey1 = interface{}

ListingAttributeItemKey1 defines model for ListingAttributeItem.Key.1.

type ListingAttributeItemType added in v0.8.0

type ListingAttributeItemType string

ListingAttributeItemType The type of the attribute.

Example: STRING

const (
	ListingAttributeItemTypeBOOLEAN  ListingAttributeItemType = "BOOLEAN"
	ListingAttributeItemTypeCURRENCY ListingAttributeItemType = "CURRENCY"
	ListingAttributeItemTypeNUMBER   ListingAttributeItemType = "NUMBER"
	ListingAttributeItemTypeSTRING   ListingAttributeItemType = "STRING"
)

Defines values for ListingAttributeItemType.

func (ListingAttributeItemType) Valid added in v0.8.0

func (e ListingAttributeItemType) Valid() bool

Valid indicates whether the value is a known member of the ListingAttributeItemType enum.

type ListingAttributeItem_Key added in v0.9.0

type ListingAttributeItem_Key struct {
	// contains filtered or unexported fields
}

ListingAttributeItem_Key Providing the key %%subtitle%% (see example) here will cause the value to appear, for example, in the App. With all other attributes also the key will be displayed in the

clients.

Example: %%subtitle%%

func (ListingAttributeItem_Key) AsListingAttributeItemKey0 added in v0.9.0

func (t ListingAttributeItem_Key) AsListingAttributeItemKey0() (ListingAttributeItemKey0, error)

AsListingAttributeItemKey0 returns the union data inside the ListingAttributeItem_Key as a ListingAttributeItemKey0

func (ListingAttributeItem_Key) AsListingAttributeItemKey1 added in v0.9.0

func (t ListingAttributeItem_Key) AsListingAttributeItemKey1() (ListingAttributeItemKey1, error)

AsListingAttributeItemKey1 returns the union data inside the ListingAttributeItem_Key as a ListingAttributeItemKey1

func (*ListingAttributeItem_Key) FromListingAttributeItemKey0 added in v0.9.0

func (t *ListingAttributeItem_Key) FromListingAttributeItemKey0(v ListingAttributeItemKey0) error

FromListingAttributeItemKey0 overwrites any union data inside the ListingAttributeItem_Key as the provided ListingAttributeItemKey0

func (*ListingAttributeItem_Key) FromListingAttributeItemKey1 added in v0.9.0

func (t *ListingAttributeItem_Key) FromListingAttributeItemKey1(v ListingAttributeItemKey1) error

FromListingAttributeItemKey1 overwrites any union data inside the ListingAttributeItem_Key as the provided ListingAttributeItemKey1

func (ListingAttributeItem_Key) MarshalJSON added in v0.9.0

func (t ListingAttributeItem_Key) MarshalJSON() ([]byte, error)

func (*ListingAttributeItem_Key) MergeListingAttributeItemKey0 added in v0.9.0

func (t *ListingAttributeItem_Key) MergeListingAttributeItemKey0(v ListingAttributeItemKey0) error

MergeListingAttributeItemKey0 performs a merge with any union data inside the ListingAttributeItem_Key, using the provided ListingAttributeItemKey0

func (*ListingAttributeItem_Key) MergeListingAttributeItemKey1 added in v0.9.0

func (t *ListingAttributeItem_Key) MergeListingAttributeItemKey1(v ListingAttributeItemKey1) error

MergeListingAttributeItemKey1 performs a merge with any union data inside the ListingAttributeItem_Key, using the provided ListingAttributeItemKey1

func (*ListingAttributeItem_Key) UnmarshalJSON added in v0.9.0

func (t *ListingAttributeItem_Key) UnmarshalJSON(b []byte) error

type ListingAvailabilityTimeframeFilter

type ListingAvailabilityTimeframeFilter struct {
	// Start Search by start
	Start *DateFilter `json:"start,omitempty"`
}

ListingAvailabilityTimeframeFilter ListingAvailabilityTimeframeFilter

type ListingBulkOperationResult

type ListingBulkOperationResult struct {
	// Listing Listing
	Listing Listing `json:"listing"`

	// Status BulkOperationResultStatus
	Status BulkOperationResultStatus `json:"status"`
}

ListingBulkOperationResult ListingBulkOperationResult

type ListingBulkUpsertPayload

type ListingBulkUpsertPayload struct {
	// Listings List of listings to be upserted in bulk. Number of entries times selectors must not exceed 25.
	Listings []ListingBulkUpsertPayload_Listings_Item `json:"listings"`
}

ListingBulkUpsertPayload ListingBulkUpsertPayload

type ListingBulkUpsertPayload_Listings_Item

type ListingBulkUpsertPayload_Listings_Item struct {
	// contains filtered or unexported fields
}

ListingBulkUpsertPayload_Listings_Item defines model for ListingBulkUpsertPayload.listings.Item.

func (ListingBulkUpsertPayload_Listings_Item) AsListingForBulkUpsertByFacility

func (t ListingBulkUpsertPayload_Listings_Item) AsListingForBulkUpsertByFacility() (ListingForBulkUpsertByFacility, error)

AsListingForBulkUpsertByFacility returns the union data inside the ListingBulkUpsertPayload_Listings_Item as a ListingForBulkUpsertByFacility

func (ListingBulkUpsertPayload_Listings_Item) AsListingForBulkUpsertBySelector

func (t ListingBulkUpsertPayload_Listings_Item) AsListingForBulkUpsertBySelector() (ListingForBulkUpsertBySelector, error)

AsListingForBulkUpsertBySelector returns the union data inside the ListingBulkUpsertPayload_Listings_Item as a ListingForBulkUpsertBySelector

func (ListingBulkUpsertPayload_Listings_Item) Discriminator

func (*ListingBulkUpsertPayload_Listings_Item) FromListingForBulkUpsertByFacility

func (t *ListingBulkUpsertPayload_Listings_Item) FromListingForBulkUpsertByFacility(v ListingForBulkUpsertByFacility) error

FromListingForBulkUpsertByFacility overwrites any union data inside the ListingBulkUpsertPayload_Listings_Item as the provided ListingForBulkUpsertByFacility

func (*ListingBulkUpsertPayload_Listings_Item) FromListingForBulkUpsertBySelector

func (t *ListingBulkUpsertPayload_Listings_Item) FromListingForBulkUpsertBySelector(v ListingForBulkUpsertBySelector) error

FromListingForBulkUpsertBySelector overwrites any union data inside the ListingBulkUpsertPayload_Listings_Item as the provided ListingForBulkUpsertBySelector

func (ListingBulkUpsertPayload_Listings_Item) MarshalJSON

func (t ListingBulkUpsertPayload_Listings_Item) MarshalJSON() ([]byte, error)

func (*ListingBulkUpsertPayload_Listings_Item) MergeListingForBulkUpsertByFacility

func (t *ListingBulkUpsertPayload_Listings_Item) MergeListingForBulkUpsertByFacility(v ListingForBulkUpsertByFacility) error

MergeListingForBulkUpsertByFacility performs a merge with any union data inside the ListingBulkUpsertPayload_Listings_Item, using the provided ListingForBulkUpsertByFacility

func (*ListingBulkUpsertPayload_Listings_Item) MergeListingForBulkUpsertBySelector

func (t *ListingBulkUpsertPayload_Listings_Item) MergeListingForBulkUpsertBySelector(v ListingForBulkUpsertBySelector) error

MergeListingForBulkUpsertBySelector performs a merge with any union data inside the ListingBulkUpsertPayload_Listings_Item, using the provided ListingForBulkUpsertBySelector

func (*ListingBulkUpsertPayload_Listings_Item) UnmarshalJSON

func (t *ListingBulkUpsertPayload_Listings_Item) UnmarshalJSON(b []byte) error

func (ListingBulkUpsertPayload_Listings_Item) ValueByDiscriminator

func (t ListingBulkUpsertPayload_Listings_Item) ValueByDiscriminator() (interface{}, error)

type ListingBulkUpsertResponse

type ListingBulkUpsertResponse struct {
	// Listings Listings upsert operations that were successfully upserted.
	Listings []ListingBulkUpsertSuccess `json:"listings"`

	// Summary Summary of the operations.
	Summary BulkUpsertSummary `json:"summary"`
}

ListingBulkUpsertResponse ListingBulkUpsertResponse

type ListingBulkUpsertSuccess

type ListingBulkUpsertSuccess struct {
	// Result The resulting entity.
	Result Listing `json:"result"`

	// Status Indicates whether the operation created or updated the entity.
	Status ListingBulkUpsertSuccessStatus `json:"status"`
}

ListingBulkUpsertSuccess ListingBulkUpsertSuccess

type ListingBulkUpsertSuccessStatus

type ListingBulkUpsertSuccessStatus string

ListingBulkUpsertSuccessStatus Indicates whether the operation created or updated the entity.

const (
	ListingBulkUpsertSuccessStatusCREATED   ListingBulkUpsertSuccessStatus = "CREATED"
	ListingBulkUpsertSuccessStatusUNCHANGED ListingBulkUpsertSuccessStatus = "UNCHANGED"
	ListingBulkUpsertSuccessStatusUPDATED   ListingBulkUpsertSuccessStatus = "UPDATED"
)

Defines values for ListingBulkUpsertSuccessStatus.

func (ListingBulkUpsertSuccessStatus) Valid

Valid indicates whether the value is a known member of the ListingBulkUpsertSuccessStatus enum.

type ListingFacilitySelector

type ListingFacilitySelector struct {
	// Facility Selector for the facility. Either a facility reference or a tenant facility ID must be provided.
	Facility ListingFacilitySelector_Facility `json:"facility"`

	// Version Optional version of the facility. Must be provided for existing facilities. Leave empty for new facilities.
	//
	// Example: 1
	Version *float32 `json:"version,omitempty"`
}

ListingFacilitySelector ListingFacilitySelector

type ListingFacilitySelector_Facility

type ListingFacilitySelector_Facility struct {
	// contains filtered or unexported fields
}

ListingFacilitySelector_Facility Selector for the facility. Either a facility reference or a tenant facility ID must be provided.

func (ListingFacilitySelector_Facility) AsFacilityRefSelector

func (t ListingFacilitySelector_Facility) AsFacilityRefSelector() (FacilityRefSelector, error)

AsFacilityRefSelector returns the union data inside the ListingFacilitySelector_Facility as a FacilityRefSelector

func (ListingFacilitySelector_Facility) AsTenantFacilityIdSelector

func (t ListingFacilitySelector_Facility) AsTenantFacilityIdSelector() (TenantFacilityIdSelector, error)

AsTenantFacilityIdSelector returns the union data inside the ListingFacilitySelector_Facility as a TenantFacilityIdSelector

func (*ListingFacilitySelector_Facility) FromFacilityRefSelector

func (t *ListingFacilitySelector_Facility) FromFacilityRefSelector(v FacilityRefSelector) error

FromFacilityRefSelector overwrites any union data inside the ListingFacilitySelector_Facility as the provided FacilityRefSelector

func (*ListingFacilitySelector_Facility) FromTenantFacilityIdSelector

func (t *ListingFacilitySelector_Facility) FromTenantFacilityIdSelector(v TenantFacilityIdSelector) error

FromTenantFacilityIdSelector overwrites any union data inside the ListingFacilitySelector_Facility as the provided TenantFacilityIdSelector

func (ListingFacilitySelector_Facility) MarshalJSON

func (t ListingFacilitySelector_Facility) MarshalJSON() ([]byte, error)

func (*ListingFacilitySelector_Facility) MergeFacilityRefSelector

func (t *ListingFacilitySelector_Facility) MergeFacilityRefSelector(v FacilityRefSelector) error

MergeFacilityRefSelector performs a merge with any union data inside the ListingFacilitySelector_Facility, using the provided FacilityRefSelector

func (*ListingFacilitySelector_Facility) MergeTenantFacilityIdSelector

func (t *ListingFacilitySelector_Facility) MergeTenantFacilityIdSelector(v TenantFacilityIdSelector) error

MergeTenantFacilityIdSelector performs a merge with any union data inside the ListingFacilitySelector_Facility, using the provided TenantFacilityIdSelector

func (*ListingFacilitySelector_Facility) UnmarshalJSON

func (t *ListingFacilitySelector_Facility) UnmarshalJSON(b []byte) error

type ListingForBulkUpsertByFacility

type ListingForBulkUpsertByFacility struct {
	Attributes *[]ListingAttributeItem `json:"attributes,omitempty"`

	// CategoryRefs References to categories the listing belongs to.
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	CategoryRefs *[]string `json:"categoryRefs,omitempty"`

	// Currency Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
	//
	// Example: EUR
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Currency *CurrencyCode `json:"currency,omitempty"`

	// CustomAttributes Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Facility Selector for the facility. Either a facility reference or a tenant facility ID must be provided.
	Facility ListingForBulkUpsertByFacility_Facility `json:"facility"`

	// ImageUrl A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!
	//
	// Example: https://example.com/resource
	ImageUrl *string `json:"imageUrl,omitempty"`

	// Legal ListingLegal
	Legal *ListingLegal `json:"legal,omitempty"`

	// MeasurementUnitKey Identifier for items unit of measurement.
	//
	// Example: liter
	MeasurementUnitKey *string `json:"measurementUnitKey,omitempty"`

	// OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.
	// Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviour *OutOfStockBehaviour `json:"outOfStockBehaviour,omitempty"`

	// OutOfStockBehaviourByContexts The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br/>
	OutOfStockBehaviourByContexts *[]OutOfStockBehaviourByContext2 `json:"outOfStockBehaviourByContexts,omitempty"`

	// OutOfStockConfig The outOfStockConfig is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br/>
	OutOfStockConfig *OutOfStockConfig2 `json:"outOfStockConfig,omitempty"`

	// Price Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
	//
	// Example: 1200
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Price *float32 `json:"price,omitempty"`

	// ScannableCodes Codes, that identify the article
	ScannableCodes *[]string `json:"scannableCodes,omitempty"`

	// ScanningRule Configuration to show the client how the items should be scanned during picking
	ScanningRule *ScanningRuleConfiguration            `json:"scanningRule,omitempty"`
	Status       *ListingForBulkUpsertByFacilityStatus `json:"status,omitempty"`

	// StockAvailableUntil AvailableUntilDefinition
	StockAvailableUntil *AvailableUntilDefinition `json:"stockAvailableUntil,omitempty"`

	// StockProperties Key-value pairs for stock properties of the requested items. Must be a subset of the listings defined stockProperties
	StockProperties *map[string]StockPropertyDefinition `json:"stockProperties,omitempty"`
	Tags            *[]TagReference                     `json:"tags,omitempty"`

	// TargetingStrategy Targeting strategy for this bulk upsert entry - determines how target facilities are specified.
	//
	// Example: SINGLE_FACILITY
	TargetingStrategy ListingForBulkUpsertByFacilityTargetingStrategy `json:"targetingStrategy"`

	// TenantArticleId This is a reference to an article Id
	//
	// Example: 4711
	TenantArticleId string `json:"tenantArticleId"`

	// Title a title describing the article
	//
	// Example: Adidas Superstar
	Title string `json:"title"`

	// TitleLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Version Optional version of the facility. Must be provided for existing facilities.
	//
	// Example: 1
	Version *float32 `json:"version,omitempty"`

	// Weight Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
	//
	// Example: 42
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Weight *float32 `json:"weight,omitempty"`
}

ListingForBulkUpsertByFacility ListingForBulkUpsertByFacility

type ListingForBulkUpsertByFacilityStatus

type ListingForBulkUpsertByFacilityStatus string

ListingForBulkUpsertByFacilityStatus defines model for ListingForBulkUpsertByFacility.Status.

const (
	ListingForBulkUpsertByFacilityStatusACTIVE   ListingForBulkUpsertByFacilityStatus = "ACTIVE"
	ListingForBulkUpsertByFacilityStatusINACTIVE ListingForBulkUpsertByFacilityStatus = "INACTIVE"
)

Defines values for ListingForBulkUpsertByFacilityStatus.

func (ListingForBulkUpsertByFacilityStatus) Valid

Valid indicates whether the value is a known member of the ListingForBulkUpsertByFacilityStatus enum.

type ListingForBulkUpsertByFacilityTargetingStrategy

type ListingForBulkUpsertByFacilityTargetingStrategy string

ListingForBulkUpsertByFacilityTargetingStrategy Targeting strategy for this bulk upsert entry - determines how target facilities are specified.

Example: SINGLE_FACILITY

const (
	ListingForBulkUpsertByFacilityTargetingStrategyMULTISELECTOR  ListingForBulkUpsertByFacilityTargetingStrategy = "MULTI_SELECTOR"
	ListingForBulkUpsertByFacilityTargetingStrategySINGLEFACILITY ListingForBulkUpsertByFacilityTargetingStrategy = "SINGLE_FACILITY"
)

Defines values for ListingForBulkUpsertByFacilityTargetingStrategy.

func (ListingForBulkUpsertByFacilityTargetingStrategy) Valid

Valid indicates whether the value is a known member of the ListingForBulkUpsertByFacilityTargetingStrategy enum.

type ListingForBulkUpsertByFacility_Facility

type ListingForBulkUpsertByFacility_Facility struct {
	// contains filtered or unexported fields
}

ListingForBulkUpsertByFacility_Facility Selector for the facility. Either a facility reference or a tenant facility ID must be provided.

func (ListingForBulkUpsertByFacility_Facility) AsFacilityRefSelector

AsFacilityRefSelector returns the union data inside the ListingForBulkUpsertByFacility_Facility as a FacilityRefSelector

func (ListingForBulkUpsertByFacility_Facility) AsTenantFacilityIdSelector

AsTenantFacilityIdSelector returns the union data inside the ListingForBulkUpsertByFacility_Facility as a TenantFacilityIdSelector

func (*ListingForBulkUpsertByFacility_Facility) FromFacilityRefSelector

FromFacilityRefSelector overwrites any union data inside the ListingForBulkUpsertByFacility_Facility as the provided FacilityRefSelector

func (*ListingForBulkUpsertByFacility_Facility) FromTenantFacilityIdSelector

func (t *ListingForBulkUpsertByFacility_Facility) FromTenantFacilityIdSelector(v TenantFacilityIdSelector) error

FromTenantFacilityIdSelector overwrites any union data inside the ListingForBulkUpsertByFacility_Facility as the provided TenantFacilityIdSelector

func (ListingForBulkUpsertByFacility_Facility) MarshalJSON

func (t ListingForBulkUpsertByFacility_Facility) MarshalJSON() ([]byte, error)

func (*ListingForBulkUpsertByFacility_Facility) MergeFacilityRefSelector

func (t *ListingForBulkUpsertByFacility_Facility) MergeFacilityRefSelector(v FacilityRefSelector) error

MergeFacilityRefSelector performs a merge with any union data inside the ListingForBulkUpsertByFacility_Facility, using the provided FacilityRefSelector

func (*ListingForBulkUpsertByFacility_Facility) MergeTenantFacilityIdSelector

func (t *ListingForBulkUpsertByFacility_Facility) MergeTenantFacilityIdSelector(v TenantFacilityIdSelector) error

MergeTenantFacilityIdSelector performs a merge with any union data inside the ListingForBulkUpsertByFacility_Facility, using the provided TenantFacilityIdSelector

func (*ListingForBulkUpsertByFacility_Facility) UnmarshalJSON

func (t *ListingForBulkUpsertByFacility_Facility) UnmarshalJSON(b []byte) error

type ListingForBulkUpsertBySelector

type ListingForBulkUpsertBySelector struct {
	Attributes *[]ListingAttributeItem `json:"attributes,omitempty"`

	// CategoryRefs References to categories the listing belongs to.
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	CategoryRefs *[]string `json:"categoryRefs,omitempty"`

	// Currency Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
	//
	// Example: EUR
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Currency *CurrencyCode `json:"currency,omitempty"`

	// CustomAttributes Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// ImageUrl A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!
	//
	// Example: https://example.com/resource
	ImageUrl *string `json:"imageUrl,omitempty"`

	// Legal ListingLegal
	Legal *ListingLegal `json:"legal,omitempty"`

	// MeasurementUnitKey Identifier for items unit of measurement.
	//
	// Example: liter
	MeasurementUnitKey *string `json:"measurementUnitKey,omitempty"`

	// OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.
	// Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviour *OutOfStockBehaviour `json:"outOfStockBehaviour,omitempty"`

	// OutOfStockBehaviourByContexts The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br/>
	OutOfStockBehaviourByContexts *[]OutOfStockBehaviourByContext2 `json:"outOfStockBehaviourByContexts,omitempty"`

	// OutOfStockConfig The outOfStockConfig is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br/>
	OutOfStockConfig *OutOfStockConfig2 `json:"outOfStockConfig,omitempty"`

	// Price Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
	//
	// Example: 1200
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Price *float32 `json:"price,omitempty"`

	// ScannableCodes Codes, that identify the article
	ScannableCodes *[]string `json:"scannableCodes,omitempty"`

	// ScanningRule Configuration to show the client how the items should be scanned during picking
	ScanningRule *ScanningRuleConfiguration `json:"scanningRule,omitempty"`

	// Selector Facility selectors for bulk operations. Add one or more selectors to specify the facilities for the listings.
	Selector []ListingFacilitySelector             `json:"selector"`
	Status   *ListingForBulkUpsertBySelectorStatus `json:"status,omitempty"`

	// StockAvailableUntil AvailableUntilDefinition
	StockAvailableUntil *AvailableUntilDefinition `json:"stockAvailableUntil,omitempty"`

	// StockProperties Key-value pairs for stock properties of the requested items. Must be a subset of the listings defined stockProperties
	StockProperties *map[string]StockPropertyDefinition `json:"stockProperties,omitempty"`
	Tags            *[]TagReference                     `json:"tags,omitempty"`

	// TargetingStrategy Targeting strategy for this bulk upsert entry - determines how target facilities are specified.
	//
	// Example: MULTI_SELECTOR
	TargetingStrategy ListingForBulkUpsertBySelectorTargetingStrategy `json:"targetingStrategy"`

	// TenantArticleId This is a reference to an article Id
	//
	// Example: 4711
	TenantArticleId string `json:"tenantArticleId"`

	// Title a title describing the article
	//
	// Example: Adidas Superstar
	Title string `json:"title"`

	// TitleLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Weight Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
	//
	// Example: 42
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Weight *float32 `json:"weight,omitempty"`
}

ListingForBulkUpsertBySelector ListingForBulkUpsertBySelector

type ListingForBulkUpsertBySelectorStatus

type ListingForBulkUpsertBySelectorStatus string

ListingForBulkUpsertBySelectorStatus defines model for ListingForBulkUpsertBySelector.Status.

const (
	ListingForBulkUpsertBySelectorStatusACTIVE   ListingForBulkUpsertBySelectorStatus = "ACTIVE"
	ListingForBulkUpsertBySelectorStatusINACTIVE ListingForBulkUpsertBySelectorStatus = "INACTIVE"
)

Defines values for ListingForBulkUpsertBySelectorStatus.

func (ListingForBulkUpsertBySelectorStatus) Valid

Valid indicates whether the value is a known member of the ListingForBulkUpsertBySelectorStatus enum.

type ListingForBulkUpsertBySelectorTargetingStrategy

type ListingForBulkUpsertBySelectorTargetingStrategy string

ListingForBulkUpsertBySelectorTargetingStrategy Targeting strategy for this bulk upsert entry - determines how target facilities are specified.

Example: MULTI_SELECTOR

const (
	ListingForBulkUpsertBySelectorTargetingStrategyMULTISELECTOR  ListingForBulkUpsertBySelectorTargetingStrategy = "MULTI_SELECTOR"
	ListingForBulkUpsertBySelectorTargetingStrategySINGLEFACILITY ListingForBulkUpsertBySelectorTargetingStrategy = "SINGLE_FACILITY"
)

Defines values for ListingForBulkUpsertBySelectorTargetingStrategy.

func (ListingForBulkUpsertBySelectorTargetingStrategy) Valid

Valid indicates whether the value is a known member of the ListingForBulkUpsertBySelectorTargetingStrategy enum.

type ListingForCreation

type ListingForCreation struct {
	Attributes *[]ListingAttributeItem `json:"attributes,omitempty"`

	// AvailabilityTimeframe AvailabilityTimeframe
	AvailabilityTimeframe *AvailabilityTimeframe `json:"availabilityTimeframe,omitempty"`

	// CategoryRefs References to categories the listing belongs to.
	CategoryRefs *[]string `json:"categoryRefs,omitempty"`

	// Currency This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).
	//
	// Example: EUR
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Currency *CurrencyCode `json:"currency,omitempty"`

	// CustomAttributes Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// ImageUrl A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!
	ImageUrl *string `json:"imageUrl,omitempty"`

	// Legal ListingLegal
	Legal *ListingLegal `json:"legal,omitempty"`

	// MeasurementUnitKey Identifier for items unit of measurement.
	//
	// Example: liter
	MeasurementUnitKey *string `json:"measurementUnitKey,omitempty"`

	// OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.
	// Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviour *OutOfStockBehaviour `json:"outOfStockBehaviour,omitempty"`

	// OutOfStockBehaviourByContexts The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviourByContexts *[]OutOfStockBehaviourByContext `json:"outOfStockBehaviourByContexts,omitempty"`

	// OutOfStockConfig OutOfStockConfig
	OutOfStockConfig *OutOfStockConfig `json:"outOfStockConfig,omitempty"`

	// PartialStocks This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.
	// Use /api/stocks endpoints instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PartialStocks *[]PartialStockForCreation `json:"partialStocks,omitempty"`

	// Price This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
	//
	// Example: 1200
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Price *float32 `json:"price,omitempty"`

	// RecordableAttributes Customizable information about the lineItem that can be set during the process.
	RecordableAttributes *[]ListingRecordableAttributeForCreation `json:"recordableAttributes,omitempty"`
	ScannableCodes       *[]string                                `json:"scannableCodes,omitempty"`

	// ScanningRule Configuration to show the client how the items should be scanned during picking
	ScanningRule *ScanningRuleConfiguration `json:"scanningRule,omitempty"`

	// StockAvailableUntil AvailableUntilDefinition
	StockAvailableUntil *AvailableUntilDefinition           `json:"stockAvailableUntil,omitempty"`
	StockProperties     *map[string]StockPropertyDefinition `json:"stockProperties,omitempty"`

	// Stockinformation @deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Stockinformation *StockInformationForCreation `json:"stockinformation,omitempty"`
	Tags             *[]TagReference              `json:"tags,omitempty"`

	// TenantArticleId This is a reference to an article Id
	//
	// Example: 4711
	TenantArticleId string `json:"tenantArticleId"`

	// Title a title describing the article
	//
	// Example: Adidas Superstar
	Title *string `json:"title,omitempty"`

	// TitleLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Weight This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Weight *float32 `json:"weight,omitempty"`
}

ListingForCreation ListingForCreation

type ListingForReplacement

type ListingForReplacement struct {
	Attributes *[]ListingAttributeItem `json:"attributes,omitempty"`

	// AvailabilityTimeframe AvailabilityTimeframe
	AvailabilityTimeframe *AvailabilityTimeframe `json:"availabilityTimeframe,omitempty"`

	// CategoryRefs References to categories the listing belongs to.
	CategoryRefs *[]string `json:"categoryRefs,omitempty"`

	// Currency This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).
	//
	// Example: EUR
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Currency *CurrencyCode `json:"currency,omitempty"`

	// CustomAttributes Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// ImageUrl A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!
	ImageUrl *string `json:"imageUrl,omitempty"`

	// Legal ListingLegal
	Legal *ListingLegal `json:"legal,omitempty"`

	// MeasurementUnitKey Identifier for items unit of measurement.
	//
	// Example: liter
	MeasurementUnitKey *string `json:"measurementUnitKey,omitempty"`

	// OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.
	// Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviour *OutOfStockBehaviour `json:"outOfStockBehaviour,omitempty"`

	// OutOfStockBehaviourByContexts The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviourByContexts *[]OutOfStockBehaviourByContext `json:"outOfStockBehaviourByContexts,omitempty"`

	// OutOfStockConfig OutOfStockConfig
	OutOfStockConfig *OutOfStockConfig `json:"outOfStockConfig,omitempty"`

	// PartialStocks This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.
	// Use /api/stocks endpoints instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	PartialStocks *[]PartialStockForCreation `json:"partialStocks,omitempty"`

	// Price This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
	//
	// Example: 1200
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Price *float32 `json:"price,omitempty"`

	// RecordableAttributes Customizable information about the lineItem that can be set during the process.
	RecordableAttributes *[]ListingRecordableAttributeForCreation `json:"recordableAttributes,omitempty"`
	ScannableCodes       *[]string                                `json:"scannableCodes,omitempty"`

	// ScanningRule Configuration to show the client how the items should be scanned during picking
	ScanningRule *ScanningRuleConfiguration   `json:"scanningRule,omitempty"`
	Status       *ListingForReplacementStatus `json:"status,omitempty"`

	// StockAvailableUntil AvailableUntilDefinition
	StockAvailableUntil *AvailableUntilDefinition           `json:"stockAvailableUntil,omitempty"`
	StockProperties     *map[string]StockPropertyDefinition `json:"stockProperties,omitempty"`

	// Stockinformation @deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Stockinformation *StockInformationForCreation `json:"stockinformation,omitempty"`
	Tags             *[]TagReference              `json:"tags,omitempty"`

	// TenantArticleId This is a reference to an article Id
	//
	// Example: 4711
	TenantArticleId string `json:"tenantArticleId"`

	// Title a title describing the article
	//
	// Example: Adidas Superstar
	Title *string `json:"title,omitempty"`

	// TitleLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Version Example: 42
	Version *int64 `json:"version,omitempty"`

	// Weight This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Weight *float32 `json:"weight,omitempty"`
}

ListingForReplacement ListingForReplacement

type ListingForReplacementStatus added in v0.8.0

type ListingForReplacementStatus string

ListingForReplacementStatus defines model for ListingForReplacement.Status.

const (
	ListingForReplacementStatusACTIVE   ListingForReplacementStatus = "ACTIVE"
	ListingForReplacementStatusINACTIVE ListingForReplacementStatus = "INACTIVE"
)

Defines values for ListingForReplacementStatus.

func (ListingForReplacementStatus) Valid added in v0.8.0

Valid indicates whether the value is a known member of the ListingForReplacementStatus enum.

type ListingLegal

type ListingLegal struct {
	HsCode *string `json:"hsCode,omitempty"`
}

ListingLegal ListingLegal

type ListingOutOfStockBehaviourEnumFilter

type ListingOutOfStockBehaviourEnumFilter struct {
	// Eq Search by outOfStockBehaviour
	Eq *ListingOutOfStockBehaviourEnumFilterEq `json:"eq,omitempty"`

	// In Search by outOfStockBehaviour
	In *[]ListingOutOfStockBehaviourEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by outOfStockBehaviour
	NotEq *ListingOutOfStockBehaviourEnumFilterNotEq `json:"notEq,omitempty"`
}

ListingOutOfStockBehaviourEnumFilter ListingOutOfStockBehaviourEnumFilter

type ListingOutOfStockBehaviourEnumFilterEq

type ListingOutOfStockBehaviourEnumFilterEq string

ListingOutOfStockBehaviourEnumFilterEq Search by outOfStockBehaviour

const (
	ListingOutOfStockBehaviourEnumFilterEqBACKORDER          ListingOutOfStockBehaviourEnumFilterEq = "BACKORDER"
	ListingOutOfStockBehaviourEnumFilterEqNONE               ListingOutOfStockBehaviourEnumFilterEq = "NONE"
	ListingOutOfStockBehaviourEnumFilterEqPREORDER           ListingOutOfStockBehaviourEnumFilterEq = "PREORDER"
	ListingOutOfStockBehaviourEnumFilterEqPREORDERANDRESTOCK ListingOutOfStockBehaviourEnumFilterEq = "PREORDER_AND_RESTOCK"
	ListingOutOfStockBehaviourEnumFilterEqRESTOCK            ListingOutOfStockBehaviourEnumFilterEq = "RESTOCK"
)

Defines values for ListingOutOfStockBehaviourEnumFilterEq.

func (ListingOutOfStockBehaviourEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ListingOutOfStockBehaviourEnumFilterEq enum.

type ListingOutOfStockBehaviourEnumFilterIn

type ListingOutOfStockBehaviourEnumFilterIn string

ListingOutOfStockBehaviourEnumFilterIn defines model for ListingOutOfStockBehaviourEnumFilter.In.

const (
	ListingOutOfStockBehaviourEnumFilterInBACKORDER          ListingOutOfStockBehaviourEnumFilterIn = "BACKORDER"
	ListingOutOfStockBehaviourEnumFilterInNONE               ListingOutOfStockBehaviourEnumFilterIn = "NONE"
	ListingOutOfStockBehaviourEnumFilterInPREORDER           ListingOutOfStockBehaviourEnumFilterIn = "PREORDER"
	ListingOutOfStockBehaviourEnumFilterInPREORDERANDRESTOCK ListingOutOfStockBehaviourEnumFilterIn = "PREORDER_AND_RESTOCK"
	ListingOutOfStockBehaviourEnumFilterInRESTOCK            ListingOutOfStockBehaviourEnumFilterIn = "RESTOCK"
)

Defines values for ListingOutOfStockBehaviourEnumFilterIn.

func (ListingOutOfStockBehaviourEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ListingOutOfStockBehaviourEnumFilterIn enum.

type ListingOutOfStockBehaviourEnumFilterNotEq

type ListingOutOfStockBehaviourEnumFilterNotEq string

ListingOutOfStockBehaviourEnumFilterNotEq Search by outOfStockBehaviour

const (
	ListingOutOfStockBehaviourEnumFilterNotEqBACKORDER          ListingOutOfStockBehaviourEnumFilterNotEq = "BACKORDER"
	ListingOutOfStockBehaviourEnumFilterNotEqNONE               ListingOutOfStockBehaviourEnumFilterNotEq = "NONE"
	ListingOutOfStockBehaviourEnumFilterNotEqPREORDER           ListingOutOfStockBehaviourEnumFilterNotEq = "PREORDER"
	ListingOutOfStockBehaviourEnumFilterNotEqPREORDERANDRESTOCK ListingOutOfStockBehaviourEnumFilterNotEq = "PREORDER_AND_RESTOCK"
	ListingOutOfStockBehaviourEnumFilterNotEqRESTOCK            ListingOutOfStockBehaviourEnumFilterNotEq = "RESTOCK"
)

Defines values for ListingOutOfStockBehaviourEnumFilterNotEq.

func (ListingOutOfStockBehaviourEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ListingOutOfStockBehaviourEnumFilterNotEq enum.

type ListingPaginatedResult

type ListingPaginatedResult struct {
	Listings []Listing `json:"listings"`

	// PageInfo Pagination information for the search result.
	PageInfo PageInfo `json:"pageInfo"`

	// Total The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
	Total *float32 `json:"total,omitempty"`
}

ListingPaginatedResult ListingPaginatedResult

type ListingPatchActions

type ListingPatchActions struct {
	Actions []ModifyListing `json:"actions"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

ListingPatchActions ListingPatchActions

type ListingRecordableAttribute

type ListingRecordableAttribute struct {
	// Key Calculated value from keyLocalized based on passed locale
	//
	// Example: Serialnumber
	Key *string `json:"key,omitempty"`

	// KeyLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	KeyLocalized LocaleString `json:"keyLocalized"`

	// RecordingRule Indicates whether the value has to be recorded or not
	//
	// Example: MANDATORY
	RecordingRule ListingRecordableAttributeRecordingRule `json:"recordingRule"`
	Validations   *[]RecordableAttributeValidation        `json:"validations,omitempty"`

	// Value The value of the attribute
	//
	// Example: Germany
	Value *string `json:"value,omitempty"`
}

ListingRecordableAttribute ListingRecordableAttribute

type ListingRecordableAttributeForCreation

type ListingRecordableAttributeForCreation struct {
	// KeyLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	KeyLocalized LocaleString `json:"keyLocalized"`

	// RecordingRule Indicates whether the value has to be recorded or not
	//
	// Example: MANDATORY
	RecordingRule ListingRecordableAttributeForCreationRecordingRule `json:"recordingRule"`
	Validations   *[]RecordableAttributeValidation                   `json:"validations,omitempty"`

	// Value The value of the attribute
	//
	// Example: Germany
	Value *string `json:"value,omitempty"`
}

ListingRecordableAttributeForCreation ListingRecordableAttributeForCreation

type ListingRecordableAttributeForCreationRecordingRule

type ListingRecordableAttributeForCreationRecordingRule string

ListingRecordableAttributeForCreationRecordingRule Indicates whether the value has to be recorded or not

Example: MANDATORY

const (
	ListingRecordableAttributeForCreationRecordingRuleMANDATORY ListingRecordableAttributeForCreationRecordingRule = "MANDATORY"
	ListingRecordableAttributeForCreationRecordingRuleOPTIONAL  ListingRecordableAttributeForCreationRecordingRule = "OPTIONAL"
)

Defines values for ListingRecordableAttributeForCreationRecordingRule.

func (ListingRecordableAttributeForCreationRecordingRule) Valid

Valid indicates whether the value is a known member of the ListingRecordableAttributeForCreationRecordingRule enum.

type ListingRecordableAttributeRecordingRule

type ListingRecordableAttributeRecordingRule string

ListingRecordableAttributeRecordingRule Indicates whether the value has to be recorded or not

Example: MANDATORY

const (
	ListingRecordableAttributeRecordingRuleMANDATORY ListingRecordableAttributeRecordingRule = "MANDATORY"
	ListingRecordableAttributeRecordingRuleOPTIONAL  ListingRecordableAttributeRecordingRule = "OPTIONAL"
)

Defines values for ListingRecordableAttributeRecordingRule.

func (ListingRecordableAttributeRecordingRule) Valid

Valid indicates whether the value is a known member of the ListingRecordableAttributeRecordingRule enum.

type ListingSearchPayload

type ListingSearchPayload struct {
	// After 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`.
	After *string `json:"after,omitempty"`

	// Before 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).
	Before *string `json:"before,omitempty"`

	// Last Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
	Last *float32 `json:"last,omitempty"`

	// Options SearchOptions
	Options *SearchOptions `json:"options,omitempty"`

	// Query ListingSearchQuery
	Query ListingSearchQuery `json:"query"`

	// Size Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
	//
	// Example: 10
	Size *float32 `json:"size,omitempty"`

	// Sort Use for sorting the result.
	Sort *[]ListingSort `json:"sort,omitempty"`

	// StartAfterId The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	StartAfterId *string `json:"startAfterId,omitempty"`
}

ListingSearchPayload ListingSearchPayload

type ListingSearchQuery

type ListingSearchQuery struct {
	And *[]ListingSearchQuery `json:"and,omitempty"`

	// AvailabilityTimeframe Nested search by availabilityTimeframe
	//
	// Example: 2026-06-17T12:00:00.000Z
	AvailabilityTimeframe *ListingAvailabilityTimeframeFilter `json:"availabilityTimeframe,omitempty"`

	// CategoryRefs Search by categoryRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	CategoryRefs *StringListFilter `json:"categoryRefs,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]ListingSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// MeasurementUnitKey Search by measurementUnitKey
	MeasurementUnitKey *StringFilter         `json:"measurementUnitKey,omitempty"`
	Or                 *[]ListingSearchQuery `json:"or,omitempty"`

	// OutOfStockBehaviour Search by outOfStockBehaviour
	OutOfStockBehaviour *ListingOutOfStockBehaviourEnumFilter `json:"outOfStockBehaviour,omitempty"`

	// Price Search by price
	Price *NumberFilter `json:"price,omitempty"`

	// ScannableCodes Search by scannableCodes
	ScannableCodes *StringListFilter `json:"scannableCodes,omitempty"`

	// Status Search by status
	Status *ListingStatusEnumEnumFilter `json:"status,omitempty"`

	// Tags Nested list search by tags
	Tags *ListingTagsListFilter `json:"tags,omitempty"`

	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`

	// Weight Search by weight
	Weight *NumberFilter `json:"weight,omitempty"`
}

ListingSearchQuery ListingSearchQuery

type ListingSearchQuery_CustomAttributes_AdditionalProperties

type ListingSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

ListingSearchQuery_CustomAttributes_AdditionalProperties defines model for ListingSearchQuery.customAttributes.AdditionalProperties.

func (ListingSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (ListingSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (ListingSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (ListingSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*ListingSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*ListingSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*ListingSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*ListingSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (ListingSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*ListingSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*ListingSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*ListingSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*ListingSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the ListingSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*ListingSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type ListingSort

type ListingSort struct {
	CustomAttributes *map[string]interface{}     `json:"customAttributes,omitempty"`
	LastModified     *ListingSortLastModified    `json:"lastModified,omitempty"`
	TenantArticleId  *ListingSortTenantArticleId `json:"tenantArticleId,omitempty"`
}

ListingSort ListingSort

type ListingSortLastModified

type ListingSortLastModified string

ListingSortLastModified defines model for ListingSort.LastModified.

const (
	ListingSortLastModifiedASC  ListingSortLastModified = "ASC"
	ListingSortLastModifiedDESC ListingSortLastModified = "DESC"
)

Defines values for ListingSortLastModified.

func (ListingSortLastModified) Valid

func (e ListingSortLastModified) Valid() bool

Valid indicates whether the value is a known member of the ListingSortLastModified enum.

type ListingSortTenantArticleId

type ListingSortTenantArticleId string

ListingSortTenantArticleId defines model for ListingSort.TenantArticleId.

const (
	ListingSortTenantArticleIdASC  ListingSortTenantArticleId = "ASC"
	ListingSortTenantArticleIdDESC ListingSortTenantArticleId = "DESC"
)

Defines values for ListingSortTenantArticleId.

func (ListingSortTenantArticleId) Valid

func (e ListingSortTenantArticleId) Valid() bool

Valid indicates whether the value is a known member of the ListingSortTenantArticleId enum.

type ListingStatus

type ListingStatus string

ListingStatus defines model for Listing.Status.

const (
	ListingStatusACTIVE   ListingStatus = "ACTIVE"
	ListingStatusINACTIVE ListingStatus = "INACTIVE"
)

Defines values for ListingStatus.

func (ListingStatus) Valid

func (e ListingStatus) Valid() bool

Valid indicates whether the value is a known member of the ListingStatus enum.

type ListingStatusEnumEnumFilter

type ListingStatusEnumEnumFilter struct {
	// Eq Search by status
	Eq *ListingStatusEnumEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ListingStatusEnumEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ListingStatusEnumEnumFilterNotEq `json:"notEq,omitempty"`
}

ListingStatusEnumEnumFilter ListingStatusEnumEnumFilter

type ListingStatusEnumEnumFilterEq

type ListingStatusEnumEnumFilterEq string

ListingStatusEnumEnumFilterEq Search by status

const (
	ListingStatusEnumEnumFilterEqACTIVE   ListingStatusEnumEnumFilterEq = "ACTIVE"
	ListingStatusEnumEnumFilterEqINACTIVE ListingStatusEnumEnumFilterEq = "INACTIVE"
)

Defines values for ListingStatusEnumEnumFilterEq.

func (ListingStatusEnumEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ListingStatusEnumEnumFilterEq enum.

type ListingStatusEnumEnumFilterIn

type ListingStatusEnumEnumFilterIn string

ListingStatusEnumEnumFilterIn defines model for ListingStatusEnumEnumFilter.In.

const (
	ListingStatusEnumEnumFilterInACTIVE   ListingStatusEnumEnumFilterIn = "ACTIVE"
	ListingStatusEnumEnumFilterInINACTIVE ListingStatusEnumEnumFilterIn = "INACTIVE"
)

Defines values for ListingStatusEnumEnumFilterIn.

func (ListingStatusEnumEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ListingStatusEnumEnumFilterIn enum.

type ListingStatusEnumEnumFilterNotEq

type ListingStatusEnumEnumFilterNotEq string

ListingStatusEnumEnumFilterNotEq Search by status

const (
	ListingStatusEnumEnumFilterNotEqACTIVE   ListingStatusEnumEnumFilterNotEq = "ACTIVE"
	ListingStatusEnumEnumFilterNotEqINACTIVE ListingStatusEnumEnumFilterNotEq = "INACTIVE"
)

Defines values for ListingStatusEnumEnumFilterNotEq.

func (ListingStatusEnumEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ListingStatusEnumEnumFilterNotEq enum.

type ListingTagsFilter

type ListingTagsFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Value Search by value
	Value *StringFilter `json:"value,omitempty"`
}

ListingTagsFilter ListingTagsFilter

type ListingTagsListFilter

type ListingTagsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *ListingTagsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

ListingTagsListFilter ListingTagsListFilter

type ListingsForReplacement

type ListingsForReplacement struct {
	Listings []ListingForReplacement `json:"listings"`
}

ListingsForReplacement ListingsForReplacement

type LocaleString

type LocaleString map[string]string

LocaleString Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization

Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}

type LocalizedStringSearchFilter

type LocalizedStringSearchFilter struct {
	Eq *string   `json:"eq,omitempty"`
	In *[]string `json:"in,omitempty"`

	// Like Search by regex pattern
	Like  *string   `json:"like,omitempty"`
	NotEq *string   `json:"notEq,omitempty"`
	NotIn *[]string `json:"notIn,omitempty"`
}

LocalizedStringSearchFilter LocalizedStringSearchFilter

type Location

type Location struct {
	// LocationRef The id of the location
	LocationRef *string `json:"locationRef,omitempty"`

	// ScannableCodes Represents barcodes that may be scanned at this location
	ScannableCodes *[]string `json:"scannableCodes,omitempty"`
}

Location Location

type LookupRecordItemSearchQuery

type LookupRecordItemSearchQuery struct {
	And *[]LookupRecordItemSearchQuery `json:"and,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter                  `json:"id,omitempty"`
	Or *[]LookupRecordItemSearchQuery `json:"or,omitempty"`

	// RecordRef Search by recordRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	RecordRef *StringFilter `json:"recordRef,omitempty"`

	// TenantRecordId Search by tenantRecordId
	//
	// Example: MY_RECORD_ID
	TenantRecordId *StringFilter `json:"tenantRecordId,omitempty"`

	// Values Nested list search by values
	Values *LookupRecordItemValuesListFilter `json:"values,omitempty"`
}

LookupRecordItemSearchQuery LookupRecordItemSearchQuery

type LookupRecordItemValuesFilter

type LookupRecordItemValuesFilter struct {
	// AttributeId Search by attributeId
	AttributeId *StringFilter `json:"attributeId,omitempty"`

	// AttributeValue Search by attributeValue
	AttributeValue *StringFilter `json:"attributeValue,omitempty"`
}

LookupRecordItemValuesFilter LookupRecordItemValuesFilter

type LookupRecordItemValuesListFilter

type LookupRecordItemValuesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *LookupRecordItemValuesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

LookupRecordItemValuesListFilter LookupRecordItemValuesListFilter

type ManagedFacility

type ManagedFacility struct {
	// Address FacilityAddress
	Address FacilityAddress        `json:"address"`
	Configs *[]LinkedConfiguration `json:"configs,omitempty"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Name Example: Hamburg NW2
	Name           string                              `json:"name"`
	OperativeCosts *[]FacilityOperativeCostForCreation `json:"operativeCosts,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status FacilityStatus  `json:"status"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type *FacilityType `json:"type,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

ManagedFacility ManagedFacility

type ManagedFacilityForCreation

type ManagedFacilityForCreation struct {
	// Address FacilityAddressForCreation
	Address FacilityAddressForCreation `json:"address"`

	// CapacityEnabled Indicates that configured capacity limits for picking times are considered
	CapacityEnabled *bool `json:"capacityEnabled,omitempty"`

	// CapacityPlanningTimeframe The range in days per facility which defines how many days in the future the capacity of the facility can be planned
	CapacityPlanningTimeframe *int `json:"capacityPlanningTimeframe,omitempty"`

	// ClosingDays Days of the year where the facility is closed and doesn't allows picking
	ClosingDays *[]ClosingDay `json:"closingDays,omitempty"`

	// Contact FacilityContact
	Contact *FacilityContact `json:"contact,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// FulfillmentProcessBuffer Duration in minutes until an order is processed
	//
	// Example: 240
	FulfillmentProcessBuffer *int `json:"fulfillmentProcessBuffer,omitempty"`

	// LocationType FacilityLocationType
	LocationType *FacilityLocationType `json:"locationType,omitempty"`

	// Name Example: Hamburg NW2
	Name           string                              `json:"name"`
	OperativeCosts *[]FacilityOperativeCostForCreation `json:"operativeCosts,omitempty"`

	// PickingMethods Picking Methods supported by this facility.
	PickingMethods *[]PickingMethodEnum `json:"pickingMethods,omitempty"`

	// PickingTimes Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day
	PickingTimes *PickingTimes `json:"pickingTimes,omitempty"`

	// ScanningRule Configuration to show the client how the items should be scanned during picking
	ScanningRule *ScanningRuleConfiguration `json:"scanningRule,omitempty"`
	Services     *[]FacilityService         `json:"services,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status *FacilityStatus `json:"status,omitempty"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type *FacilityType `json:"type,omitempty"`
}

ManagedFacilityForCreation ManagedFacilityForCreation

type ManagedFacilityForModification

type ManagedFacilityForModification struct {
	// Address FacilityAddressForCreation
	Address *FacilityAddressForCreation `json:"address,omitempty"`

	// CapacityEnabled Indicates that configured capacity limits for picking times are considered
	CapacityEnabled *bool `json:"capacityEnabled,omitempty"`

	// CapacityPlanningTimeframe The range in days per facility which defines how many days in the future the capacity of the facility can be planned
	CapacityPlanningTimeframe *int `json:"capacityPlanningTimeframe,omitempty"`

	// ClosingDays Days of the year where the facility is closed and doesn't allows picking
	ClosingDays *[]ClosingDay          `json:"closingDays,omitempty"`
	Configs     *[]LinkedConfiguration `json:"configs,omitempty"`
	Contact     *FacilityContact       `json:"contact,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// FulfillmentProcessBuffer Duration in minutes until an order is processed
	//
	// Example: 240
	FulfillmentProcessBuffer *int                  `json:"fulfillmentProcessBuffer,omitempty"`
	LocationType             *FacilityLocationType `json:"locationType,omitempty"`

	// Name Example: Hamburg NW2
	Name *string `json:"name,omitempty"`

	// PickingMethods Picking Methods supported by this facility.
	PickingMethods *[]PickingMethodEnum       `json:"pickingMethods,omitempty"`
	PickingTimes   *PickingTimes              `json:"pickingTimes,omitempty"`
	ScanningRule   *ScanningRuleConfiguration `json:"scanningRule,omitempty"`
	Services       *[]FacilityService         `json:"services,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status *FacilityStatus `json:"status,omitempty"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type FacilityType `json:"type"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

ManagedFacilityForModification ManagedFacilityForModification

type ManagedFacilityForReplacement

type ManagedFacilityForReplacement struct {
	// Address FacilityAddressForCreation
	Address FacilityAddressForCreation `json:"address"`

	// CapacityEnabled Indicates that configured capacity limits for picking times are considered
	CapacityEnabled bool `json:"capacityEnabled"`

	// CapacityPlanningTimeframe The range in days per facility which defines how many days in the future the capacity of the facility can be planned
	CapacityPlanningTimeframe *int `json:"capacityPlanningTimeframe,omitempty"`

	// ClosingDays Days of the year where the facility is closed and doesn't allows picking
	ClosingDays *[]ClosingDay          `json:"closingDays,omitempty"`
	Configs     *[]LinkedConfiguration `json:"configs,omitempty"`

	// Contact FacilityContact
	Contact *FacilityContact `json:"contact,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// FulfillmentProcessBuffer Duration in minutes until an order is processed
	//
	// Example: 240
	FulfillmentProcessBuffer int `json:"fulfillmentProcessBuffer"`

	// LocationType FacilityLocationType
	LocationType FacilityLocationType `json:"locationType"`

	// Name Example: Hamburg NW2
	Name string `json:"name"`

	// PickingMethods Picking Methods supported by this facility.
	PickingMethods *[]PickingMethodEnum `json:"pickingMethods,omitempty"`

	// PickingTimes Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day
	PickingTimes *PickingTimes `json:"pickingTimes,omitempty"`

	// ScanningRule Configuration to show the client how the items should be scanned during picking
	ScanningRule *ScanningRuleConfiguration `json:"scanningRule,omitempty"`
	Services     *[]FacilityService         `json:"services,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status FacilityStatus  `json:"status"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type FacilityType `json:"type"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

ManagedFacilityForReplacement ManagedFacilityForReplacement

type MeasurementValidation added in v0.2.0

type MeasurementValidation struct {
	// OverPickHardTolerancePercentage Allowed hard over pick deviation tolerance.
	//
	// Example: 20
	OverPickHardTolerancePercentage *float32 `json:"overPickHardTolerancePercentage,omitempty"`

	// OverPickSoftTolerancePercentage Allowed soft over pick deviation tolerance.
	//
	// Example: 15
	OverPickSoftTolerancePercentage *float32 `json:"overPickSoftTolerancePercentage,omitempty"`

	// ShortPickHardTolerancePercentage Allowed hard short pick deviation tolerance.
	//
	// Example: 15
	ShortPickHardTolerancePercentage *float32 `json:"shortPickHardTolerancePercentage,omitempty"`

	// ShortPickSoftTolerancePercentage Allowed soft short pick deviation tolerance.
	//
	// Example: 10
	ShortPickSoftTolerancePercentage *float32 `json:"shortPickSoftTolerancePercentage,omitempty"`
}

MeasurementValidation MeasurementValidation

type ModifyAddress

type ModifyAddress struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// City Example: Langenfeld
	City *string `json:"city,omitempty"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country *string `json:"country,omitempty"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber  *string `json:"houseNumber,omitempty"`
	PhoneNumbers *[]struct {
		// CustomAttributes Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
		CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

		// Label Can be used to give a description for the number, like "private", "business number", etc.
		Label *string                        `json:"label,omitempty"`
		Type  *ModifyAddressPhoneNumbersType `json:"type,omitempty"`

		// Value The number itself. We do not enforce any format (yet).
		Value *string `json:"value,omitempty"`
	} `json:"phoneNumbers,omitempty"`

	// PostalCode Example: 40764
	PostalCode *string `json:"postalCode,omitempty"`

	// Province Example: Nordrhein-Westfalen
	Province *string `json:"province,omitempty"`

	// ResolvedCoordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
	ResolvedCoordinates *Coordinates `json:"resolvedCoordinates,omitempty"`

	// Street Example: Hauptstr.
	Street *string `json:"street,omitempty"`
}

ModifyAddress ModifyAddress

type ModifyAddressPhoneNumbersType

type ModifyAddressPhoneNumbersType string

ModifyAddressPhoneNumbersType defines model for ModifyAddress.PhoneNumbers.Type.

const (
	ModifyAddressPhoneNumbersTypeMOBILE ModifyAddressPhoneNumbersType = "MOBILE"
	ModifyAddressPhoneNumbersTypePHONE  ModifyAddressPhoneNumbersType = "PHONE"
)

Defines values for ModifyAddressPhoneNumbersType.

func (ModifyAddressPhoneNumbersType) Valid

Valid indicates whether the value is a known member of the ModifyAddressPhoneNumbersType enum.

type ModifyFacility

type ModifyFacility struct {
	// Action Use value 'ModifyFacility', because you want to modify a facility
	Action ModifyFacilityAction `json:"action"`

	// Address ModifyFacilityAddress
	Address         *ModifyFacilityAddress `json:"address,omitempty"`
	CapacityEnabled *bool                  `json:"capacityEnabled,omitempty"`

	// CapacityPlanningTimeframe The range in days per facility which defines how many days in the future the capacity of the facility can be planned
	CapacityPlanningTimeframe *int `json:"capacityPlanningTimeframe,omitempty"`

	// ClosingDays Days of the year where the facility is closed and doesn't allows picking
	ClosingDays *[]ClosingDay `json:"closingDays,omitempty"`

	// Contact FacilityContact
	Contact *FacilityContact `json:"contact,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// FulfillmentProcessBuffer Duration in minutes until an order is processed
	//
	// Example: 240
	FulfillmentProcessBuffer *int `json:"fulfillmentProcessBuffer,omitempty"`

	// LocationType FacilityLocationType
	LocationType *FacilityLocationType `json:"locationType,omitempty"`

	// Name Example: Hamburg NW2
	Name           *string                             `json:"name,omitempty"`
	OperativeCosts *[]FacilityOperativeCostForCreation `json:"operativeCosts,omitempty"`

	// PickingMethods Picking Methods supported by this facility.
	PickingMethods *[]PickingMethodEnum `json:"pickingMethods,omitempty"`

	// PickingTimes Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day
	PickingTimes *PickingTimes `json:"pickingTimes,omitempty"`

	// ScanningRule Configuration to show the client how the items should be scanned during picking
	ScanningRule *ScanningRuleConfiguration `json:"scanningRule,omitempty"`
	Services     *[]struct {
		// Type The description of the service this facility offers.
		Type ModifyFacilityServicesType `json:"type"`
	} `json:"services,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status *ModifyFacilityStatus `json:"status,omitempty"`
	Tags   *[]TagReference       `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`
}

ModifyFacility ModifyFacility

type ModifyFacilityAction

type ModifyFacilityAction string

ModifyFacilityAction Use value 'ModifyFacility', because you want to modify a facility

const (
	ModifyFacilityActionModifyFacility ModifyFacilityAction = "ModifyFacility"
)

Defines values for ModifyFacilityAction.

func (ModifyFacilityAction) Valid

func (e ModifyFacilityAction) Valid() bool

Valid indicates whether the value is a known member of the ModifyFacilityAction enum.

type ModifyFacilityAddress

type ModifyFacilityAddress struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// City Example: Langenfeld
	City *string `json:"city,omitempty"`

	// CompanyName Example: Speedy Boxales Ltd.
	CompanyName *string `json:"companyName,omitempty"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country *string `json:"country,omitempty"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`
	EmailAddresses   *[]struct {
		// Recipient Human readable information who is the recipient for emails sent to this address.
		//
		// Example: 'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.
		Recipient *string             `json:"recipient,omitempty"`
		Value     openapi_types.Email `json:"value"`
	} `json:"emailAddresses,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber  *string `json:"houseNumber,omitempty"`
	PhoneNumbers *[]struct {
		// CustomAttributes Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
		CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

		// Label Can be used to give a description for the number, like "private", "business number", etc.
		Label *string                                `json:"label,omitempty"`
		Type  *ModifyFacilityAddressPhoneNumbersType `json:"type,omitempty"`

		// Value The number itself. We do not enforce any format (yet).
		Value *string `json:"value,omitempty"`
	} `json:"phoneNumbers,omitempty"`

	// PostalCode Example: 40764
	PostalCode *string `json:"postalCode,omitempty"`

	// Province Example: Nordrhein-Westfalen
	Province *string `json:"province,omitempty"`

	// ResolvedCoordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
	ResolvedCoordinates *Coordinates `json:"resolvedCoordinates,omitempty"`

	// Street Example: Hauptstr.
	Street *string `json:"street,omitempty"`
}

ModifyFacilityAddress ModifyFacilityAddress

type ModifyFacilityAddressPhoneNumbersType

type ModifyFacilityAddressPhoneNumbersType string

ModifyFacilityAddressPhoneNumbersType defines model for ModifyFacilityAddress.PhoneNumbers.Type.

const (
	ModifyFacilityAddressPhoneNumbersTypeMOBILE ModifyFacilityAddressPhoneNumbersType = "MOBILE"
	ModifyFacilityAddressPhoneNumbersTypePHONE  ModifyFacilityAddressPhoneNumbersType = "PHONE"
)

Defines values for ModifyFacilityAddressPhoneNumbersType.

func (ModifyFacilityAddressPhoneNumbersType) Valid

Valid indicates whether the value is a known member of the ModifyFacilityAddressPhoneNumbersType enum.

type ModifyFacilityServicesType

type ModifyFacilityServicesType string

ModifyFacilityServicesType The description of the service this facility offers.

const (
	ModifyFacilityServicesTypePICKUP        ModifyFacilityServicesType = "PICKUP"
	ModifyFacilityServicesTypeSHIPFROMSTORE ModifyFacilityServicesType = "SHIP_FROM_STORE"
)

Defines values for ModifyFacilityServicesType.

func (ModifyFacilityServicesType) Valid

func (e ModifyFacilityServicesType) Valid() bool

Valid indicates whether the value is a known member of the ModifyFacilityServicesType enum.

type ModifyFacilityStatus

type ModifyFacilityStatus string

ModifyFacilityStatus The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.

const (
	ModifyFacilityStatusOFFLINE   ModifyFacilityStatus = "OFFLINE"
	ModifyFacilityStatusONLINE    ModifyFacilityStatus = "ONLINE"
	ModifyFacilityStatusSUSPENDED ModifyFacilityStatus = "SUSPENDED"
)

Defines values for ModifyFacilityStatus.

func (ModifyFacilityStatus) Valid

func (e ModifyFacilityStatus) Valid() bool

Valid indicates whether the value is a known member of the ModifyFacilityStatus enum.

type ModifyListing

type ModifyListing struct {
	// Action Use value 'ModifyListing', because you want to modify a listing
	Action ModifyListingAction `json:"action"`

	// Attributes The attributes of this listing
	Attributes *[]ListingAttributeItem `json:"attributes,omitempty"`

	// AvailabilityTimeframe AvailabilityTimeframe
	AvailabilityTimeframe *AvailabilityTimeframe `json:"availabilityTimeframe,omitempty"`

	// CategoryRefs References to categories the listing belongs to.
	CategoryRefs *[]string `json:"categoryRefs,omitempty"`

	// Currency This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).
	//
	// Example: EUR
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Currency *CurrencyCode `json:"currency,omitempty"`

	// CustomAttributes Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// ImageUrl A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!
	ImageUrl *string `json:"imageUrl,omitempty"`

	// Legal ListingLegal
	Legal *ListingLegal `json:"legal,omitempty"`

	// MeasurementUnitKey Example: kg
	MeasurementUnitKey *string `json:"measurementUnitKey,omitempty"`

	// OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.
	// Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviour *OutOfStockBehaviour `json:"outOfStockBehaviour,omitempty"`

	// OutOfStockConfig OutOfStockConfig
	OutOfStockConfig *OutOfStockConfig `json:"outOfStockConfig,omitempty"`

	// Price This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
	//
	// Example: 1200
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Price *float32 `json:"price,omitempty"`

	// RecordableAttributes Customizable information about the lineItem that can be set during the process.
	RecordableAttributes *[]ListingRecordableAttributeForCreation `json:"recordableAttributes,omitempty"`
	ScannableCodes       *[]string                                `json:"scannableCodes,omitempty"`

	// ScanningRule Configuration to show the client how the items should be scanned during picking
	ScanningRule *ScanningRuleConfiguration `json:"scanningRule,omitempty"`

	// Status The status indicates if a listing is available or not
	Status *ModifyListingStatus `json:"status,omitempty"`

	// StockAvailableUntil AvailableUntilDefinition
	StockAvailableUntil *AvailableUntilDefinition           `json:"stockAvailableUntil,omitempty"`
	StockProperties     *map[string]StockPropertyDefinition `json:"stockProperties,omitempty"`

	// Stockinformation @deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Stockinformation *StockInformationForCreation `json:"stockinformation,omitempty"`

	// Subtitle a subtitle describing the article
	//
	// Example: 44 2/3
	Subtitle *string         `json:"subtitle,omitempty"`
	Tags     *[]TagReference `json:"tags,omitempty"`

	// Title a title describing the article
	//
	// Example: Adidas Superstar
	Title *string `json:"title,omitempty"`

	// TitleLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Weight This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Weight *float32 `json:"weight,omitempty"`
}

ModifyListing ModifyListing

type ModifyListingAction

type ModifyListingAction string

ModifyListingAction Use value 'ModifyListing', because you want to modify a listing

const (
	ModifyListingActionModifyListing ModifyListingAction = "ModifyListing"
)

Defines values for ModifyListingAction.

func (ModifyListingAction) Valid

func (e ModifyListingAction) Valid() bool

Valid indicates whether the value is a known member of the ModifyListingAction enum.

type ModifyListingStatus

type ModifyListingStatus string

ModifyListingStatus The status indicates if a listing is available or not

const (
	ModifyListingStatusACTIVE   ModifyListingStatus = "ACTIVE"
	ModifyListingStatusINACTIVE ModifyListingStatus = "INACTIVE"
)

Defines values for ModifyListingStatus.

func (ModifyListingStatus) Valid

func (e ModifyListingStatus) Valid() bool

Valid indicates whether the value is a known member of the ModifyListingStatus enum.

type ModifyMeAction

type ModifyMeAction struct {
	// Action The type of action to perform
	Action ModifyMeActionAction `json:"action"`

	// Firstname The new firstname of the user
	//
	// Example: Phil
	Firstname *string `json:"firstname,omitempty"`

	// Lastname The new lastname of the user
	//
	// Example: Bison
	Lastname *string `json:"lastname,omitempty"`

	// Locale This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
	//
	// Example: de_DE
	Locale *SupportedLocale `json:"locale,omitempty"`
}

ModifyMeAction ModifyMeAction

type ModifyMeActionAction

type ModifyMeActionAction string

ModifyMeActionAction The type of action to perform

const (
	ModifyMe ModifyMeActionAction = "ModifyMe"
)

Defines values for ModifyMeActionAction.

func (ModifyMeActionAction) Valid

func (e ModifyMeActionAction) Valid() bool

Valid indicates whether the value is a known member of the ModifyMeActionAction enum.

type ModifyMyCredentialsAction

type ModifyMyCredentialsAction struct {
	// Action The type of action to perform
	Action ModifyMyCredentialsActionAction `json:"action"`

	// CurrentPassword Current password for verification (required)
	//
	// Example: currentPassword123
	CurrentPassword string `json:"currentPassword"`

	// Email New email address (optional)
	//
	// Example: newemail@example.com
	Email *string `json:"email,omitempty"`

	// Password New password (optional)
	//
	// Example: newSecurePassword456
	Password *string `json:"password,omitempty"`
}

ModifyMyCredentialsAction ModifyMyCredentialsAction

type ModifyMyCredentialsActionAction

type ModifyMyCredentialsActionAction string

ModifyMyCredentialsActionAction The type of action to perform

const (
	ModifyCredentials ModifyMyCredentialsActionAction = "ModifyCredentials"
)

Defines values for ModifyMyCredentialsActionAction.

func (ModifyMyCredentialsActionAction) Valid

Valid indicates whether the value is a known member of the ModifyMyCredentialsActionAction enum.

type ModifyPartialStock

type ModifyPartialStock struct {
	// Action Use value 'ModifyPartialStock', because you want to modify a partial stock
	Action        ModifyPartialStockAction   `json:"action"`
	PartialStocks *[]PartialStockForCreation `json:"partialStocks,omitempty"`
}

ModifyPartialStock ModifyPartialStock

type ModifyPartialStockAction

type ModifyPartialStockAction string

ModifyPartialStockAction Use value 'ModifyPartialStock', because you want to modify a partial stock

const (
	ModifyPartialStockActionModifyPartialStock ModifyPartialStockAction = "ModifyPartialStock"
)

Defines values for ModifyPartialStockAction.

func (ModifyPartialStockAction) Valid

func (e ModifyPartialStockAction) Valid() bool

Valid indicates whether the value is a known member of the ModifyPartialStockAction enum.

type ModifyUserAction

type ModifyUserAction struct {
	// Action The type of action to perform
	Action UserActionEnum `json:"action"`

	// AssignedFacilities Deprecated: Use assignedRoles with contextLimitation of type FACILITY instead
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AssignedFacilities *[]UserAssignedFacilityForCreation `json:"assignedFacilities,omitempty"`

	// AssignedRoles The new roles of the user
	AssignedRoles *[]AssignedRoles `json:"assignedRoles,omitempty"`

	// CustomAttributes The new custom attributes of the user
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Email The changed email of the user
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *string `json:"email,omitempty"`

	// Firstname The new firstname of the user
	//
	// Example: Phil
	Firstname *string `json:"firstname,omitempty"`

	// Lastname The new lastname of the user
	//
	// Example: Bison
	Lastname *string `json:"lastname,omitempty"`

	// Locale This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
	//
	// Example: de_DE
	Locale *SupportedLocale `json:"locale,omitempty"`

	// Password The new password of the user
	Password *string `json:"password,omitempty"`

	// Roles Deprecated: Use assignedRoles instead
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Roles *[]UserRole `json:"roles,omitempty"`
}

ModifyUserAction ModifyUserAction

type ModifyUserPersonalData

type ModifyUserPersonalData struct {
	// Firstname The new firstname of the user
	//
	// Example: Phil
	Firstname *string `json:"firstname,omitempty"`

	// Lastname The new lastname of the user
	//
	// Example: Bison
	Lastname *string `json:"lastname,omitempty"`

	// Locale This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
	//
	// Example: de_DE
	Locale *SupportedLocale `json:"locale,omitempty"`
}

ModifyUserPersonalData ModifyUserPersonalData

type MonetaryValue added in v0.3.0

type MonetaryValue struct {
	// Currency ISO 4217 currency code
	//
	// Example: EUR
	Currency MonetaryValueCurrency `json:"currency"`

	// DecimalPlaces Number of decimal places. If omitted, the default for the currency applies.
	//
	// Example: 2
	DecimalPlaces *int64 `json:"decimalPlaces,omitempty"`

	// Value Monetary value as integer (no decimals)
	//
	// Example: 1299
	Value int64 `json:"value"`
}

MonetaryValue MonetaryValue

type MonetaryValueCurrency added in v0.3.0

type MonetaryValueCurrency string

MonetaryValueCurrency ISO 4217 currency code

Example: EUR

const (
	MonetaryValueCurrencyAED MonetaryValueCurrency = "AED"
	MonetaryValueCurrencyAFN MonetaryValueCurrency = "AFN"
	MonetaryValueCurrencyALL MonetaryValueCurrency = "ALL"
	MonetaryValueCurrencyAMD MonetaryValueCurrency = "AMD"
	MonetaryValueCurrencyANG MonetaryValueCurrency = "ANG"
	MonetaryValueCurrencyAOA MonetaryValueCurrency = "AOA"
	MonetaryValueCurrencyARS MonetaryValueCurrency = "ARS"
	MonetaryValueCurrencyAUD MonetaryValueCurrency = "AUD"
	MonetaryValueCurrencyAWG MonetaryValueCurrency = "AWG"
	MonetaryValueCurrencyAZN MonetaryValueCurrency = "AZN"
	MonetaryValueCurrencyBAM MonetaryValueCurrency = "BAM"
	MonetaryValueCurrencyBBD MonetaryValueCurrency = "BBD"
	MonetaryValueCurrencyBDT MonetaryValueCurrency = "BDT"
	MonetaryValueCurrencyBGN MonetaryValueCurrency = "BGN"
	MonetaryValueCurrencyBHD MonetaryValueCurrency = "BHD"
	MonetaryValueCurrencyBIF MonetaryValueCurrency = "BIF"
	MonetaryValueCurrencyBMD MonetaryValueCurrency = "BMD"
	MonetaryValueCurrencyBND MonetaryValueCurrency = "BND"
	MonetaryValueCurrencyBOB MonetaryValueCurrency = "BOB"
	MonetaryValueCurrencyBOV MonetaryValueCurrency = "BOV"
	MonetaryValueCurrencyBRL MonetaryValueCurrency = "BRL"
	MonetaryValueCurrencyBSD MonetaryValueCurrency = "BSD"
	MonetaryValueCurrencyBTN MonetaryValueCurrency = "BTN"
	MonetaryValueCurrencyBWP MonetaryValueCurrency = "BWP"
	MonetaryValueCurrencyBYN MonetaryValueCurrency = "BYN"
	MonetaryValueCurrencyBZD MonetaryValueCurrency = "BZD"
	MonetaryValueCurrencyCAD MonetaryValueCurrency = "CAD"
	MonetaryValueCurrencyCDF MonetaryValueCurrency = "CDF"
	MonetaryValueCurrencyCHE MonetaryValueCurrency = "CHE"
	MonetaryValueCurrencyCHF MonetaryValueCurrency = "CHF"
	MonetaryValueCurrencyCHW MonetaryValueCurrency = "CHW"
	MonetaryValueCurrencyCLF MonetaryValueCurrency = "CLF"
	MonetaryValueCurrencyCLP MonetaryValueCurrency = "CLP"
	MonetaryValueCurrencyCNY MonetaryValueCurrency = "CNY"
	MonetaryValueCurrencyCOP MonetaryValueCurrency = "COP"
	MonetaryValueCurrencyCOU MonetaryValueCurrency = "COU"
	MonetaryValueCurrencyCRC MonetaryValueCurrency = "CRC"
	MonetaryValueCurrencyCUC MonetaryValueCurrency = "CUC"
	MonetaryValueCurrencyCUP MonetaryValueCurrency = "CUP"
	MonetaryValueCurrencyCVE MonetaryValueCurrency = "CVE"
	MonetaryValueCurrencyCZK MonetaryValueCurrency = "CZK"
	MonetaryValueCurrencyDJF MonetaryValueCurrency = "DJF"
	MonetaryValueCurrencyDKK MonetaryValueCurrency = "DKK"
	MonetaryValueCurrencyDOP MonetaryValueCurrency = "DOP"
	MonetaryValueCurrencyDZD MonetaryValueCurrency = "DZD"
	MonetaryValueCurrencyEGP MonetaryValueCurrency = "EGP"
	MonetaryValueCurrencyERN MonetaryValueCurrency = "ERN"
	MonetaryValueCurrencyETB MonetaryValueCurrency = "ETB"
	MonetaryValueCurrencyEUR MonetaryValueCurrency = "EUR"
	MonetaryValueCurrencyFJD MonetaryValueCurrency = "FJD"
	MonetaryValueCurrencyFKP MonetaryValueCurrency = "FKP"
	MonetaryValueCurrencyGBP MonetaryValueCurrency = "GBP"
	MonetaryValueCurrencyGEL MonetaryValueCurrency = "GEL"
	MonetaryValueCurrencyGHS MonetaryValueCurrency = "GHS"
	MonetaryValueCurrencyGIP MonetaryValueCurrency = "GIP"
	MonetaryValueCurrencyGMD MonetaryValueCurrency = "GMD"
	MonetaryValueCurrencyGNF MonetaryValueCurrency = "GNF"
	MonetaryValueCurrencyGTQ MonetaryValueCurrency = "GTQ"
	MonetaryValueCurrencyGYD MonetaryValueCurrency = "GYD"
	MonetaryValueCurrencyHKD MonetaryValueCurrency = "HKD"
	MonetaryValueCurrencyHNL MonetaryValueCurrency = "HNL"
	MonetaryValueCurrencyHTG MonetaryValueCurrency = "HTG"
	MonetaryValueCurrencyHUF MonetaryValueCurrency = "HUF"
	MonetaryValueCurrencyIDR MonetaryValueCurrency = "IDR"
	MonetaryValueCurrencyILS MonetaryValueCurrency = "ILS"
	MonetaryValueCurrencyINR MonetaryValueCurrency = "INR"
	MonetaryValueCurrencyIQD MonetaryValueCurrency = "IQD"
	MonetaryValueCurrencyIRR MonetaryValueCurrency = "IRR"
	MonetaryValueCurrencyISK MonetaryValueCurrency = "ISK"
	MonetaryValueCurrencyJMD MonetaryValueCurrency = "JMD"
	MonetaryValueCurrencyJOD MonetaryValueCurrency = "JOD"
	MonetaryValueCurrencyJPY MonetaryValueCurrency = "JPY"
	MonetaryValueCurrencyKES MonetaryValueCurrency = "KES"
	MonetaryValueCurrencyKGS MonetaryValueCurrency = "KGS"
	MonetaryValueCurrencyKHR MonetaryValueCurrency = "KHR"
	MonetaryValueCurrencyKMF MonetaryValueCurrency = "KMF"
	MonetaryValueCurrencyKPW MonetaryValueCurrency = "KPW"
	MonetaryValueCurrencyKRW MonetaryValueCurrency = "KRW"
	MonetaryValueCurrencyKWD MonetaryValueCurrency = "KWD"
	MonetaryValueCurrencyKYD MonetaryValueCurrency = "KYD"
	MonetaryValueCurrencyKZT MonetaryValueCurrency = "KZT"
	MonetaryValueCurrencyLAK MonetaryValueCurrency = "LAK"
	MonetaryValueCurrencyLBP MonetaryValueCurrency = "LBP"
	MonetaryValueCurrencyLKR MonetaryValueCurrency = "LKR"
	MonetaryValueCurrencyLRD MonetaryValueCurrency = "LRD"
	MonetaryValueCurrencyLSL MonetaryValueCurrency = "LSL"
	MonetaryValueCurrencyLYD MonetaryValueCurrency = "LYD"
	MonetaryValueCurrencyMAD MonetaryValueCurrency = "MAD"
	MonetaryValueCurrencyMDL MonetaryValueCurrency = "MDL"
	MonetaryValueCurrencyMGA MonetaryValueCurrency = "MGA"
	MonetaryValueCurrencyMKD MonetaryValueCurrency = "MKD"
	MonetaryValueCurrencyMMK MonetaryValueCurrency = "MMK"
	MonetaryValueCurrencyMNT MonetaryValueCurrency = "MNT"
	MonetaryValueCurrencyMOP MonetaryValueCurrency = "MOP"
	MonetaryValueCurrencyMRU MonetaryValueCurrency = "MRU"
	MonetaryValueCurrencyMUR MonetaryValueCurrency = "MUR"
	MonetaryValueCurrencyMVR MonetaryValueCurrency = "MVR"
	MonetaryValueCurrencyMWK MonetaryValueCurrency = "MWK"
	MonetaryValueCurrencyMXN MonetaryValueCurrency = "MXN"
	MonetaryValueCurrencyMXV MonetaryValueCurrency = "MXV"
	MonetaryValueCurrencyMYR MonetaryValueCurrency = "MYR"
	MonetaryValueCurrencyMZN MonetaryValueCurrency = "MZN"
	MonetaryValueCurrencyNAD MonetaryValueCurrency = "NAD"
	MonetaryValueCurrencyNGN MonetaryValueCurrency = "NGN"
	MonetaryValueCurrencyNIO MonetaryValueCurrency = "NIO"
	MonetaryValueCurrencyNOK MonetaryValueCurrency = "NOK"
	MonetaryValueCurrencyNPR MonetaryValueCurrency = "NPR"
	MonetaryValueCurrencyNZD MonetaryValueCurrency = "NZD"
	MonetaryValueCurrencyOMR MonetaryValueCurrency = "OMR"
	MonetaryValueCurrencyPAB MonetaryValueCurrency = "PAB"
	MonetaryValueCurrencyPEN MonetaryValueCurrency = "PEN"
	MonetaryValueCurrencyPGK MonetaryValueCurrency = "PGK"
	MonetaryValueCurrencyPHP MonetaryValueCurrency = "PHP"
	MonetaryValueCurrencyPKR MonetaryValueCurrency = "PKR"
	MonetaryValueCurrencyPLN MonetaryValueCurrency = "PLN"
	MonetaryValueCurrencyPYG MonetaryValueCurrency = "PYG"
	MonetaryValueCurrencyQAR MonetaryValueCurrency = "QAR"
	MonetaryValueCurrencyRON MonetaryValueCurrency = "RON"
	MonetaryValueCurrencyRSD MonetaryValueCurrency = "RSD"
	MonetaryValueCurrencyRUB MonetaryValueCurrency = "RUB"
	MonetaryValueCurrencyRWF MonetaryValueCurrency = "RWF"
	MonetaryValueCurrencySAR MonetaryValueCurrency = "SAR"
	MonetaryValueCurrencySBD MonetaryValueCurrency = "SBD"
	MonetaryValueCurrencySCR MonetaryValueCurrency = "SCR"
	MonetaryValueCurrencySDG MonetaryValueCurrency = "SDG"
	MonetaryValueCurrencySEK MonetaryValueCurrency = "SEK"
	MonetaryValueCurrencySGD MonetaryValueCurrency = "SGD"
	MonetaryValueCurrencySHP MonetaryValueCurrency = "SHP"
	MonetaryValueCurrencySLE MonetaryValueCurrency = "SLE"
	MonetaryValueCurrencySOS MonetaryValueCurrency = "SOS"
	MonetaryValueCurrencySRD MonetaryValueCurrency = "SRD"
	MonetaryValueCurrencySSP MonetaryValueCurrency = "SSP"
	MonetaryValueCurrencySTN MonetaryValueCurrency = "STN"
	MonetaryValueCurrencySVC MonetaryValueCurrency = "SVC"
	MonetaryValueCurrencySYP MonetaryValueCurrency = "SYP"
	MonetaryValueCurrencySZL MonetaryValueCurrency = "SZL"
	MonetaryValueCurrencyTHB MonetaryValueCurrency = "THB"
	MonetaryValueCurrencyTJS MonetaryValueCurrency = "TJS"
	MonetaryValueCurrencyTMT MonetaryValueCurrency = "TMT"
	MonetaryValueCurrencyTND MonetaryValueCurrency = "TND"
	MonetaryValueCurrencyTOP MonetaryValueCurrency = "TOP"
	MonetaryValueCurrencyTRY MonetaryValueCurrency = "TRY"
	MonetaryValueCurrencyTTD MonetaryValueCurrency = "TTD"
	MonetaryValueCurrencyTWD MonetaryValueCurrency = "TWD"
	MonetaryValueCurrencyTZS MonetaryValueCurrency = "TZS"
	MonetaryValueCurrencyUAH MonetaryValueCurrency = "UAH"
	MonetaryValueCurrencyUGX MonetaryValueCurrency = "UGX"
	MonetaryValueCurrencyUSD MonetaryValueCurrency = "USD"
	MonetaryValueCurrencyUSN MonetaryValueCurrency = "USN"
	MonetaryValueCurrencyUYI MonetaryValueCurrency = "UYI"
	MonetaryValueCurrencyUYU MonetaryValueCurrency = "UYU"
	MonetaryValueCurrencyUYW MonetaryValueCurrency = "UYW"
	MonetaryValueCurrencyUZS MonetaryValueCurrency = "UZS"
	MonetaryValueCurrencyVED MonetaryValueCurrency = "VED"
	MonetaryValueCurrencyVES MonetaryValueCurrency = "VES"
	MonetaryValueCurrencyVND MonetaryValueCurrency = "VND"
	MonetaryValueCurrencyVUV MonetaryValueCurrency = "VUV"
	MonetaryValueCurrencyWST MonetaryValueCurrency = "WST"
	MonetaryValueCurrencyXAF MonetaryValueCurrency = "XAF"
	MonetaryValueCurrencyXAG MonetaryValueCurrency = "XAG"
	MonetaryValueCurrencyXAU MonetaryValueCurrency = "XAU"
	MonetaryValueCurrencyXBA MonetaryValueCurrency = "XBA"
	MonetaryValueCurrencyXBB MonetaryValueCurrency = "XBB"
	MonetaryValueCurrencyXBC MonetaryValueCurrency = "XBC"
	MonetaryValueCurrencyXBD MonetaryValueCurrency = "XBD"
	MonetaryValueCurrencyXCD MonetaryValueCurrency = "XCD"
	MonetaryValueCurrencyXDR MonetaryValueCurrency = "XDR"
	MonetaryValueCurrencyXOF MonetaryValueCurrency = "XOF"
	MonetaryValueCurrencyXPD MonetaryValueCurrency = "XPD"
	MonetaryValueCurrencyXPF MonetaryValueCurrency = "XPF"
	MonetaryValueCurrencyXPT MonetaryValueCurrency = "XPT"
	MonetaryValueCurrencyXSU MonetaryValueCurrency = "XSU"
	MonetaryValueCurrencyXTS MonetaryValueCurrency = "XTS"
	MonetaryValueCurrencyXUA MonetaryValueCurrency = "XUA"
	MonetaryValueCurrencyXXX MonetaryValueCurrency = "XXX"
	MonetaryValueCurrencyYER MonetaryValueCurrency = "YER"
	MonetaryValueCurrencyZAR MonetaryValueCurrency = "ZAR"
	MonetaryValueCurrencyZMW MonetaryValueCurrency = "ZMW"
	MonetaryValueCurrencyZWL MonetaryValueCurrency = "ZWL"
)

Defines values for MonetaryValueCurrency.

func (MonetaryValueCurrency) Valid added in v0.3.0

func (e MonetaryValueCurrency) Valid() bool

Valid indicates whether the value is a known member of the MonetaryValueCurrency enum.

type Money added in v0.2.0

type Money struct {
	// Currency The currency code is a three-letter code that represents a currency in the ISO 4217 standard.
	Currency      CurrencyCode `json:"currency"`
	DecimalPlaces *float32     `json:"decimalPlaces,omitempty"`
	Value         float32      `json:"value"`
}

Money Money

type MoveStockToLocationOptions

type MoveStockToLocationOptions struct {
	DeleteFromStockIfZero *bool `json:"deleteFromStockIfZero,omitempty"`
}

MoveStockToLocationOptions MoveStockToLocationOptions

type NodeType added in v0.2.0

type NodeType string

NodeType NodeType

const (
	NodeTypeCUSTOMER        NodeType = "CUSTOMER"
	NodeTypeMANAGEDFACILITY NodeType = "MANAGED_FACILITY"
	NodeTypeSUPPLIER        NodeType = "SUPPLIER"
)

Defines values for NodeType.

func (NodeType) Valid added in v0.2.0

func (e NodeType) Valid() bool

Valid indicates whether the value is a known member of the NodeType enum.

type NonDeliveryDays

type NonDeliveryDays struct {
	// NonDeliveryDay The non-delivery day in YYYY-MM-DD format
	//
	// Example: 2020-02-03T00:00:00.000Z
	NonDeliveryDay openapi_types.Date `json:"nonDeliveryDay"`

	// NonDeliveryType Type of non-delivery day
	//
	// Example: SINGLE
	NonDeliveryType *NonDeliveryDaysNonDeliveryType `json:"nonDeliveryType,omitempty"`
}

NonDeliveryDays NonDeliveryDays

type NonDeliveryDaysNonDeliveryType

type NonDeliveryDaysNonDeliveryType string

NonDeliveryDaysNonDeliveryType Type of non-delivery day

Example: SINGLE

const (
	RECURRING NonDeliveryDaysNonDeliveryType = "RECURRING"
	SINGLE    NonDeliveryDaysNonDeliveryType = "SINGLE"
)

Defines values for NonDeliveryDaysNonDeliveryType.

func (NonDeliveryDaysNonDeliveryType) Valid

Valid indicates whether the value is a known member of the NonDeliveryDaysNonDeliveryType enum.

type NonDeliveryDaysPerCountryAndProvince

type NonDeliveryDaysPerCountryAndProvince struct {
	// Country The country code
	//
	// Example: US
	Country string `json:"country"`

	// NonDeliveryDays Non-delivery days for this country
	NonDeliveryDays []NonDeliveryDays `json:"nonDeliveryDays"`

	// NonDeliveryDaysPerProvince Non-delivery days per province within this country
	NonDeliveryDaysPerProvince []NonDeliveryDaysPerProvince `json:"nonDeliveryDaysPerProvince"`

	// RecurringNonDeliveryWeekdays Recurring non-delivery weekdays for this country
	RecurringNonDeliveryWeekdays []NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays `json:"recurringNonDeliveryWeekdays"`
}

NonDeliveryDaysPerCountryAndProvince NonDeliveryDaysPerCountryAndProvince

type NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays

type NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays string

NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays defines model for NonDeliveryDaysPerCountryAndProvince.RecurringNonDeliveryWeekdays.

const (
	NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdaysFRIDAY    NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays = "FRIDAY"
	NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdaysMONDAY    NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays = "MONDAY"
	NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdaysSATURDAY  NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays = "SATURDAY"
	NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdaysSUNDAY    NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays = "SUNDAY"
	NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdaysTHURSDAY  NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays = "THURSDAY"
	NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdaysTUESDAY   NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays = "TUESDAY"
	NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdaysWEDNESDAY NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays = "WEDNESDAY"
)

Defines values for NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays.

func (NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays) Valid

Valid indicates whether the value is a known member of the NonDeliveryDaysPerCountryAndProvinceRecurringNonDeliveryWeekdays enum.

type NonDeliveryDaysPerProvince

type NonDeliveryDaysPerProvince struct {
	// NonDeliveryDays Non-delivery days for this province
	NonDeliveryDays []NonDeliveryDays `json:"nonDeliveryDays"`

	// Province The province identifier
	Province string `json:"province"`

	// RecurringNonDeliveryWeekdays Recurring non-delivery weekdays for this province
	RecurringNonDeliveryWeekdays []NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays `json:"recurringNonDeliveryWeekdays"`
}

NonDeliveryDaysPerProvince NonDeliveryDaysPerProvince

type NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays

type NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays string

NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays defines model for NonDeliveryDaysPerProvince.RecurringNonDeliveryWeekdays.

const (
	NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdaysFRIDAY    NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays = "FRIDAY"
	NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdaysMONDAY    NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays = "MONDAY"
	NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdaysSATURDAY  NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays = "SATURDAY"
	NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdaysSUNDAY    NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays = "SUNDAY"
	NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdaysTHURSDAY  NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays = "THURSDAY"
	NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdaysTUESDAY   NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays = "TUESDAY"
	NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdaysWEDNESDAY NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays = "WEDNESDAY"
)

Defines values for NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays.

func (NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays) Valid

Valid indicates whether the value is a known member of the NonDeliveryDaysPerProvinceRecurringNonDeliveryWeekdays enum.

type NotificationApiNotificationStatusEnumFilter

type NotificationApiNotificationStatusEnumFilter struct {
	// Eq Search by status
	Eq *NotificationApiNotificationStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]NotificationApiNotificationStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *NotificationApiNotificationStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

NotificationApiNotificationStatusEnumFilter NotificationApiNotificationStatusEnumFilter

type NotificationApiNotificationStatusEnumFilterEq

type NotificationApiNotificationStatusEnumFilterEq string

NotificationApiNotificationStatusEnumFilterEq Search by status

const (
	NotificationApiNotificationStatusEnumFilterEqFINISHED NotificationApiNotificationStatusEnumFilterEq = "FINISHED"
	NotificationApiNotificationStatusEnumFilterEqOPEN     NotificationApiNotificationStatusEnumFilterEq = "OPEN"
)

Defines values for NotificationApiNotificationStatusEnumFilterEq.

func (NotificationApiNotificationStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the NotificationApiNotificationStatusEnumFilterEq enum.

type NotificationApiNotificationStatusEnumFilterIn

type NotificationApiNotificationStatusEnumFilterIn string

NotificationApiNotificationStatusEnumFilterIn defines model for NotificationApiNotificationStatusEnumFilter.In.

const (
	NotificationApiNotificationStatusEnumFilterInFINISHED NotificationApiNotificationStatusEnumFilterIn = "FINISHED"
	NotificationApiNotificationStatusEnumFilterInOPEN     NotificationApiNotificationStatusEnumFilterIn = "OPEN"
)

Defines values for NotificationApiNotificationStatusEnumFilterIn.

func (NotificationApiNotificationStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the NotificationApiNotificationStatusEnumFilterIn enum.

type NotificationApiNotificationStatusEnumFilterNotEq

type NotificationApiNotificationStatusEnumFilterNotEq string

NotificationApiNotificationStatusEnumFilterNotEq Search by status

const (
	NotificationApiNotificationStatusEnumFilterNotEqFINISHED NotificationApiNotificationStatusEnumFilterNotEq = "FINISHED"
	NotificationApiNotificationStatusEnumFilterNotEqOPEN     NotificationApiNotificationStatusEnumFilterNotEq = "OPEN"
)

Defines values for NotificationApiNotificationStatusEnumFilterNotEq.

func (NotificationApiNotificationStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the NotificationApiNotificationStatusEnumFilterNotEq enum.

type NotificationCategoryEnumFilter

type NotificationCategoryEnumFilter struct {
	// Eq Search by category
	Eq *NotificationCategoryEnumFilterEq `json:"eq,omitempty"`

	// In Search by category
	In *[]NotificationCategoryEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by category
	NotEq *NotificationCategoryEnumFilterNotEq `json:"notEq,omitempty"`
}

NotificationCategoryEnumFilter NotificationCategoryEnumFilter

type NotificationCategoryEnumFilterEq

type NotificationCategoryEnumFilterEq string

NotificationCategoryEnumFilterEq Search by category

const (
	NotificationCategoryEnumFilterEqFACILITY NotificationCategoryEnumFilterEq = "FACILITY"
	NotificationCategoryEnumFilterEqMISC     NotificationCategoryEnumFilterEq = "MISC"
	NotificationCategoryEnumFilterEqORDER    NotificationCategoryEnumFilterEq = "ORDER"
)

Defines values for NotificationCategoryEnumFilterEq.

func (NotificationCategoryEnumFilterEq) Valid

Valid indicates whether the value is a known member of the NotificationCategoryEnumFilterEq enum.

type NotificationCategoryEnumFilterIn

type NotificationCategoryEnumFilterIn string

NotificationCategoryEnumFilterIn defines model for NotificationCategoryEnumFilter.In.

const (
	NotificationCategoryEnumFilterInFACILITY NotificationCategoryEnumFilterIn = "FACILITY"
	NotificationCategoryEnumFilterInMISC     NotificationCategoryEnumFilterIn = "MISC"
	NotificationCategoryEnumFilterInORDER    NotificationCategoryEnumFilterIn = "ORDER"
)

Defines values for NotificationCategoryEnumFilterIn.

func (NotificationCategoryEnumFilterIn) Valid

Valid indicates whether the value is a known member of the NotificationCategoryEnumFilterIn enum.

type NotificationCategoryEnumFilterNotEq

type NotificationCategoryEnumFilterNotEq string

NotificationCategoryEnumFilterNotEq Search by category

const (
	NotificationCategoryEnumFilterNotEqFACILITY NotificationCategoryEnumFilterNotEq = "FACILITY"
	NotificationCategoryEnumFilterNotEqMISC     NotificationCategoryEnumFilterNotEq = "MISC"
	NotificationCategoryEnumFilterNotEqORDER    NotificationCategoryEnumFilterNotEq = "ORDER"
)

Defines values for NotificationCategoryEnumFilterNotEq.

func (NotificationCategoryEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the NotificationCategoryEnumFilterNotEq enum.

type NotificationPriorityFilter

type NotificationPriorityFilter struct {
	// Label Search by label
	Label *NotificationPriorityPriorityLabelEnumFilter `json:"label,omitempty"`

	// Sequence Search by sequence
	Sequence *NumberFilter `json:"sequence,omitempty"`
}

NotificationPriorityFilter NotificationPriorityFilter

type NotificationPriorityPriorityLabelEnumFilter

type NotificationPriorityPriorityLabelEnumFilter struct {
	// Eq Search by label
	Eq *NotificationPriorityPriorityLabelEnumFilterEq `json:"eq,omitempty"`

	// In Search by label
	In *[]NotificationPriorityPriorityLabelEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by label
	NotEq *NotificationPriorityPriorityLabelEnumFilterNotEq `json:"notEq,omitempty"`
}

NotificationPriorityPriorityLabelEnumFilter NotificationPriorityPriorityLabelEnumFilter

type NotificationPriorityPriorityLabelEnumFilterEq

type NotificationPriorityPriorityLabelEnumFilterEq string

NotificationPriorityPriorityLabelEnumFilterEq Search by label

const (
	NotificationPriorityPriorityLabelEnumFilterEqHIGH   NotificationPriorityPriorityLabelEnumFilterEq = "HIGH"
	NotificationPriorityPriorityLabelEnumFilterEqLOW    NotificationPriorityPriorityLabelEnumFilterEq = "LOW"
	NotificationPriorityPriorityLabelEnumFilterEqMEDIUM NotificationPriorityPriorityLabelEnumFilterEq = "MEDIUM"
)

Defines values for NotificationPriorityPriorityLabelEnumFilterEq.

func (NotificationPriorityPriorityLabelEnumFilterEq) Valid

Valid indicates whether the value is a known member of the NotificationPriorityPriorityLabelEnumFilterEq enum.

type NotificationPriorityPriorityLabelEnumFilterIn

type NotificationPriorityPriorityLabelEnumFilterIn string

NotificationPriorityPriorityLabelEnumFilterIn defines model for NotificationPriorityPriorityLabelEnumFilter.In.

const (
	NotificationPriorityPriorityLabelEnumFilterInHIGH   NotificationPriorityPriorityLabelEnumFilterIn = "HIGH"
	NotificationPriorityPriorityLabelEnumFilterInLOW    NotificationPriorityPriorityLabelEnumFilterIn = "LOW"
	NotificationPriorityPriorityLabelEnumFilterInMEDIUM NotificationPriorityPriorityLabelEnumFilterIn = "MEDIUM"
)

Defines values for NotificationPriorityPriorityLabelEnumFilterIn.

func (NotificationPriorityPriorityLabelEnumFilterIn) Valid

Valid indicates whether the value is a known member of the NotificationPriorityPriorityLabelEnumFilterIn enum.

type NotificationPriorityPriorityLabelEnumFilterNotEq

type NotificationPriorityPriorityLabelEnumFilterNotEq string

NotificationPriorityPriorityLabelEnumFilterNotEq Search by label

const (
	NotificationPriorityPriorityLabelEnumFilterNotEqHIGH   NotificationPriorityPriorityLabelEnumFilterNotEq = "HIGH"
	NotificationPriorityPriorityLabelEnumFilterNotEqLOW    NotificationPriorityPriorityLabelEnumFilterNotEq = "LOW"
	NotificationPriorityPriorityLabelEnumFilterNotEqMEDIUM NotificationPriorityPriorityLabelEnumFilterNotEq = "MEDIUM"
)

Defines values for NotificationPriorityPriorityLabelEnumFilterNotEq.

func (NotificationPriorityPriorityLabelEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the NotificationPriorityPriorityLabelEnumFilterNotEq enum.

type NotificationSearchQuery

type NotificationSearchQuery struct {
	And *[]NotificationSearchQuery `json:"and,omitempty"`

	// Category Search by category
	Category *NotificationCategoryEnumFilter `json:"category,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter              `json:"facilityRef,omitempty"`
	Or          *[]NotificationSearchQuery `json:"or,omitempty"`

	// Priority Nested search by priority
	Priority *NotificationPriorityFilter `json:"priority,omitempty"`

	// Status Search by status
	Status *NotificationApiNotificationStatusEnumFilter `json:"status,omitempty"`
}

NotificationSearchQuery NotificationSearchQuery

type NumberEqFilter

type NumberEqFilter struct {
	Eq    *float32 `json:"eq,omitempty"`
	Gt    *float32 `json:"gt,omitempty"`
	Gte   *float32 `json:"gte,omitempty"`
	Lt    *float32 `json:"lt,omitempty"`
	Lte   *float32 `json:"lte,omitempty"`
	NotEq *float32 `json:"notEq,omitempty"`
}

NumberEqFilter NumberEqFilter

type NumberFilter

type NumberFilter struct {
	Eq    *float32   `json:"eq,omitempty"`
	Gt    *float32   `json:"gt,omitempty"`
	Gte   *float32   `json:"gte,omitempty"`
	In    *[]float32 `json:"in,omitempty"`
	Lt    *float32   `json:"lt,omitempty"`
	Lte   *float32   `json:"lte,omitempty"`
	NotEq *float32   `json:"notEq,omitempty"`
	NotIn *[]float32 `json:"notIn,omitempty"`
}

NumberFilter NumberFilter

type Operation

type Operation struct {
	// ID is the operationId: the name `fft api <id>` takes.
	ID string

	// Method is the HTTP method, upper-case.
	Method string

	// Path is the path template, with {placeholders}: /api/pickjobs/{pickJobId}.
	Path string

	// Tags are the spec's tags. The first one decides which command group the
	// generated command lands in.
	Tags []string

	// Summary is the operation's one-line description.
	Summary string

	// Description is its prose, HTML stripped and whitespace collapsed.
	Description string

	// Permissions are the operation's x-fft-permissions, empty when it declares
	// none. 331 of the 568 operations declare them.
	Permissions []string

	// Params are the operation's parameters, sorted: path first, then query, then
	// header, alphabetically within each.
	Params []Param

	// HasBody says the operation takes a request body.
	HasBody bool

	// BodyRequired says the API will not accept the request without one.
	BodyRequired bool

	// SampleBody is a request body synthesized from the schema — the spec has
	// thousands of field-level examples and not one request-body example, so there
	// was nothing to copy and this was built. It is "" when the operation takes no body.
	SampleBody string

	// SampleResponse is a success (2xx) response body synthesized from the schema the
	// same way SampleBody is, and "" when the operation declares no JSON response body
	// (a 204, or a non-JSON one). The spec carries no response examples either, so this
	// is built. It backs `fft emulator`, which serves it for any operation it does not
	// answer from live in-memory state.
	SampleResponse string

	// Deprecated says the spec marks the operation deprecated.
	Deprecated bool
}

Operation is one operation of the fulfillmenttools API, keyed by its operationId.

func LookupOperation

func LookupOperation(id string) (Operation, bool)

LookupOperation returns the operation with that operationId. The match is exact: a near miss is a job for SuggestOperations, which can say what was meant.

func Operations

func Operations() []Operation

Operations returns every operation in the spec, sorted by ID.

The returned slice is a copy, but the slices inside each Operation are not: treat an Operation as read-only.

func OperationsByTag

func OperationsByTag(tag string) []Operation

OperationsByTag returns every operation carrying tag, sorted by ID. The match is case-insensitive and by substring, so --tag picking finds "Picking (Operations)" without the user having to reproduce the parentheses.

func (Operation) Mutates added in v0.2.0

func (o Operation) Mutates() bool

Mutates reports whether the operation changes state on the tenant.

The method decides — except for POST, which the fulfillmenttools API uses for both halves of its world. POST /api/facilities/search is a *read*: a cursor search cannot express its query in a query string, so it posts one, and the whole list tier of the CLI is built on that. POST /api/facilities creates a facility. The method alone therefore cannot answer the question.

Nor can the path: "does it end in /search?" catches 34 of the 46 reads and misses the rest. Nor can the status code: 43 of the mutating POSTs answer 200 rather than 201, so a "200 means read" heuristic would wave through creates.

So a POST is a mutation unless its operationId is in [readPOSTs], and that list is hand-curated. A POST the spec grows tomorrow is a mutation until a human says otherwise, and the census in access_test.go fails the build until one does. Fail closed: the cost of a wrong "read" is a write that fft promised not to make.

func (Operation) Param

func (o Operation) Param(name string) (Param, bool)

Param returns the operation's parameter of that name.

func (Operation) ParamsIn

func (o Operation) ParamsIn(in ParamIn) []Param

ParamsIn returns the operation's parameters that travel in one place.

func (Operation) Tag

func (o Operation) Tag() string

Tag is the tag the operation's command group is derived from, or "" when the spec gives it none.

type OperativeEntity

type OperativeEntity struct {
	// EntityChildren Tree structure of entities belonging to this entity
	EntityChildren *[]OperativeEntity `json:"entityChildren,omitempty"`

	// EntityRef Reference to the full entity
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	EntityRef string `json:"entityRef"`

	// EntityType Type of the entity
	EntityType OperativeEntityEntityType `json:"entityType"`
}

OperativeEntity OperativeEntity

type OperativeEntityEntityType

type OperativeEntityEntityType string

OperativeEntityEntityType Type of the entity

const (
	OperativeEntityEntityTypeHANDOVERCONTAINER      OperativeEntityEntityType = "HANDOVER_CONTAINER"
	OperativeEntityEntityTypeHANDOVERJOB            OperativeEntityEntityType = "HANDOVER_JOB"
	OperativeEntityEntityTypeITEMRETURNJOB          OperativeEntityEntityType = "ITEM_RETURN_JOB"
	OperativeEntityEntityTypeLINKEDSERVICEJOBS      OperativeEntityEntityType = "LINKED_SERVICE_JOBS"
	OperativeEntityEntityTypeLOADUNIT               OperativeEntityEntityType = "LOAD_UNIT"
	OperativeEntityEntityTypePACKINGTARGETCONTAINER OperativeEntityEntityType = "PACKING_TARGET_CONTAINER"
	OperativeEntityEntityTypePACKJOB                OperativeEntityEntityType = "PACK_JOB"
	OperativeEntityEntityTypePARCEL                 OperativeEntityEntityType = "PARCEL"
	OperativeEntityEntityTypePARCELINFORMATION      OperativeEntityEntityType = "PARCEL_INFORMATION"
	OperativeEntityEntityTypePICKJOB                OperativeEntityEntityType = "PICK_JOB"
	OperativeEntityEntityTypeRESTOWITEM             OperativeEntityEntityType = "RESTOW_ITEM"
	OperativeEntityEntityTypeSERVICECONTAINER       OperativeEntityEntityType = "SERVICE_CONTAINER"
	OperativeEntityEntityTypeSERVICEJOB             OperativeEntityEntityType = "SERVICE_JOB"
	OperativeEntityEntityTypeSHIPMENT               OperativeEntityEntityType = "SHIPMENT"
	OperativeEntityEntityTypeSHIPPINGINFORMATION    OperativeEntityEntityType = "SHIPPING_INFORMATION"
)

Defines values for OperativeEntityEntityType.

func (OperativeEntityEntityType) Valid

func (e OperativeEntityEntityType) Valid() bool

Valid indicates whether the value is a known member of the OperativeEntityEntityType enum.

type OptimizationHints added in v0.2.0

type OptimizationHints struct {
	// IncludeCalculationHints Should only be used for debugging. Includes more information on how we calculated the response.
	IncludeCalculationHints *bool `json:"includeCalculationHints,omitempty"`

	// RequestedResultCount Number of different results we calculated
	//
	// Example: 3
	RequestedResultCount *int `json:"requestedResultCount,omitempty"`
}

OptimizationHints OptimizationHints

type Order added in v0.3.0

type Order struct {
	// Anonymized Indicates if gdpr related data was anonymized
	//
	// Example: false
	Anonymized *bool `json:"anonymized,omitempty"`

	// CancelationReason CancelationReason
	CancelationReason *CancelationReason `json:"cancelationReason,omitempty"`

	// Consumer OrderForCreationConsumer
	Consumer OrderForCreationConsumer `json:"consumer"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// CustomAttributes Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{}   `json:"customAttributes,omitempty"`
	CustomServices   *[]CustomServiceReference `json:"customServices,omitempty"`

	// DeliveryPreferences DeliveryPreferences
	DeliveryPreferences *DeliveryPreferences `json:"deliveryPreferences,omitempty"`

	// Id The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.
	//
	// Example: LGMl2DuvPnfPoSHhYFOm
	Id string `json:"id"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// OrderDate The date this order was created at the supplying system.
	//
	// Example: 2020-02-03T08:45:50.525Z
	OrderDate      time.Time       `json:"orderDate"`
	OrderLineItems []OrderLineItem `json:"orderLineItems"`

	// PaymentInfo OrderPaymentInfo
	PaymentInfo *OrderPaymentInfo `json:"paymentInfo,omitempty"`

	// Pricing This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />
	Pricing *OrderPricing `json:"pricing,omitempty"`

	// ProcessId Id of the global process related to this entity. For example used for starting the GDPR process and others.
	ProcessId string `json:"processId"`

	// PromisesOptions OrderPromisesOptions
	PromisesOptions *OrderPromisesOptions `json:"promisesOptions,omitempty"`
	SchemaVersion   *float32              `json:"schemaVersion,omitempty"`

	// Source Defines the source of this order. This field is not required, if the order is created based on an external system.
	Source *Order_Source `json:"source,omitempty"`

	// Status The state of the order. Initially it is OPEN.
	Status        OrderStatus          `json:"status"`
	StatusReasons *[]OrderStatusReason `json:"statusReasons,omitempty"`
	Stickers      *[]Sticker           `json:"stickers,omitempty"`
	Tags          *[]TagReference      `json:"tags,omitempty"`

	// TenantOrderId Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
	//
	// Example: R456728546
	TenantOrderId *string              `json:"tenantOrderId,omitempty"`
	UpdateDetails *[]OrderUpdateDetail `json:"updateDetails,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version             int64                     `json:"version"`
	WorkflowInformation Order_WorkflowInformation `json:"workflowInformation"`
}

Order Order

type OrderActionJSONRequestBody added in v0.3.0

type OrderActionJSONRequestBody = OrderActionsParameter

OrderActionJSONRequestBody defines body for OrderAction for application/json ContentType.

type OrderActionResponse added in v0.3.0

type OrderActionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Order
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseOrderActionResponse added in v0.3.0

func ParseOrderActionResponse(rsp *http.Response) (*OrderActionResponse, error)

ParseOrderActionResponse parses an HTTP response from a OrderActionWithResponse call

func (OrderActionResponse) ContentType added in v0.3.0

func (r OrderActionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (OrderActionResponse) GetBody added in v0.8.0

func (r OrderActionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (OrderActionResponse) GetJSON200 added in v0.8.0

func (r OrderActionResponse) GetJSON200() *Order

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (OrderActionResponse) GetJSON401 added in v0.8.0

func (r OrderActionResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (OrderActionResponse) GetJSON403 added in v0.8.0

func (r OrderActionResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (OrderActionResponse) GetJSON404 added in v0.8.0

func (r OrderActionResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (OrderActionResponse) Status added in v0.3.0

func (r OrderActionResponse) Status() string

Status returns HTTPResponse.Status

func (OrderActionResponse) StatusCode added in v0.3.0

func (r OrderActionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type OrderActionsParameter added in v0.3.0

type OrderActionsParameter struct {
	// contains filtered or unexported fields
}

OrderActionsParameter OrderActionsParameter

func (OrderActionsParameter) AsOrderCancelActionParameter added in v0.3.0

func (t OrderActionsParameter) AsOrderCancelActionParameter() (OrderCancelActionParameter, error)

AsOrderCancelActionParameter returns the union data inside the OrderActionsParameter as a OrderCancelActionParameter

func (OrderActionsParameter) AsOrderConsumerAddressChangeActionParameter added in v0.3.0

func (t OrderActionsParameter) AsOrderConsumerAddressChangeActionParameter() (OrderConsumerAddressChangeActionParameter, error)

AsOrderConsumerAddressChangeActionParameter returns the union data inside the OrderActionsParameter as a OrderConsumerAddressChangeActionParameter

func (OrderActionsParameter) AsOrderConsumerAddressesReplaceActionParameter added in v0.3.0

func (t OrderActionsParameter) AsOrderConsumerAddressesReplaceActionParameter() (OrderConsumerAddressesReplaceActionParameter, error)

AsOrderConsumerAddressesReplaceActionParameter returns the union data inside the OrderActionsParameter as a OrderConsumerAddressesReplaceActionParameter

func (OrderActionsParameter) AsOrderForceCancelActionParameter added in v0.3.0

func (t OrderActionsParameter) AsOrderForceCancelActionParameter() (OrderForceCancelActionParameter, error)

AsOrderForceCancelActionParameter returns the union data inside the OrderActionsParameter as a OrderForceCancelActionParameter

func (OrderActionsParameter) AsOrderInvalidationActionParameter added in v0.8.0

func (t OrderActionsParameter) AsOrderInvalidationActionParameter() (OrderInvalidationActionParameter, error)

AsOrderInvalidationActionParameter returns the union data inside the OrderActionsParameter as a OrderInvalidationActionParameter

func (OrderActionsParameter) AsOrderUnlockActionParameter added in v0.3.0

func (t OrderActionsParameter) AsOrderUnlockActionParameter() (OrderUnlockActionParameter, error)

AsOrderUnlockActionParameter returns the union data inside the OrderActionsParameter as a OrderUnlockActionParameter

func (OrderActionsParameter) AsPromiseConfirmActionParameter added in v0.3.0

func (t OrderActionsParameter) AsPromiseConfirmActionParameter() (PromiseConfirmActionParameter, error)

AsPromiseConfirmActionParameter returns the union data inside the OrderActionsParameter as a PromiseConfirmActionParameter

func (OrderActionsParameter) AsPromiseExtendActionParameter added in v0.3.0

func (t OrderActionsParameter) AsPromiseExtendActionParameter() (PromiseExtendActionParameter, error)

AsPromiseExtendActionParameter returns the union data inside the OrderActionsParameter as a PromiseExtendActionParameter

func (*OrderActionsParameter) FromOrderCancelActionParameter added in v0.3.0

func (t *OrderActionsParameter) FromOrderCancelActionParameter(v OrderCancelActionParameter) error

FromOrderCancelActionParameter overwrites any union data inside the OrderActionsParameter as the provided OrderCancelActionParameter

func (*OrderActionsParameter) FromOrderConsumerAddressChangeActionParameter added in v0.3.0

func (t *OrderActionsParameter) FromOrderConsumerAddressChangeActionParameter(v OrderConsumerAddressChangeActionParameter) error

FromOrderConsumerAddressChangeActionParameter overwrites any union data inside the OrderActionsParameter as the provided OrderConsumerAddressChangeActionParameter

func (*OrderActionsParameter) FromOrderConsumerAddressesReplaceActionParameter added in v0.3.0

func (t *OrderActionsParameter) FromOrderConsumerAddressesReplaceActionParameter(v OrderConsumerAddressesReplaceActionParameter) error

FromOrderConsumerAddressesReplaceActionParameter overwrites any union data inside the OrderActionsParameter as the provided OrderConsumerAddressesReplaceActionParameter

func (*OrderActionsParameter) FromOrderForceCancelActionParameter added in v0.3.0

func (t *OrderActionsParameter) FromOrderForceCancelActionParameter(v OrderForceCancelActionParameter) error

FromOrderForceCancelActionParameter overwrites any union data inside the OrderActionsParameter as the provided OrderForceCancelActionParameter

func (*OrderActionsParameter) FromOrderInvalidationActionParameter added in v0.8.0

func (t *OrderActionsParameter) FromOrderInvalidationActionParameter(v OrderInvalidationActionParameter) error

FromOrderInvalidationActionParameter overwrites any union data inside the OrderActionsParameter as the provided OrderInvalidationActionParameter

func (*OrderActionsParameter) FromOrderUnlockActionParameter added in v0.3.0

func (t *OrderActionsParameter) FromOrderUnlockActionParameter(v OrderUnlockActionParameter) error

FromOrderUnlockActionParameter overwrites any union data inside the OrderActionsParameter as the provided OrderUnlockActionParameter

func (*OrderActionsParameter) FromPromiseConfirmActionParameter added in v0.3.0

func (t *OrderActionsParameter) FromPromiseConfirmActionParameter(v PromiseConfirmActionParameter) error

FromPromiseConfirmActionParameter overwrites any union data inside the OrderActionsParameter as the provided PromiseConfirmActionParameter

func (*OrderActionsParameter) FromPromiseExtendActionParameter added in v0.3.0

func (t *OrderActionsParameter) FromPromiseExtendActionParameter(v PromiseExtendActionParameter) error

FromPromiseExtendActionParameter overwrites any union data inside the OrderActionsParameter as the provided PromiseExtendActionParameter

func (OrderActionsParameter) MarshalJSON added in v0.3.0

func (t OrderActionsParameter) MarshalJSON() ([]byte, error)

func (*OrderActionsParameter) MergeOrderCancelActionParameter added in v0.3.0

func (t *OrderActionsParameter) MergeOrderCancelActionParameter(v OrderCancelActionParameter) error

MergeOrderCancelActionParameter performs a merge with any union data inside the OrderActionsParameter, using the provided OrderCancelActionParameter

func (*OrderActionsParameter) MergeOrderConsumerAddressChangeActionParameter added in v0.3.0

func (t *OrderActionsParameter) MergeOrderConsumerAddressChangeActionParameter(v OrderConsumerAddressChangeActionParameter) error

MergeOrderConsumerAddressChangeActionParameter performs a merge with any union data inside the OrderActionsParameter, using the provided OrderConsumerAddressChangeActionParameter

func (*OrderActionsParameter) MergeOrderConsumerAddressesReplaceActionParameter added in v0.3.0

func (t *OrderActionsParameter) MergeOrderConsumerAddressesReplaceActionParameter(v OrderConsumerAddressesReplaceActionParameter) error

MergeOrderConsumerAddressesReplaceActionParameter performs a merge with any union data inside the OrderActionsParameter, using the provided OrderConsumerAddressesReplaceActionParameter

func (*OrderActionsParameter) MergeOrderForceCancelActionParameter added in v0.3.0

func (t *OrderActionsParameter) MergeOrderForceCancelActionParameter(v OrderForceCancelActionParameter) error

MergeOrderForceCancelActionParameter performs a merge with any union data inside the OrderActionsParameter, using the provided OrderForceCancelActionParameter

func (*OrderActionsParameter) MergeOrderInvalidationActionParameter added in v0.8.0

func (t *OrderActionsParameter) MergeOrderInvalidationActionParameter(v OrderInvalidationActionParameter) error

MergeOrderInvalidationActionParameter performs a merge with any union data inside the OrderActionsParameter, using the provided OrderInvalidationActionParameter

func (*OrderActionsParameter) MergeOrderUnlockActionParameter added in v0.3.0

func (t *OrderActionsParameter) MergeOrderUnlockActionParameter(v OrderUnlockActionParameter) error

MergeOrderUnlockActionParameter performs a merge with any union data inside the OrderActionsParameter, using the provided OrderUnlockActionParameter

func (*OrderActionsParameter) MergePromiseConfirmActionParameter added in v0.3.0

func (t *OrderActionsParameter) MergePromiseConfirmActionParameter(v PromiseConfirmActionParameter) error

MergePromiseConfirmActionParameter performs a merge with any union data inside the OrderActionsParameter, using the provided PromiseConfirmActionParameter

func (*OrderActionsParameter) MergePromiseExtendActionParameter added in v0.3.0

func (t *OrderActionsParameter) MergePromiseExtendActionParameter(v PromiseExtendActionParameter) error

MergePromiseExtendActionParameter performs a merge with any union data inside the OrderActionsParameter, using the provided PromiseExtendActionParameter

func (*OrderActionsParameter) UnmarshalJSON added in v0.3.0

func (t *OrderActionsParameter) UnmarshalJSON(b []byte) error

type OrderArticleAttributeItem added in v0.2.0

type OrderArticleAttributeItem = ArticleAttributeItem

OrderArticleAttributeItem OrderArticleAttributeItem

type OrderArticleAttributeItemForUpsert added in v0.9.0

type OrderArticleAttributeItemForUpsert = ArticleAttributeItemForUpsert

OrderArticleAttributeItemForUpsert OrderArticleAttributeItemForUpsert

type OrderCancelActionParameter added in v0.3.0

type OrderCancelActionParameter struct {
	// CancelationReasonId ID of the cancelation reason
	CancelationReasonId *string                        `json:"cancelationReasonId,omitempty"`
	Name                OrderCancelActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

OrderCancelActionParameter Action to cancel an order.

type OrderCancelActionParameterName added in v0.8.0

type OrderCancelActionParameterName string

OrderCancelActionParameterName defines model for OrderCancelActionParameter.Name.

const (
	OrderCancelActionParameterNameCANCEL OrderCancelActionParameterName = "CANCEL"
)

Defines values for OrderCancelActionParameterName.

func (OrderCancelActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the OrderCancelActionParameterName enum.

type OrderConsumerAddressChangeActionParameter deprecated added in v0.3.0

type OrderConsumerAddressChangeActionParameter struct {
	// AddressType Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.
	AddressType AddressType `json:"addressType"`

	// ConsumerAddress ConsumerAddress
	ConsumerAddress ConsumerAddress                               `json:"consumerAddress"`
	Name            OrderConsumerAddressChangeActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

OrderConsumerAddressChangeActionParameter @deprecated use PATCH /api/orders/:id instead 'Action to change a consumer address of an order, e.g. the postal address.'

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type OrderConsumerAddressChangeActionParameterName added in v0.8.0

type OrderConsumerAddressChangeActionParameterName string

OrderConsumerAddressChangeActionParameterName defines model for OrderConsumerAddressChangeActionParameter.Name.

const (
	CHANGECONSUMERADDRESS OrderConsumerAddressChangeActionParameterName = "CHANGE_CONSUMER_ADDRESS"
)

Defines values for OrderConsumerAddressChangeActionParameterName.

func (OrderConsumerAddressChangeActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the OrderConsumerAddressChangeActionParameterName enum.

type OrderConsumerAddressesAddressTypeEnumFilter

type OrderConsumerAddressesAddressTypeEnumFilter struct {
	// Eq Search by addressType
	Eq *OrderConsumerAddressesAddressTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by addressType
	In *[]OrderConsumerAddressesAddressTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by addressType
	NotEq *OrderConsumerAddressesAddressTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

OrderConsumerAddressesAddressTypeEnumFilter OrderConsumerAddressesAddressTypeEnumFilter

type OrderConsumerAddressesAddressTypeEnumFilterEq

type OrderConsumerAddressesAddressTypeEnumFilterEq string

OrderConsumerAddressesAddressTypeEnumFilterEq Search by addressType

const (
	OrderConsumerAddressesAddressTypeEnumFilterEqINVOICEADDRESS OrderConsumerAddressesAddressTypeEnumFilterEq = "INVOICE_ADDRESS"
	OrderConsumerAddressesAddressTypeEnumFilterEqPARCELLOCKER   OrderConsumerAddressesAddressTypeEnumFilterEq = "PARCEL_LOCKER"
	OrderConsumerAddressesAddressTypeEnumFilterEqPOSTALADDRESS  OrderConsumerAddressesAddressTypeEnumFilterEq = "POSTAL_ADDRESS"
)

Defines values for OrderConsumerAddressesAddressTypeEnumFilterEq.

func (OrderConsumerAddressesAddressTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the OrderConsumerAddressesAddressTypeEnumFilterEq enum.

type OrderConsumerAddressesAddressTypeEnumFilterIn

type OrderConsumerAddressesAddressTypeEnumFilterIn string

OrderConsumerAddressesAddressTypeEnumFilterIn defines model for OrderConsumerAddressesAddressTypeEnumFilter.In.

const (
	OrderConsumerAddressesAddressTypeEnumFilterInINVOICEADDRESS OrderConsumerAddressesAddressTypeEnumFilterIn = "INVOICE_ADDRESS"
	OrderConsumerAddressesAddressTypeEnumFilterInPARCELLOCKER   OrderConsumerAddressesAddressTypeEnumFilterIn = "PARCEL_LOCKER"
	OrderConsumerAddressesAddressTypeEnumFilterInPOSTALADDRESS  OrderConsumerAddressesAddressTypeEnumFilterIn = "POSTAL_ADDRESS"
)

Defines values for OrderConsumerAddressesAddressTypeEnumFilterIn.

func (OrderConsumerAddressesAddressTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the OrderConsumerAddressesAddressTypeEnumFilterIn enum.

type OrderConsumerAddressesAddressTypeEnumFilterNotEq

type OrderConsumerAddressesAddressTypeEnumFilterNotEq string

OrderConsumerAddressesAddressTypeEnumFilterNotEq Search by addressType

const (
	OrderConsumerAddressesAddressTypeEnumFilterNotEqINVOICEADDRESS OrderConsumerAddressesAddressTypeEnumFilterNotEq = "INVOICE_ADDRESS"
	OrderConsumerAddressesAddressTypeEnumFilterNotEqPARCELLOCKER   OrderConsumerAddressesAddressTypeEnumFilterNotEq = "PARCEL_LOCKER"
	OrderConsumerAddressesAddressTypeEnumFilterNotEqPOSTALADDRESS  OrderConsumerAddressesAddressTypeEnumFilterNotEq = "POSTAL_ADDRESS"
)

Defines values for OrderConsumerAddressesAddressTypeEnumFilterNotEq.

func (OrderConsumerAddressesAddressTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the OrderConsumerAddressesAddressTypeEnumFilterNotEq enum.

type OrderConsumerAddressesFilter

type OrderConsumerAddressesFilter struct {
	// AddressType Search by addressType
	AddressType *OrderConsumerAddressesAddressTypeEnumFilter `json:"addressType,omitempty"`

	// City Search by city
	//
	// Example: Yellowstone
	City *StringFilter `json:"city,omitempty"`

	// CompanyName Search by companyName
	CompanyName *StringFilter `json:"companyName,omitempty"`

	// Country Search by country
	//
	// Example: US
	Country *StringFilter `json:"country,omitempty"`

	// Email Search by email
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *StringFilter `json:"email,omitempty"`

	// FirstName Search by firstName
	FirstName *StringFilter `json:"firstName,omitempty"`

	// HouseNumber Search by houseNumber
	//
	// Example: 42
	HouseNumber *StringFilter `json:"houseNumber,omitempty"`

	// LastName Search by lastName
	LastName *StringFilter `json:"lastName,omitempty"`

	// PostalCode Search by postalCode
	//
	// Example: 42420
	PostalCode *StringFilter `json:"postalCode,omitempty"`

	// Province Search by province
	Province *StringFilter `json:"province,omitempty"`

	// Street Search by street
	Street *StringFilter `json:"street,omitempty"`
}

OrderConsumerAddressesFilter OrderConsumerAddressesFilter

type OrderConsumerAddressesListFilter

type OrderConsumerAddressesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *OrderConsumerAddressesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

OrderConsumerAddressesListFilter OrderConsumerAddressesListFilter

type OrderConsumerAddressesReplaceActionParameter deprecated added in v0.3.0

type OrderConsumerAddressesReplaceActionParameter struct {
	ConsumerAddresses []ConsumerAddress                                `json:"consumerAddresses"`
	Name              OrderConsumerAddressesReplaceActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

OrderConsumerAddressesReplaceActionParameter @deprecated use PATCH /api/orders/:id instead 'Action to replace all consumer addresses of an order.'

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type OrderConsumerAddressesReplaceActionParameterName added in v0.8.0

type OrderConsumerAddressesReplaceActionParameterName string

OrderConsumerAddressesReplaceActionParameterName defines model for OrderConsumerAddressesReplaceActionParameter.Name.

const (
	REPLACECONSUMERADDRESSES OrderConsumerAddressesReplaceActionParameterName = "REPLACE_CONSUMER_ADDRESSES"
)

Defines values for OrderConsumerAddressesReplaceActionParameterName.

func (OrderConsumerAddressesReplaceActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the OrderConsumerAddressesReplaceActionParameterName enum.

type OrderConsumerFilter

type OrderConsumerFilter struct {
	// Addresses Nested list search by addresses
	Addresses *OrderConsumerAddressesListFilter `json:"addresses,omitempty"`

	// ConsumerId Search by consumerId
	ConsumerId *StringFilter `json:"consumerId,omitempty"`
}

OrderConsumerFilter OrderConsumerFilter

type OrderDeliveryPreferencesCollectFilter

type OrderDeliveryPreferencesCollectFilter struct {
	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Paid Search by paid
	Paid *BooleanFilter `json:"paid,omitempty"`
}

OrderDeliveryPreferencesCollectFilter OrderDeliveryPreferencesCollectFilter

type OrderDeliveryPreferencesCollectListFilter

type OrderDeliveryPreferencesCollectListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *OrderDeliveryPreferencesCollectFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

OrderDeliveryPreferencesCollectListFilter OrderDeliveryPreferencesCollectListFilter

type OrderDeliveryPreferencesFilter

type OrderDeliveryPreferencesFilter struct {
	// Collect Nested list search by collect
	Collect *OrderDeliveryPreferencesCollectListFilter `json:"collect,omitempty"`

	// Shipping Nested search by shipping
	Shipping *OrderDeliveryPreferencesShippingFilter `json:"shipping,omitempty"`
}

OrderDeliveryPreferencesFilter OrderDeliveryPreferencesFilter

type OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter

type OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter struct {
	// Eq Search by serviceLevel
	Eq *OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEq `json:"eq,omitempty"`

	// In Search by serviceLevel
	In *[]OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by serviceLevel
	NotEq *OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEq `json:"notEq,omitempty"`
}

OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter

type OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEq

type OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEq string

OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEq Search by serviceLevel

const (
	OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEqDELIVERY OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEq = "DELIVERY"
	OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEqSAMEDAY  OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEq = "SAMEDAY"
)

Defines values for OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEq.

func (OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEq) Valid

Valid indicates whether the value is a known member of the OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterEq enum.

type OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterIn

type OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterIn string

OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterIn defines model for OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter.In.

const (
	OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterInDELIVERY OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterIn = "DELIVERY"
	OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterInSAMEDAY  OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterIn = "SAMEDAY"
)

Defines values for OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterIn.

func (OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterIn) Valid

Valid indicates whether the value is a known member of the OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterIn enum.

type OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEq

type OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEq string

OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEq Search by serviceLevel

const (
	OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEqDELIVERY OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEq = "DELIVERY"
	OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEqSAMEDAY  OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEq = "SAMEDAY"
)

Defines values for OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEq.

func (OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilterNotEq enum.

type OrderDeliveryPreferencesShippingFilter

type OrderDeliveryPreferencesShippingFilter struct {
	// DesiredDeliveryTime Search by desiredDeliveryTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	DesiredDeliveryTime *DateFilter `json:"desiredDeliveryTime,omitempty"`

	// ServiceLevel Search by serviceLevel
	ServiceLevel *OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter `json:"serviceLevel,omitempty"`
}

OrderDeliveryPreferencesShippingFilter OrderDeliveryPreferencesShippingFilter

type OrderForCreation added in v0.3.0

type OrderForCreation struct {
	// Consumer OrderForCreationConsumer
	Consumer OrderForCreationConsumer `json:"consumer"`

	// CustomAttributes Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{}              `json:"customAttributes,omitempty"`
	CustomServices   *[]CustomServiceReferenceForCreation `json:"customServices,omitempty"`

	// DeliveryPreferences DeliveryPreferences
	DeliveryPreferences *DeliveryPreferences `json:"deliveryPreferences,omitempty"`

	// OrderDate The date this order was created at the supplying system.
	//
	// Example: 2020-02-03T08:45:50.525Z
	OrderDate      time.Time                  `json:"orderDate"`
	OrderLineItems []OrderLineItemForCreation `json:"orderLineItems"`

	// PaymentInfo OrderPaymentInfoForCreation
	PaymentInfo *OrderPaymentInfoForCreation `json:"paymentInfo,omitempty"`

	// Pricing This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />
	Pricing *OrderPricingForCreation `json:"pricing,omitempty"`

	// PromisesOptions OrderPromisesOptions
	PromisesOptions *OrderPromisesOptions `json:"promisesOptions,omitempty"`

	// Source Defines the source of this order. This field is not required, if the order is created based on an external system.
	Source *OrderForCreation_Source `json:"source,omitempty"`

	// Status The state of the order. Initially it is OPEN.
	Status        *OrderStatus         `json:"status,omitempty"`
	StatusReasons *[]OrderStatusReason `json:"statusReasons,omitempty"`
	Stickers      *[]Sticker           `json:"stickers,omitempty"`
	Tags          *[]TagReference      `json:"tags,omitempty"`

	// TenantOrderId Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
	//
	// Example: R456728546
	TenantOrderId *string `json:"tenantOrderId,omitempty"`
}

OrderForCreation OrderForCreation

type OrderForCreationConsumer added in v0.3.0

type OrderForCreationConsumer struct {
	Addresses *[]ConsumerAddress `json:"addresses,omitempty"`

	// ConsumerId The id of the consumer.
	//
	// Example: e4213a07-f563-46a3-b1ba-4dfeb6abe82a
	ConsumerId *string `json:"consumerId,omitempty"`

	// CustomAttributes Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Email @deprecated The email address of the consumer. Use email in addresses array
	//
	//
	// Example: max@speedyboxales.com
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Email *openapi_types.Email `json:"email,omitempty"`

	// FacilityRef ID of the facility, if the recipient is a facility.
	//
	// Example: e4213a07-f563-46a3-b1ba-4dfeb6abe82a
	FacilityRef *string `json:"facilityRef,omitempty"`

	// TenantFacilityId tenantFacilityId of the facility, if the recipient is a facility
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`
}

OrderForCreationConsumer OrderForCreationConsumer

type OrderForCreation_Source added in v0.3.0

type OrderForCreation_Source struct {
	// contains filtered or unexported fields
}

OrderForCreation_Source Defines the source of this order. This field is not required, if the order is created based on an external system.

func (OrderForCreation_Source) AsSourceRef added in v0.3.0

func (t OrderForCreation_Source) AsSourceRef() (SourceRef, error)

AsSourceRef returns the union data inside the OrderForCreation_Source as a SourceRef

func (OrderForCreation_Source) AsTenantSourceId added in v0.3.0

func (t OrderForCreation_Source) AsTenantSourceId() (TenantSourceId, error)

AsTenantSourceId returns the union data inside the OrderForCreation_Source as a TenantSourceId

func (*OrderForCreation_Source) FromSourceRef added in v0.3.0

func (t *OrderForCreation_Source) FromSourceRef(v SourceRef) error

FromSourceRef overwrites any union data inside the OrderForCreation_Source as the provided SourceRef

func (*OrderForCreation_Source) FromTenantSourceId added in v0.3.0

func (t *OrderForCreation_Source) FromTenantSourceId(v TenantSourceId) error

FromTenantSourceId overwrites any union data inside the OrderForCreation_Source as the provided TenantSourceId

func (OrderForCreation_Source) MarshalJSON added in v0.3.0

func (t OrderForCreation_Source) MarshalJSON() ([]byte, error)

func (*OrderForCreation_Source) MergeSourceRef added in v0.3.0

func (t *OrderForCreation_Source) MergeSourceRef(v SourceRef) error

MergeSourceRef performs a merge with any union data inside the OrderForCreation_Source, using the provided SourceRef

func (*OrderForCreation_Source) MergeTenantSourceId added in v0.3.0

func (t *OrderForCreation_Source) MergeTenantSourceId(v TenantSourceId) error

MergeTenantSourceId performs a merge with any union data inside the OrderForCreation_Source, using the provided TenantSourceId

func (*OrderForCreation_Source) UnmarshalJSON added in v0.3.0

func (t *OrderForCreation_Source) UnmarshalJSON(b []byte) error

type OrderForSourcingOptionsRequest added in v0.2.0

type OrderForSourcingOptionsRequest struct {
	// Consumer ConsumerAddressesForSourcingOptions
	Consumer ConsumerAddressesForSourcingOptions `json:"consumer"`

	// CustomAttributes Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{}              `json:"customAttributes,omitempty"`
	CustomServices   *[]CustomServiceReferenceForCreation `json:"customServices,omitempty"`

	// DeliveryPreferences DeliveryPreferences
	DeliveryPreferences *DeliveryPreferences `json:"deliveryPreferences,omitempty"`

	// OrderDate The date this order was created at the supplying system.
	//
	// Example: 2020-02-03T08:45:50.525Z
	OrderDate      *time.Time                  `json:"orderDate,omitempty"`
	OrderLineItems *[]OrderLineItemForCreation `json:"orderLineItems,omitempty"`

	// PaymentInfo OrderPaymentInfoForCreation
	PaymentInfo *OrderPaymentInfoForCreation `json:"paymentInfo,omitempty"`

	// PromisesOptions OrderPromisesOptions
	PromisesOptions *OrderPromisesOptions `json:"promisesOptions,omitempty"`

	// Status The state of the order. Initially it is OPEN.
	Status        *OrderStatus         `json:"status,omitempty"`
	StatusReasons *[]OrderStatusReason `json:"statusReasons,omitempty"`
	Stickers      *[]Sticker           `json:"stickers,omitempty"`
	Tags          *[]TagReference      `json:"tags,omitempty"`

	// TenantOrderId Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
	//
	// Example: R456728546
	TenantOrderId *string `json:"tenantOrderId,omitempty"`
}

OrderForSourcingOptionsRequest OrderForSourcingOptionsRequest

type OrderForUpdate added in v0.3.0

type OrderForUpdate struct {
	// Comment A comment for updating this order.
	Comment *string `json:"comment,omitempty"`

	// Consumer OrderForCreationConsumer
	Consumer *OrderForCreationConsumer `json:"consumer,omitempty"`

	// CustomAttributes Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// OrderLineItems Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.
	OrderLineItems *[]OrderLineItemForUpdate `json:"orderLineItems,omitempty"`

	// PreferredHandlingTime Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.
	//
	// Example: 2025-01-15T00:00:00.000Z
	PreferredHandlingTime *time.Time `json:"preferredHandlingTime,omitempty"`

	// Pricing This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />
	Pricing *OrderPricingForCreation `json:"pricing,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

OrderForUpdate OrderForUpdate

type OrderForceCancelActionParameter added in v0.3.0

type OrderForceCancelActionParameter struct {
	Name OrderForceCancelActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

OrderForceCancelActionParameter Action to force cancel an order.

type OrderForceCancelActionParameterName added in v0.8.0

type OrderForceCancelActionParameterName string

OrderForceCancelActionParameterName defines model for OrderForceCancelActionParameter.Name.

const (
	OrderForceCancelActionParameterNameFORCECANCEL OrderForceCancelActionParameterName = "FORCE_CANCEL"
)

Defines values for OrderForceCancelActionParameterName.

func (OrderForceCancelActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the OrderForceCancelActionParameterName enum.

type OrderInvalidationActionParameter added in v0.8.0

type OrderInvalidationActionParameter struct {
	Name OrderInvalidationActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

OrderInvalidationActionParameter Action to Invalidate an order.

type OrderInvalidationActionParameterName added in v0.8.0

type OrderInvalidationActionParameterName string

OrderInvalidationActionParameterName defines model for OrderInvalidationActionParameter.Name.

const (
	INVALIDATEPROMISE OrderInvalidationActionParameterName = "INVALIDATE_PROMISE"
)

Defines values for OrderInvalidationActionParameterName.

func (OrderInvalidationActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the OrderInvalidationActionParameterName enum.

type OrderLineItem added in v0.3.0

type OrderLineItem struct {
	// AllowedSubstitutes Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available
	AllowedSubstitutes *[]Substitute `json:"allowedSubstitutes,omitempty"`

	// Article OrderLineItemArticle
	Article OrderLineItemArticle `json:"article"`

	// CustomAttributes Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Id The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.
	//
	// Example: LGMl2DuvPnfPoSHhYFOm
	Id string `json:"id"`

	// MeasurementUnitKey Identifier for items unit of measurement.
	//
	// Example: liter
	MeasurementUnitKey *string `json:"measurementUnitKey,omitempty"`

	// MeasurementValidation MeasurementValidation
	MeasurementValidation *MeasurementValidation `json:"measurementValidation,omitempty"`

	// Quantity quantity of the specific article that has been ordered
	//
	// Example: 21
	Quantity       int64     `json:"quantity"`
	ScannableCodes *[]string `json:"scannableCodes,omitempty"`

	// SecondaryMeasurementUnitKey Secondary identifier for items unit of measurement.
	//
	// Example: liter
	SecondaryMeasurementUnitKey *string `json:"secondaryMeasurementUnitKey,omitempty"`

	// SecondaryQuantity Secondary quantity of the specific article that has been ordered
	//
	// Example: 21
	SecondaryQuantity *int64 `json:"secondaryQuantity,omitempty"`

	// ShopPrice @deprecated price per piece of this line item Use attributes instead (see: <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes">customization by attributes</a>)
	//
	//
	// Example: 1200
	ShopPrice *float32        `json:"shopPrice,omitempty"`
	Tags      *[]TagReference `json:"tags,omitempty"`
}

OrderLineItem OrderLineItem

type OrderLineItemActionJSONRequestBody added in v0.3.0

type OrderLineItemActionJSONRequestBody = OrderLineItemActionsParameter

OrderLineItemActionJSONRequestBody defines body for OrderLineItemAction for application/json ContentType.

type OrderLineItemActionResponse added in v0.3.0

type OrderLineItemActionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Order
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseOrderLineItemActionResponse added in v0.3.0

func ParseOrderLineItemActionResponse(rsp *http.Response) (*OrderLineItemActionResponse, error)

ParseOrderLineItemActionResponse parses an HTTP response from a OrderLineItemActionWithResponse call

func (OrderLineItemActionResponse) ContentType added in v0.3.0

func (r OrderLineItemActionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (OrderLineItemActionResponse) GetBody added in v0.8.0

func (r OrderLineItemActionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (OrderLineItemActionResponse) GetJSON200 added in v0.8.0

func (r OrderLineItemActionResponse) GetJSON200() *Order

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (OrderLineItemActionResponse) GetJSON401 added in v0.8.0

func (r OrderLineItemActionResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (OrderLineItemActionResponse) GetJSON403 added in v0.8.0

func (r OrderLineItemActionResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (OrderLineItemActionResponse) Status added in v0.3.0

Status returns HTTPResponse.Status

func (OrderLineItemActionResponse) StatusCode added in v0.3.0

func (r OrderLineItemActionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type OrderLineItemActionsParameter added in v0.3.0

type OrderLineItemActionsParameter struct {
	// contains filtered or unexported fields
}

OrderLineItemActionsParameter OrderLineItemActionsParameter

func (OrderLineItemActionsParameter) AsOrderLineItemCustomAttributesUpdateParameter added in v0.3.0

func (t OrderLineItemActionsParameter) AsOrderLineItemCustomAttributesUpdateParameter() (OrderLineItemCustomAttributesUpdateParameter, error)

AsOrderLineItemCustomAttributesUpdateParameter returns the union data inside the OrderLineItemActionsParameter as a OrderLineItemCustomAttributesUpdateParameter

func (*OrderLineItemActionsParameter) FromOrderLineItemCustomAttributesUpdateParameter added in v0.3.0

func (t *OrderLineItemActionsParameter) FromOrderLineItemCustomAttributesUpdateParameter(v OrderLineItemCustomAttributesUpdateParameter) error

FromOrderLineItemCustomAttributesUpdateParameter overwrites any union data inside the OrderLineItemActionsParameter as the provided OrderLineItemCustomAttributesUpdateParameter

func (OrderLineItemActionsParameter) MarshalJSON added in v0.3.0

func (t OrderLineItemActionsParameter) MarshalJSON() ([]byte, error)

func (*OrderLineItemActionsParameter) MergeOrderLineItemCustomAttributesUpdateParameter added in v0.3.0

func (t *OrderLineItemActionsParameter) MergeOrderLineItemCustomAttributesUpdateParameter(v OrderLineItemCustomAttributesUpdateParameter) error

MergeOrderLineItemCustomAttributesUpdateParameter performs a merge with any union data inside the OrderLineItemActionsParameter, using the provided OrderLineItemCustomAttributesUpdateParameter

func (*OrderLineItemActionsParameter) UnmarshalJSON added in v0.3.0

func (t *OrderLineItemActionsParameter) UnmarshalJSON(b []byte) error

type OrderLineItemArticle added in v0.2.0

type OrderLineItemArticle struct {
	// Attributes Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.
	// Details about usage can be found in the<a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes">article attributes article</a>.
	Attributes *[]OrderArticleAttributeItem `json:"attributes,omitempty"`

	// CustomAttributes @deprecated Please use customAttributes in OrderLineItem.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// ImageUrl A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.
	//
	// Example: https://example.com/resource
	ImageUrl *string `json:"imageUrl,omitempty"`

	// TenantArticleId This is a reference to an article number
	//
	// Example: 4711
	TenantArticleId string `json:"tenantArticleId"`

	// Title The title of the product
	//
	// Example: Cologne Water
	Title string `json:"title"`

	// TitleLocalized The translations for the title of the product
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Weight Weight value is in gram
	Weight *float32 `json:"weight,omitempty"`
}

OrderLineItemArticle OrderLineItemArticle

type OrderLineItemArticleForCreation added in v0.9.0

type OrderLineItemArticleForCreation struct {
	// Attributes Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.
	// Details about usage can be found in the<a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes">article attributes article</a>.
	Attributes *[]OrderArticleAttributeItemForUpsert `json:"attributes,omitempty"`

	// CustomAttributes @deprecated Please use customAttributes in OrderLineItem.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// ImageUrl A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.
	//
	// Example: https://example.com/resource
	ImageUrl *string `json:"imageUrl,omitempty"`

	// TenantArticleId This is a reference to an article number
	//
	// Example: 4711
	TenantArticleId string `json:"tenantArticleId"`

	// Title The title of the product
	//
	// Example: Cologne Water
	Title string `json:"title"`

	// TitleLocalized The translations for the title of the product
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Weight Weight value is in gram
	Weight *float32 `json:"weight,omitempty"`
}

OrderLineItemArticleForCreation OrderLineItemArticleForCreation

type OrderLineItemArticleForUpdate added in v0.3.0

type OrderLineItemArticleForUpdate struct {
	// Attributes Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.
	// Details about usage can be found in the <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes">article attributes article</a>.
	Attributes *[]OrderArticleAttributeItemForUpsert `json:"attributes,omitempty"`

	// CustomAttributes @deprecated Please use customAttributes in OrderLineItem.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// ImageUrl A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.
	//
	// Example: https://example.com/resource
	ImageUrl *string `json:"imageUrl,omitempty"`

	// TenantArticleId This is a reference to an article number
	//
	// Example: 4711
	TenantArticleId *string `json:"tenantArticleId,omitempty"`

	// Title The title of the product
	//
	// Example: Cologne Water
	Title string `json:"title"`

	// TitleLocalized The translations for the title of the product
	TitleLocalized *LocaleString `json:"titleLocalized,omitempty"`

	// Weight Weight value is in gram
	Weight *float32 `json:"weight,omitempty"`
}

OrderLineItemArticleForUpdate OrderLineItemArticleForUpdate

type OrderLineItemCustomAttributesUpdateParameter added in v0.3.0

type OrderLineItemCustomAttributesUpdateParameter struct {
	// CustomAttributes Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here. If no customAttributes exist yet, they will be created for this line item.
	CustomAttributes map[string]interface{}                           `json:"customAttributes"`
	Name             OrderLineItemCustomAttributesUpdateParameterName `json:"name"`

	// Version Version of the order to be changed
	Version int `json:"version"`
}

OrderLineItemCustomAttributesUpdateParameter Action to update custom attributes of an order.

type OrderLineItemCustomAttributesUpdateParameterName added in v0.8.0

type OrderLineItemCustomAttributesUpdateParameterName string

OrderLineItemCustomAttributesUpdateParameterName defines model for OrderLineItemCustomAttributesUpdateParameter.Name.

const (
	UPDATECUSTOMATTRIBUTES OrderLineItemCustomAttributesUpdateParameterName = "UPDATE_CUSTOM_ATTRIBUTES"
)

Defines values for OrderLineItemCustomAttributesUpdateParameterName.

func (OrderLineItemCustomAttributesUpdateParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the OrderLineItemCustomAttributesUpdateParameterName enum.

type OrderLineItemForCreation added in v0.2.0

type OrderLineItemForCreation struct {
	// AllowedSubstitutes Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available
	AllowedSubstitutes *[]Substitute `json:"allowedSubstitutes,omitempty"`

	// Article OrderLineItemArticleForCreation
	Article OrderLineItemArticleForCreation `json:"article"`

	// CustomAttributes Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// MeasurementUnitKey Identifier for items unit of measurement.
	//
	// Example: liter
	MeasurementUnitKey *string `json:"measurementUnitKey,omitempty"`

	// MeasurementValidation MeasurementValidation
	MeasurementValidation *MeasurementValidation `json:"measurementValidation,omitempty"`

	// Quantity quantity of the specific article that has been ordered
	//
	// Example: 21
	Quantity       int64     `json:"quantity"`
	ScannableCodes *[]string `json:"scannableCodes,omitempty"`

	// SecondaryMeasurementUnitKey Secondary identifier for items unit of measurement.
	//
	// Example: liter
	SecondaryMeasurementUnitKey *string `json:"secondaryMeasurementUnitKey,omitempty"`

	// SecondaryQuantity Secondary quantity of the specific article that has been ordered
	//
	// Example: 21
	SecondaryQuantity *int64 `json:"secondaryQuantity,omitempty"`

	// ShopPrice @deprecated price per piece of this line item Use attributes instead (see: <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes">customization by attributes</a>)
	//
	//
	// Example: 1200
	ShopPrice *float32        `json:"shopPrice,omitempty"`
	Tags      *[]TagReference `json:"tags,omitempty"`
}

OrderLineItemForCreation OrderLineItemForCreation

type OrderLineItemForUpdate added in v0.3.0

type OrderLineItemForUpdate struct {
	// Article OrderLineItemArticleForUpdate
	Article *OrderLineItemArticleForUpdate `json:"article,omitempty"`

	// Id The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.
	Id *string `json:"id,omitempty"`

	// Quantity The quantity of this order line item.
	//
	// Example: 2
	Quantity *float32 `json:"quantity,omitempty"`
}

OrderLineItemForUpdate OrderLineItemForUpdate

type OrderOrderLineItemsArticleFilter

type OrderOrderLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`

	// Title Search by title
	Title *StringFilter `json:"title,omitempty"`

	// TitleLocalized Nested search by titleLocalized
	TitleLocalized *OrderOrderLineItemsArticleTitleLocalizedFilter `json:"titleLocalized,omitempty"`
}

OrderOrderLineItemsArticleFilter OrderOrderLineItemsArticleFilter

type OrderOrderLineItemsArticleTitleLocalizedFilter

type OrderOrderLineItemsArticleTitleLocalizedFilter struct {
	// DeDE Search by de_DE
	DeDE *StringFilter `json:"de_DE,omitempty"`

	// EnUS Search by en_US
	EnUS *StringFilter `json:"en_US,omitempty"`

	// RuRU Search by ru_RU
	RuRU *StringFilter `json:"ru_RU,omitempty"`
}

OrderOrderLineItemsArticleTitleLocalizedFilter OrderOrderLineItemsArticleTitleLocalizedFilter

type OrderOrderLineItemsFilter

type OrderOrderLineItemsFilter struct {
	// Article Nested search by article
	Article *OrderOrderLineItemsArticleFilter `json:"article,omitempty"`
}

OrderOrderLineItemsFilter OrderOrderLineItemsFilter

type OrderOrderLineItemsListFilter

type OrderOrderLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *OrderOrderLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

OrderOrderLineItemsListFilter OrderOrderLineItemsListFilter

type OrderPaginatedResult added in v0.3.0

type OrderPaginatedResult struct {
	Orders []Order `json:"orders"`

	// PageInfo Pagination information for the search result.
	PageInfo PageInfo `json:"pageInfo"`

	// Total The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
	Total *float32 `json:"total,omitempty"`
}

OrderPaginatedResult OrderPaginatedResult

type OrderPaymentInfo added in v0.3.0

type OrderPaymentInfo struct {
	// Currency The currency in which the consumer paid with
	//
	// Example: EUR
	Currency *string `json:"currency,omitempty"`

	// Method Localized value from methodLocalized
	//
	// Example: Credit Card
	Method *string `json:"method,omitempty"`

	// MethodLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	MethodLocalized *LocaleString `json:"methodLocalized,omitempty"`
}

OrderPaymentInfo OrderPaymentInfo

type OrderPaymentInfoFilter

type OrderPaymentInfoFilter struct {
	// Currency Search by currency
	Currency *StringFilter `json:"currency,omitempty"`

	// Method Search by method
	Method *StringFilter `json:"method,omitempty"`

	// MethodLocalized Nested search by methodLocalized
	MethodLocalized *OrderPaymentInfoMethodLocalizedFilter `json:"methodLocalized,omitempty"`
}

OrderPaymentInfoFilter OrderPaymentInfoFilter

type OrderPaymentInfoForCreation added in v0.2.0

type OrderPaymentInfoForCreation struct {
	// Currency The currency in which the consumer paid with
	//
	// Example: EUR
	Currency *string `json:"currency,omitempty"`

	// MethodLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	MethodLocalized *LocaleString `json:"methodLocalized,omitempty"`
}

OrderPaymentInfoForCreation OrderPaymentInfoForCreation

type OrderPaymentInfoMethodLocalizedFilter

type OrderPaymentInfoMethodLocalizedFilter struct {
	// DeDE Search by de_DE
	DeDE *StringFilter `json:"de_DE,omitempty"`

	// EnUS Search by en_US
	EnUS *StringFilter `json:"en_US,omitempty"`

	// RuRU Search by ru_RU
	RuRU *StringFilter `json:"ru_RU,omitempty"`
}

OrderPaymentInfoMethodLocalizedFilter OrderPaymentInfoMethodLocalizedFilter

type OrderPricing added in v0.3.0

type OrderPricing struct {
	Discounts *[]OrderPricingDiscount `json:"discounts,omitempty"`
	Fees      *[]OrderPricingFee      `json:"fees,omitempty"`
	Taxes     *[]OrderPricingTax      `json:"taxes,omitempty"`

	// Total This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal
	Total *OrderPricingTotal `json:"total,omitempty"`
}

OrderPricing This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.

type OrderPricingDiscount added in v0.3.0

type OrderPricingDiscount struct {
	// Code Discount code
	Code *string `json:"code,omitempty"`

	// Context Context of the discount
	Context *string `json:"context,omitempty"`

	// Name Name of the discount
	Name *string `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized *LocaleString `json:"nameLocalized,omitempty"`

	// Percentage Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).
	Percentage *float32 `json:"percentage,omitempty"`

	// TenantDiscountId Tenant-specific discount identifier
	TenantDiscountId *string `json:"tenantDiscountId,omitempty"`

	// Type Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.
	Type *OrderPricingDiscountType `json:"type,omitempty"`

	// Value MonetaryValue
	Value *MonetaryValue `json:"value,omitempty"`
}

OrderPricingDiscount This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount

type OrderPricingDiscountType added in v0.3.0

type OrderPricingDiscountType string

OrderPricingDiscountType Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.

const (
	OrderPricingDiscountTypeABSOLUTE   OrderPricingDiscountType = "ABSOLUTE"
	OrderPricingDiscountTypePERCENTAGE OrderPricingDiscountType = "PERCENTAGE"
)

Defines values for OrderPricingDiscountType.

func (OrderPricingDiscountType) Valid added in v0.3.0

func (e OrderPricingDiscountType) Valid() bool

Valid indicates whether the value is a known member of the OrderPricingDiscountType enum.

type OrderPricingFee added in v0.3.0

type OrderPricingFee struct {
	// Name Name of the fee
	Name *string `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized *LocaleString `json:"nameLocalized,omitempty"`

	// Value MonetaryValue
	Value *MonetaryValue `json:"value,omitempty"`
}

OrderPricingFee This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />OrderPricingFee

type OrderPricingForCreation added in v0.3.0

type OrderPricingForCreation struct {
	Discounts *[]OrderPricingDiscount `json:"discounts,omitempty"`
	Fees      *[]OrderPricingFee      `json:"fees,omitempty"`
	Taxes     *[]OrderPricingTax      `json:"taxes,omitempty"`
}

OrderPricingForCreation This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.

type OrderPricingTax added in v0.3.0

type OrderPricingTax struct {
	// RatePercent Tax rate as percentage
	RatePercent *float32 `json:"ratePercent,omitempty"`

	// Scope Scope of the tax
	Scope *string `json:"scope,omitempty"`

	// TaxableValue MonetaryValue
	TaxableValue *MonetaryValue `json:"taxableValue,omitempty"`

	// Type Tax type identifier
	Type *string `json:"type,omitempty"`

	// Value MonetaryValue
	Value MonetaryValue `json:"value"`
}

OrderPricingTax This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />OrderPricingTax

type OrderPricingTotal added in v0.3.0

type OrderPricingTotal struct {
	// PriceBreakdown This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.
	PriceBreakdown *OrderPricingTotals `json:"priceBreakdown,omitempty"`
}

OrderPricingTotal This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal

type OrderPricingTotals added in v0.3.0

type OrderPricingTotals struct {
	SubTotal                *MonetaryValue       `json:"subTotal,omitempty"`
	Total                   *MonetaryValue       `json:"total,omitempty"`
	TotalDiscounts          *OrderTotalDiscounts `json:"totalDiscounts,omitempty"`
	TotalFees               *MonetaryValue       `json:"totalFees,omitempty"`
	TotalLineItemSurcharges *MonetaryValue       `json:"totalLineItemSurcharges,omitempty"`
	TotalTaxes              *MonetaryValue       `json:"totalTaxes,omitempty"`
}

OrderPricingTotals This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.

type OrderPromisesOptions added in v0.2.0

type OrderPromisesOptions struct {
	// ValidUntil The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.
	//
	// Example: 2020-02-03T08:45:50.525Z
	ValidUntil time.Time `json:"validUntil"`
}

OrderPromisesOptions OrderPromisesOptions

type OrderRecordConsumerAddressesFilter

type OrderRecordConsumerAddressesFilter struct {
	// CompanyName Search by companyName
	CompanyName *StringFilter `json:"companyName,omitempty"`

	// LastName Search by lastName
	LastName *StringFilter `json:"lastName,omitempty"`
}

OrderRecordConsumerAddressesFilter OrderRecordConsumerAddressesFilter

type OrderRecordConsumerAddressesListFilter

type OrderRecordConsumerAddressesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *OrderRecordConsumerAddressesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

OrderRecordConsumerAddressesListFilter OrderRecordConsumerAddressesListFilter

type OrderRecordConsumerFilter

type OrderRecordConsumerFilter struct {
	// Addresses Nested list search by addresses
	Addresses *OrderRecordConsumerAddressesListFilter `json:"addresses,omitempty"`

	// ConsumerId Search by consumerId
	ConsumerId *StringFilter `json:"consumerId,omitempty"`
}

OrderRecordConsumerFilter OrderRecordConsumerFilter

type OrderRecordLineItemsArticleFilter

type OrderRecordLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`
}

OrderRecordLineItemsArticleFilter OrderRecordLineItemsArticleFilter

type OrderRecordLineItemsFilter

type OrderRecordLineItemsFilter struct {
	// Article Nested search by article
	Article *OrderRecordLineItemsArticleFilter `json:"article,omitempty"`
}

OrderRecordLineItemsFilter OrderRecordLineItemsFilter

type OrderRecordLineItemsListFilter

type OrderRecordLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *OrderRecordLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

OrderRecordLineItemsListFilter OrderRecordLineItemsListFilter

type OrderRecordOriginFilter

type OrderRecordOriginFilter struct {
	// CashierId Search by cashierId
	CashierId *StringFilter `json:"cashierId,omitempty"`

	// TerminalId Search by terminalId
	TerminalId *StringFilter `json:"terminalId,omitempty"`
}

OrderRecordOriginFilter OrderRecordOriginFilter

type OrderRecordPaymentsFilter

type OrderRecordPaymentsFilter struct {
	// ReceiptNumber Search by receiptNumber
	ReceiptNumber *StringFilter `json:"receiptNumber,omitempty"`

	// TransactionId Search by transactionId
	TransactionId *StringFilter `json:"transactionId,omitempty"`
}

OrderRecordPaymentsFilter OrderRecordPaymentsFilter

type OrderRecordPaymentsListFilter

type OrderRecordPaymentsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *OrderRecordPaymentsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

OrderRecordPaymentsListFilter OrderRecordPaymentsListFilter

type OrderRecordSearchQuery

type OrderRecordSearchQuery struct {
	And *[]OrderRecordSearchQuery `json:"and,omitempty"`

	// Consumer Nested search by consumer
	Consumer *OrderRecordConsumerFilter `json:"consumer,omitempty"`

	// FacilityName Search by facilityName
	FacilityName *StringFilter `json:"facilityName,omitempty"`

	// LineItems Nested list search by lineItems
	LineItems *OrderRecordLineItemsListFilter `json:"lineItems,omitempty"`
	Or        *[]OrderRecordSearchQuery       `json:"or,omitempty"`

	// OrderRecordDate Search by orderRecordDate
	//
	// Example: 2026-06-17T12:00:00.000Z
	OrderRecordDate *DateFilter `json:"orderRecordDate,omitempty"`

	// Origin Nested search by origin
	Origin *OrderRecordOriginFilter `json:"origin,omitempty"`

	// Payments Nested list search by payments
	Payments *OrderRecordPaymentsListFilter `json:"payments,omitempty"`

	// TenantOrderRecordId Search by tenantOrderRecordId
	//
	// Example: MY_ORDERRECORD_ID
	TenantOrderRecordId *StringFilter `json:"tenantOrderRecordId,omitempty"`
}

OrderRecordSearchQuery OrderRecordSearchQuery

type OrderSearchPayload added in v0.3.0

type OrderSearchPayload struct {
	// After 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`.
	After *string `json:"after,omitempty"`

	// Before 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).
	Before *string `json:"before,omitempty"`

	// Last Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
	Last *float32 `json:"last,omitempty"`

	// Options SearchOptions
	Options *SearchOptions `json:"options,omitempty"`

	// Query OrderSearchQuery
	Query OrderSearchQuery `json:"query"`

	// Size Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
	//
	// Example: 10
	Size *float32 `json:"size,omitempty"`

	// Sort Use for sorting the result.
	Sort *[]OrderSort `json:"sort,omitempty"`

	// StartAfterId The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	StartAfterId *string `json:"startAfterId,omitempty"`
}

OrderSearchPayload OrderSearchPayload

type OrderSearchQuery

type OrderSearchQuery struct {
	And *[]OrderSearchQuery `json:"and,omitempty"`

	// Consumer Nested search by consumer
	Consumer *OrderConsumerFilter `json:"consumer,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]OrderSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// DeliveryPreferences Nested search by deliveryPreferences
	DeliveryPreferences *OrderDeliveryPreferencesFilter `json:"deliveryPreferences,omitempty"`
	Or                  *[]OrderSearchQuery             `json:"or,omitempty"`

	// OrderDate Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	//
	// Example: 2026-06-17T12:00:00.000Z
	OrderDate *DateFilter `json:"orderDate,omitempty"`

	// OrderLineItems Nested list search by orderLineItems
	OrderLineItems *OrderOrderLineItemsListFilter `json:"orderLineItems,omitempty"`

	// PaymentInfo Nested search by paymentInfo
	PaymentInfo *OrderPaymentInfoFilter `json:"paymentInfo,omitempty"`

	// Status Search by status
	Status *OrderStatusEnumFilter `json:"status,omitempty"`

	// Tags Nested list search by tags
	Tags *OrderTagsListFilter `json:"tags,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringFilter `json:"tenantOrderId,omitempty"`
}

OrderSearchQuery OrderSearchQuery

type OrderSearchQuery_CustomAttributes_AdditionalProperties

type OrderSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

OrderSearchQuery_CustomAttributes_AdditionalProperties defines model for OrderSearchQuery.customAttributes.AdditionalProperties.

func (OrderSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (OrderSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (OrderSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (OrderSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*OrderSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*OrderSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*OrderSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*OrderSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (OrderSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*OrderSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*OrderSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*OrderSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*OrderSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the OrderSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*OrderSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type OrderSort added in v0.3.0

type OrderSort struct {
	OrderDate *OrderSortOrderDate `json:"orderDate,omitempty"`
	Status    *OrderSortStatus    `json:"status,omitempty"`
}

OrderSort OrderSort

type OrderSortOrderDate added in v0.3.0

type OrderSortOrderDate string

OrderSortOrderDate defines model for OrderSort.OrderDate.

const (
	OrderSortOrderDateASC  OrderSortOrderDate = "ASC"
	OrderSortOrderDateDESC OrderSortOrderDate = "DESC"
)

Defines values for OrderSortOrderDate.

func (OrderSortOrderDate) Valid added in v0.3.0

func (e OrderSortOrderDate) Valid() bool

Valid indicates whether the value is a known member of the OrderSortOrderDate enum.

type OrderSortStatus added in v0.3.0

type OrderSortStatus string

OrderSortStatus defines model for OrderSort.Status.

const (
	OrderSortStatusASC  OrderSortStatus = "ASC"
	OrderSortStatusDESC OrderSortStatus = "DESC"
)

Defines values for OrderSortStatus.

func (OrderSortStatus) Valid added in v0.3.0

func (e OrderSortStatus) Valid() bool

Valid indicates whether the value is a known member of the OrderSortStatus enum.

type OrderStatus added in v0.2.0

type OrderStatus string

OrderStatus The state of the order. Initially it is OPEN.

const (
	OrderStatusCANCELLED OrderStatus = "CANCELLED"
	OrderStatusLOCKED    OrderStatus = "LOCKED"
	OrderStatusOBSOLETE  OrderStatus = "OBSOLETE"
	OrderStatusOPEN      OrderStatus = "OPEN"
	OrderStatusPROMISED  OrderStatus = "PROMISED"
)

Defines values for OrderStatus.

func (OrderStatus) Valid added in v0.2.0

func (e OrderStatus) Valid() bool

Valid indicates whether the value is a known member of the OrderStatus enum.

type OrderStatusEnumFilter

type OrderStatusEnumFilter struct {
	// Eq Search by status
	Eq *OrderStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]OrderStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *OrderStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

OrderStatusEnumFilter OrderStatusEnumFilter

type OrderStatusEnumFilterEq

type OrderStatusEnumFilterEq string

OrderStatusEnumFilterEq Search by status

const (
	OrderStatusEnumFilterEqCANCELLED OrderStatusEnumFilterEq = "CANCELLED"
	OrderStatusEnumFilterEqLOCKED    OrderStatusEnumFilterEq = "LOCKED"
	OrderStatusEnumFilterEqOBSOLETE  OrderStatusEnumFilterEq = "OBSOLETE"
	OrderStatusEnumFilterEqOPEN      OrderStatusEnumFilterEq = "OPEN"
	OrderStatusEnumFilterEqPROMISED  OrderStatusEnumFilterEq = "PROMISED"
)

Defines values for OrderStatusEnumFilterEq.

func (OrderStatusEnumFilterEq) Valid

func (e OrderStatusEnumFilterEq) Valid() bool

Valid indicates whether the value is a known member of the OrderStatusEnumFilterEq enum.

type OrderStatusEnumFilterIn

type OrderStatusEnumFilterIn string

OrderStatusEnumFilterIn defines model for OrderStatusEnumFilter.In.

const (
	OrderStatusEnumFilterInCANCELLED OrderStatusEnumFilterIn = "CANCELLED"
	OrderStatusEnumFilterInLOCKED    OrderStatusEnumFilterIn = "LOCKED"
	OrderStatusEnumFilterInOBSOLETE  OrderStatusEnumFilterIn = "OBSOLETE"
	OrderStatusEnumFilterInOPEN      OrderStatusEnumFilterIn = "OPEN"
	OrderStatusEnumFilterInPROMISED  OrderStatusEnumFilterIn = "PROMISED"
)

Defines values for OrderStatusEnumFilterIn.

func (OrderStatusEnumFilterIn) Valid

func (e OrderStatusEnumFilterIn) Valid() bool

Valid indicates whether the value is a known member of the OrderStatusEnumFilterIn enum.

type OrderStatusEnumFilterNotEq

type OrderStatusEnumFilterNotEq string

OrderStatusEnumFilterNotEq Search by status

const (
	OrderStatusEnumFilterNotEqCANCELLED OrderStatusEnumFilterNotEq = "CANCELLED"
	OrderStatusEnumFilterNotEqLOCKED    OrderStatusEnumFilterNotEq = "LOCKED"
	OrderStatusEnumFilterNotEqOBSOLETE  OrderStatusEnumFilterNotEq = "OBSOLETE"
	OrderStatusEnumFilterNotEqOPEN      OrderStatusEnumFilterNotEq = "OPEN"
	OrderStatusEnumFilterNotEqPROMISED  OrderStatusEnumFilterNotEq = "PROMISED"
)

Defines values for OrderStatusEnumFilterNotEq.

func (OrderStatusEnumFilterNotEq) Valid

func (e OrderStatusEnumFilterNotEq) Valid() bool

Valid indicates whether the value is a known member of the OrderStatusEnumFilterNotEq enum.

type OrderStatusReason added in v0.2.0

type OrderStatusReason struct {
	// Reason The reason for setting this order status
	Reason string `json:"reason"`

	// Status The state of the order. Initially it is OPEN.
	Status OrderStatus `json:"status"`
}

OrderStatusReason Order Status Reason.

type OrderTagsFilter

type OrderTagsFilter struct {
	// Value Search by value
	Value *StringFilter `json:"value,omitempty"`
}

OrderTagsFilter OrderTagsFilter

type OrderTagsListFilter

type OrderTagsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *OrderTagsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

OrderTagsListFilter OrderTagsListFilter

type OrderTotalDiscounts added in v0.3.0

type OrderTotalDiscounts struct {
	Breakdown *struct {
		LineItemDiscounts *MonetaryValue `json:"lineItemDiscounts,omitempty"`
		OrderDiscounts    *MonetaryValue `json:"orderDiscounts,omitempty"`
	} `json:"breakdown,omitempty"`
	Value *MonetaryValue `json:"value,omitempty"`
}

OrderTotalDiscounts This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.

type OrderUnlockActionParameter added in v0.3.0

type OrderUnlockActionParameter struct {
	Name OrderUnlockActionParameterName `json:"name"`

	// TargetTime Time to be set as a targetTime for the devlivery preferences.
	//
	// Example: 2025-01-15T00:00:00.000Z
	TargetTime *time.Time `json:"targetTime,omitempty"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

OrderUnlockActionParameter Action to unlock an order.

type OrderUnlockActionParameterName added in v0.8.0

type OrderUnlockActionParameterName string

OrderUnlockActionParameterName defines model for OrderUnlockActionParameter.Name.

const (
	OrderUnlockActionParameterNameUNLOCK OrderUnlockActionParameterName = "UNLOCK"
)

Defines values for OrderUnlockActionParameterName.

func (OrderUnlockActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the OrderUnlockActionParameterName enum.

type OrderUpdateDetail added in v0.3.0

type OrderUpdateDetail struct {
	// Changes OrderUpdateDetailChanges
	Changes OrderUpdateDetailChanges `json:"changes"`
	Comment *string                  `json:"comment,omitempty"`

	// Created The date this update was done.
	//
	// Example: 2020-02-03T08:45:50.525Z
	Created time.Time `json:"created"`
	User    *string   `json:"user,omitempty"`
}

OrderUpdateDetail OrderUpdateDetail

type OrderUpdateDetailChanges added in v0.3.0

type OrderUpdateDetailChanges struct {
	// Consumer OrderForCreationConsumer
	Consumer *OrderForCreationConsumer `json:"consumer,omitempty"`

	// CustomAttributes Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// OrderLineItems Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.
	OrderLineItems *[]OrderLineItemForUpdate `json:"orderLineItems,omitempty"`

	// PreferredHandlingTime Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.
	//
	// Example: 2025-01-15T00:00:00.000Z
	PreferredHandlingTime *time.Time `json:"preferredHandlingTime,omitempty"`
}

OrderUpdateDetailChanges OrderUpdateDetailChanges

type Order_Source added in v0.3.0

type Order_Source struct {
	// contains filtered or unexported fields
}

Order_Source Defines the source of this order. This field is not required, if the order is created based on an external system.

func (Order_Source) AsSourceRef added in v0.3.0

func (t Order_Source) AsSourceRef() (SourceRef, error)

AsSourceRef returns the union data inside the Order_Source as a SourceRef

func (Order_Source) AsTenantSourceId added in v0.3.0

func (t Order_Source) AsTenantSourceId() (TenantSourceId, error)

AsTenantSourceId returns the union data inside the Order_Source as a TenantSourceId

func (*Order_Source) FromSourceRef added in v0.3.0

func (t *Order_Source) FromSourceRef(v SourceRef) error

FromSourceRef overwrites any union data inside the Order_Source as the provided SourceRef

func (*Order_Source) FromTenantSourceId added in v0.3.0

func (t *Order_Source) FromTenantSourceId(v TenantSourceId) error

FromTenantSourceId overwrites any union data inside the Order_Source as the provided TenantSourceId

func (Order_Source) MarshalJSON added in v0.3.0

func (t Order_Source) MarshalJSON() ([]byte, error)

func (*Order_Source) MergeSourceRef added in v0.3.0

func (t *Order_Source) MergeSourceRef(v SourceRef) error

MergeSourceRef performs a merge with any union data inside the Order_Source, using the provided SourceRef

func (*Order_Source) MergeTenantSourceId added in v0.3.0

func (t *Order_Source) MergeTenantSourceId(v TenantSourceId) error

MergeTenantSourceId performs a merge with any union data inside the Order_Source, using the provided TenantSourceId

func (*Order_Source) UnmarshalJSON added in v0.3.0

func (t *Order_Source) UnmarshalJSON(b []byte) error

type Order_WorkflowInformation added in v0.3.0

type Order_WorkflowInformation struct {
	// contains filtered or unexported fields
}

Order_WorkflowInformation defines model for Order.WorkflowInformation.

func (Order_WorkflowInformation) AsWorkflowInformation added in v0.3.0

func (t Order_WorkflowInformation) AsWorkflowInformation() (WorkflowInformation, error)

AsWorkflowInformation returns the union data inside the Order_WorkflowInformation as a WorkflowInformation

func (Order_WorkflowInformation) AsWorkflowUnavailable added in v0.3.0

func (t Order_WorkflowInformation) AsWorkflowUnavailable() (WorkflowUnavailable, error)

AsWorkflowUnavailable returns the union data inside the Order_WorkflowInformation as a WorkflowUnavailable

func (*Order_WorkflowInformation) FromWorkflowInformation added in v0.3.0

func (t *Order_WorkflowInformation) FromWorkflowInformation(v WorkflowInformation) error

FromWorkflowInformation overwrites any union data inside the Order_WorkflowInformation as the provided WorkflowInformation

func (*Order_WorkflowInformation) FromWorkflowUnavailable added in v0.3.0

func (t *Order_WorkflowInformation) FromWorkflowUnavailable(v WorkflowUnavailable) error

FromWorkflowUnavailable overwrites any union data inside the Order_WorkflowInformation as the provided WorkflowUnavailable

func (Order_WorkflowInformation) MarshalJSON added in v0.3.0

func (t Order_WorkflowInformation) MarshalJSON() ([]byte, error)

func (*Order_WorkflowInformation) MergeWorkflowInformation added in v0.3.0

func (t *Order_WorkflowInformation) MergeWorkflowInformation(v WorkflowInformation) error

MergeWorkflowInformation performs a merge with any union data inside the Order_WorkflowInformation, using the provided WorkflowInformation

func (*Order_WorkflowInformation) MergeWorkflowUnavailable added in v0.3.0

func (t *Order_WorkflowInformation) MergeWorkflowUnavailable(v WorkflowUnavailable) error

MergeWorkflowUnavailable performs a merge with any union data inside the Order_WorkflowInformation, using the provided WorkflowUnavailable

func (*Order_WorkflowInformation) UnmarshalJSON added in v0.3.0

func (t *Order_WorkflowInformation) UnmarshalJSON(b []byte) error

type OutOfStockBehaviour

type OutOfStockBehaviour string

OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided. Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />

const (
	OutOfStockBehaviourBACKORDER          OutOfStockBehaviour = "BACKORDER"
	OutOfStockBehaviourNONE               OutOfStockBehaviour = "NONE"
	OutOfStockBehaviourPREORDER           OutOfStockBehaviour = "PREORDER"
	OutOfStockBehaviourPREORDERANDRESTOCK OutOfStockBehaviour = "PREORDER_AND_RESTOCK"
	OutOfStockBehaviourRESTOCK            OutOfStockBehaviour = "RESTOCK"
)

Defines values for OutOfStockBehaviour.

func (OutOfStockBehaviour) Valid

func (e OutOfStockBehaviour) Valid() bool

Valid indicates whether the value is a known member of the OutOfStockBehaviour enum.

type OutOfStockBehaviourByContext

type OutOfStockBehaviourByContext struct {
	// Context The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.
	// For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context" target="_blank">context documentation</a>.
	Context []OutOfStockBehaviourContext `json:"context"`

	// OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.
	// Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviour OutOfStockBehaviour `json:"outOfStockBehaviour"`

	// OutOfStockConfig OutOfStockConfig
	OutOfStockConfig *OutOfStockConfig `json:"outOfStockConfig,omitempty"`

	// Priority This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.
	//
	// Example: 100
	Priority int32 `json:"priority"`
}

OutOfStockBehaviourByContext OutOfStockBehaviourByContext

type OutOfStockBehaviourByContext2

type OutOfStockBehaviourByContext2 struct {
	// Context The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br/>
	Context []OutOfStockBehaviourContext `json:"context"`

	// OutOfStockBehaviour The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.
	// Also PREORDER and RESTOCK values are in Alpha status. For details please check the <a href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha" target="_blank">api-release-life-cycle documentation</a>.<br /><br />
	OutOfStockBehaviour OutOfStockBehaviour `json:"outOfStockBehaviour"`

	// OutOfStockConfig OutOfStockConfig2
	OutOfStockConfig *OutOfStockConfig2 `json:"outOfStockConfig,omitempty"`
	Priority         float32            `json:"priority"`
}

OutOfStockBehaviourByContext2 OutOfStockBehaviourByContext2

type OutOfStockBehaviourContext

type OutOfStockBehaviourContext struct {
	// Operator The operator used to define how the context values are evaluated or compared.
	Operator *ContextOperator `json:"operator,omitempty"`

	// Type The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.
	Type OutOfStockBehaviourContextType `json:"type"`

	// Values The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.
	Values []string `json:"values"`
}

OutOfStockBehaviourContext The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.

type OutOfStockBehaviourContextType

type OutOfStockBehaviourContextType string

OutOfStockBehaviourContextType The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.

const (
	OutOfStockBehaviourContextTypeFACILITYGROUP OutOfStockBehaviourContextType = "FACILITY_GROUP"
	OutOfStockBehaviourContextTypeTAGREFERENCE  OutOfStockBehaviourContextType = "TAG_REFERENCE"
)

Defines values for OutOfStockBehaviourContextType.

func (OutOfStockBehaviourContextType) Valid

Valid indicates whether the value is a known member of the OutOfStockBehaviourContextType enum.

type OutOfStockConfig

type OutOfStockConfig struct {
	Preorder *struct {
		// AvailabilityTimeframe AvailabilityTimeframe
		AvailabilityTimeframe AvailabilityTimeframe `json:"availabilityTimeframe"`
	} `json:"preorder,omitempty"`
	Restock *struct {
		RestockableInDays int `json:"restockableInDays"`
	} `json:"restock,omitempty"`
}

OutOfStockConfig OutOfStockConfig

type OutOfStockConfig2

type OutOfStockConfig2 struct {
	// Preorder OutOfStockConfigPreorder2
	Preorder *OutOfStockConfigPreorder2 `json:"preorder,omitempty"`

	// Restock InventoryOutOfStockConfigRestock
	Restock *InventoryOutOfStockConfigRestock `json:"restock,omitempty"`
}

OutOfStockConfig2 OutOfStockConfig2

type OutOfStockConfigPreorder2

type OutOfStockConfigPreorder2 struct {
	// AvailabilityTimeframe Example: 2026-06-17T12:00:00.000Z
	AvailabilityTimeframe AvailabilityTimeframe2 `json:"availabilityTimeframe"`
}

OutOfStockConfigPreorder2 OutOfStockConfigPreorder2

type OverflowCostDetail added in v0.8.0

type OverflowCostDetail struct {
	// Amount Money
	Amount Money `json:"amount"`

	// Id Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds
	//
	// Example: 0
	Id   string                 `json:"id"`
	Type OverflowCostDetailType `json:"type"`
}

OverflowCostDetail What the goods beyond the highest configured tier cost on top of the base price.

type OverflowCostDetailType added in v0.8.0

type OverflowCostDetailType string

OverflowCostDetailType defines model for OverflowCostDetail.Type.

const (
	OVERFLOW OverflowCostDetailType = "OVERFLOW"
)

Defines values for OverflowCostDetailType.

func (OverflowCostDetailType) Valid added in v0.8.0

func (e OverflowCostDetailType) Valid() bool

Valid indicates whether the value is a known member of the OverflowCostDetailType enum.

type PackJobInvoiceFilter

type PackJobInvoiceFilter struct {
	// CompanyName Search by companyName
	CompanyName *StringSearchFilter `json:"companyName,omitempty"`

	// Email Search by email
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *StringSearchFilter `json:"email,omitempty"`

	// FirstName Search by firstName
	FirstName *StringSearchFilter `json:"firstName,omitempty"`

	// LastName Search by lastName
	LastName *StringSearchFilter `json:"lastName,omitempty"`
}

PackJobInvoiceFilter PackJobInvoiceFilter

type PackJobLineItemsArticleFilter

type PackJobLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringSearchFilter `json:"tenantArticleId,omitempty"`

	// Title Search by title
	Title *StringSearchFilter `json:"title,omitempty"`
}

PackJobLineItemsArticleFilter PackJobLineItemsArticleFilter

type PackJobLineItemsFilter

type PackJobLineItemsFilter struct {
	// Article Nested search by article
	Article *PackJobLineItemsArticleFilter `json:"article,omitempty"`
}

PackJobLineItemsFilter PackJobLineItemsFilter

type PackJobLineItemsListFilter

type PackJobLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *PackJobLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

PackJobLineItemsListFilter PackJobLineItemsListFilter

type PackJobPackingSourceContainersFilter

type PackJobPackingSourceContainersFilter struct {
	// Codes Search by codes
	Codes *StringListFilter `json:"codes,omitempty"`
}

PackJobPackingSourceContainersFilter PackJobPackingSourceContainersFilter

type PackJobPackingSourceContainersListFilter

type PackJobPackingSourceContainersListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *PackJobPackingSourceContainersFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

PackJobPackingSourceContainersListFilter PackJobPackingSourceContainersListFilter

type PackJobRecipientFilter

type PackJobRecipientFilter struct {
	// CompanyName Search by companyName
	CompanyName *StringSearchFilter `json:"companyName,omitempty"`

	// Email Search by email
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *StringSearchFilter `json:"email,omitempty"`

	// FirstName Search by firstName
	FirstName *StringSearchFilter `json:"firstName,omitempty"`

	// LastName Search by lastName
	LastName *StringSearchFilter `json:"lastName,omitempty"`
}

PackJobRecipientFilter PackJobRecipientFilter

type PackJobSearchQuery

type PackJobSearchQuery struct {
	And *[]PackJobSearchQuery `json:"and,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringEqFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Invoice Nested search by invoice
	Invoice *PackJobInvoiceFilter `json:"invoice,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter `json:"lastModified,omitempty"`

	// LineItems Nested list search by lineItems
	LineItems *PackJobLineItemsListFilter `json:"lineItems,omitempty"`
	Or        *[]PackJobSearchQuery       `json:"or,omitempty"`

	// OrderDate Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	//
	// Example: 2026-06-17T12:00:00.000Z
	OrderDate *DateFilter `json:"orderDate,omitempty"`

	// PackingSourceContainers Nested list search by packingSourceContainers
	PackingSourceContainers *PackJobPackingSourceContainersListFilter `json:"packingSourceContainers,omitempty"`

	// Recipient Nested search by recipient
	Recipient *PackJobRecipientFilter `json:"recipient,omitempty"`

	// ShortId Search by shortId
	ShortId *StringSearchFilter `json:"shortId,omitempty"`

	// Status Search by status
	Status *PackJobStatusEnumFilter `json:"status,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringSearchFilter `json:"tenantOrderId,omitempty"`
}

PackJobSearchQuery PackJobSearchQuery

type PackJobStatusEnumFilter

type PackJobStatusEnumFilter struct {
	// Eq Search by status
	Eq *PackJobStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]PackJobStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *PackJobStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

PackJobStatusEnumFilter PackJobStatusEnumFilter

type PackJobStatusEnumFilterEq

type PackJobStatusEnumFilterEq string

PackJobStatusEnumFilterEq Search by status

const (
	PackJobStatusEnumFilterEqCANCELED   PackJobStatusEnumFilterEq = "CANCELED"
	PackJobStatusEnumFilterEqCLOSED     PackJobStatusEnumFilterEq = "CLOSED"
	PackJobStatusEnumFilterEqINPROGRESS PackJobStatusEnumFilterEq = "IN_PROGRESS"
	PackJobStatusEnumFilterEqOBSOLETE   PackJobStatusEnumFilterEq = "OBSOLETE"
	PackJobStatusEnumFilterEqOPEN       PackJobStatusEnumFilterEq = "OPEN"
	PackJobStatusEnumFilterEqPAUSED     PackJobStatusEnumFilterEq = "PAUSED"
)

Defines values for PackJobStatusEnumFilterEq.

func (PackJobStatusEnumFilterEq) Valid

func (e PackJobStatusEnumFilterEq) Valid() bool

Valid indicates whether the value is a known member of the PackJobStatusEnumFilterEq enum.

type PackJobStatusEnumFilterIn

type PackJobStatusEnumFilterIn string

PackJobStatusEnumFilterIn defines model for PackJobStatusEnumFilter.In.

const (
	PackJobStatusEnumFilterInCANCELED   PackJobStatusEnumFilterIn = "CANCELED"
	PackJobStatusEnumFilterInCLOSED     PackJobStatusEnumFilterIn = "CLOSED"
	PackJobStatusEnumFilterInINPROGRESS PackJobStatusEnumFilterIn = "IN_PROGRESS"
	PackJobStatusEnumFilterInOBSOLETE   PackJobStatusEnumFilterIn = "OBSOLETE"
	PackJobStatusEnumFilterInOPEN       PackJobStatusEnumFilterIn = "OPEN"
	PackJobStatusEnumFilterInPAUSED     PackJobStatusEnumFilterIn = "PAUSED"
)

Defines values for PackJobStatusEnumFilterIn.

func (PackJobStatusEnumFilterIn) Valid

func (e PackJobStatusEnumFilterIn) Valid() bool

Valid indicates whether the value is a known member of the PackJobStatusEnumFilterIn enum.

type PackJobStatusEnumFilterNotEq

type PackJobStatusEnumFilterNotEq string

PackJobStatusEnumFilterNotEq Search by status

const (
	PackJobStatusEnumFilterNotEqCANCELED   PackJobStatusEnumFilterNotEq = "CANCELED"
	PackJobStatusEnumFilterNotEqCLOSED     PackJobStatusEnumFilterNotEq = "CLOSED"
	PackJobStatusEnumFilterNotEqINPROGRESS PackJobStatusEnumFilterNotEq = "IN_PROGRESS"
	PackJobStatusEnumFilterNotEqOBSOLETE   PackJobStatusEnumFilterNotEq = "OBSOLETE"
	PackJobStatusEnumFilterNotEqOPEN       PackJobStatusEnumFilterNotEq = "OPEN"
	PackJobStatusEnumFilterNotEqPAUSED     PackJobStatusEnumFilterNotEq = "PAUSED"
)

Defines values for PackJobStatusEnumFilterNotEq.

func (PackJobStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the PackJobStatusEnumFilterNotEq enum.

type PackageCost added in v0.2.0

type PackageCost struct {
	// CostAmount Money
	CostAmount Money `json:"costAmount"`

	// PackageName Name of the package
	//
	// Example: Small Box
	PackageName string `json:"packageName"`
}

PackageCost PackageCost

type PackagingUnit

type PackagingUnit struct {
	// Dimensions PackagingUnitDimensions
	Dimensions *PackagingUnitDimensions `json:"dimensions,omitempty"`

	// MaxItemQuantity The maximum item quantity of the packaging unit
	//
	// Example: 10
	MaxItemQuantity *int `json:"maxItemQuantity,omitempty"`

	// Name The name of the packaging unit
	//
	// Example: Parcel XXL
	Name string `json:"name"`

	// PackagingUnitRef The reference ID of the packaging unit
	PackagingUnitRef *string                                `json:"packagingUnitRef,omitempty"`
	Prices           *[]InterFacilityConnectionDeliveryCost `json:"prices,omitempty"`

	// Priority The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context
	//
	// Example: 1
	Priority int `json:"priority"`

	// TenantPackagingUnitId The tenant-specific ID of the packaging unit
	//
	// Example: Parcel XXL
	TenantPackagingUnitId *string `json:"tenantPackagingUnitId,omitempty"`

	// TransitTime CarrierTransitTime
	TransitTime *CarrierTransitTime `json:"transitTime,omitempty"`

	// VolumeBufferInPercent The volume buffer of PackagingUnit in percent
	//
	// Example: 10
	VolumeBufferInPercent *int `json:"volumeBufferInPercent,omitempty"`
}

PackagingUnit PackagingUnit

type PackagingUnitContext

type PackagingUnitContext struct {
	// Operator The operator used to define how the context values are evaluated or compared.
	Operator *ContextOperator `json:"operator,omitempty"`

	// Type PackagingUnitContextTypes
	Type   PackagingUnitContextTypes `json:"type"`
	Values []string                  `json:"values"`
}

PackagingUnitContext PackagingUnitContext

type PackagingUnitContextTypes

type PackagingUnitContextTypes string

PackagingUnitContextTypes PackagingUnitContextTypes

const (
	PackagingUnitContextTypesCATEGORY         PackagingUnitContextTypes = "CATEGORY"
	PackagingUnitContextTypesTARGETCOUNTRY    PackagingUnitContextTypes = "TARGET_COUNTRY"
	PackagingUnitContextTypesTARGETPOSTALCODE PackagingUnitContextTypes = "TARGET_POSTALCODE"
)

Defines values for PackagingUnitContextTypes.

func (PackagingUnitContextTypes) Valid

func (e PackagingUnitContextTypes) Valid() bool

Valid indicates whether the value is a known member of the PackagingUnitContextTypes enum.

type PackagingUnitDimensions

type PackagingUnitDimensions struct {
	// Height The height of the packaging unit
	//
	// Example: 50
	Height float32 `json:"height"`

	// Length The length of the packaging unit
	//
	// Example: 100
	Length float32 `json:"length"`

	// MaxWeightInGram The weight of the packaging unit
	//
	// Example: 1000
	MaxWeightInGram float32 `json:"maxWeightInGram"`

	// Width The width of the packaging unit
	//
	// Example: 50
	Width float32 `json:"width"`
}

PackagingUnitDimensions PackagingUnitDimensions

type PackagingUnitType added in v0.8.0

type PackagingUnitType string

PackagingUnitType The type of the packagingUnit.

const (
	PackagingUnitTypeBULKYGOODS     PackagingUnitType = "BULKY_GOODS"
	PackagingUnitTypeLONGGOODS      PackagingUnitType = "LONG_GOODS"
	PackagingUnitTypePALLET         PackagingUnitType = "PALLET"
	PackagingUnitTypePARCEL         PackagingUnitType = "PARCEL"
	PackagingUnitTypeTWOMANHANDLING PackagingUnitType = "TWO_MAN_HANDLING"
)

Defines values for PackagingUnitType.

func (PackagingUnitType) Valid added in v0.8.0

func (e PackagingUnitType) Valid() bool

Valid indicates whether the value is a known member of the PackagingUnitType enum.

type PackagingUnitsByContext

type PackagingUnitsByContext struct {
	Context        []PackagingUnitContext `json:"context"`
	PackagingUnits []PackagingUnit        `json:"packagingUnits"`
}

PackagingUnitsByContext PackagingUnitsByContext

type PageInfo

type PageInfo struct {
	// EndCursor The cursor to use to fetch the next page of items. Use with parameter `after`.
	EndCursor string `json:"endCursor"`

	// HasNextPage If true, there are more items after the current page.
	HasNextPage bool `json:"hasNextPage"`

	// HasPreviousPage If true, there are more items before the current page.
	HasPreviousPage bool `json:"hasPreviousPage"`

	// StartCursor The cursor to use to fetch the previous page of items.
	StartCursor string `json:"startCursor"`
}

PageInfo PageInfo

type Param

type Param struct {
	// Name is the parameter's name as the API spells it: pickJobId, facilityRef.
	Name string `json:"name" yaml:"name"`

	// In is where it travels: path, query or header.
	In ParamIn `json:"in" yaml:"in"`

	// Required says the API will not accept the request without it.
	Required bool `json:"required,omitempty" yaml:"required,omitempty"`

	// Type is the parameter's JSON type.
	Type ParamType `json:"type" yaml:"type"`

	// Item is the element type when Type is [TypeArray], and "" otherwise.
	Item ParamType `json:"item,omitempty" yaml:"item,omitempty"`

	// Explode is how a multi-valued parameter is encoded: true repeats the name
	// (status=A&status=B), false joins the values with commas (status=A,B).
	//
	// It is meaningful only for an array. It is taken from the parameter's own
	// `explode` (defaulting to the `form` style's true), because the spec answers
	// it differently for different parameters — pickjob `status` is comma-joined,
	// facility `status` is repeated — and getting it wrong is silent: the API
	// answers 200 and filters on something else.
	Explode bool `json:"explode,omitempty" yaml:"explode,omitempty"`

	// Enum lists the values the API accepts, or is empty when it accepts any.
	Enum []string `json:"enum,omitempty" yaml:"enum,omitempty"`

	// Description is the parameter's prose, HTML stripped.
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
}

Param is one parameter of an operation.

type ParamIn

type ParamIn string

ParamIn is where a parameter travels.

const (
	InPath   ParamIn = "path"
	InQuery  ParamIn = "query"
	InHeader ParamIn = "header"
)

The parameter locations fft can send. The spec uses no others.

type ParamType

type ParamType string

ParamType is a parameter's JSON type.

const (
	TypeString  ParamType = "string"
	TypeInteger ParamType = "integer"
	TypeNumber  ParamType = "number"
	TypeBoolean ParamType = "boolean"
	TypeArray   ParamType = "array"
)

The parameter types the spec uses.

type ParcelDimensions

type ParcelDimensions struct {
	CustomWeight *float32 `json:"customWeight,omitempty"`
	Height       *float32 `json:"height,omitempty"`
	Length       *float32 `json:"length,omitempty"`
	Weight       *float32 `json:"weight,omitempty"`
	Width        *float32 `json:"width,omitempty"`
}

ParcelDimensions ParcelDimensions

type ParcelInformationParcelInformationLineItemsArticleFilter

type ParcelInformationParcelInformationLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`

	// Title Search by title
	Title *StringSearchFilter `json:"title,omitempty"`
}

ParcelInformationParcelInformationLineItemsArticleFilter ParcelInformationParcelInformationLineItemsArticleFilter

type ParcelInformationParcelInformationLineItemsFilter

type ParcelInformationParcelInformationLineItemsFilter struct {
	// Article Nested search by article
	Article *ParcelInformationParcelInformationLineItemsArticleFilter `json:"article,omitempty"`
}

ParcelInformationParcelInformationLineItemsFilter ParcelInformationParcelInformationLineItemsFilter

type ParcelInformationParcelInformationLineItemsListFilter

type ParcelInformationParcelInformationLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *ParcelInformationParcelInformationLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

ParcelInformationParcelInformationLineItemsListFilter ParcelInformationParcelInformationLineItemsListFilter

type ParcelInformationSearchQuery

type ParcelInformationSearchQuery struct {
	And *[]ParcelInformationSearchQuery `json:"and,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter                     `json:"lastModified,omitempty"`
	Or           *[]ParcelInformationSearchQuery `json:"or,omitempty"`

	// ParcelInformationLineItems Nested list search by parcelInformationLineItems
	ParcelInformationLineItems *ParcelInformationParcelInformationLineItemsListFilter `json:"parcelInformationLineItems,omitempty"`

	// ShippingInformationRef Search by shippingInformationRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	ShippingInformationRef *StringFilter `json:"shippingInformationRef,omitempty"`

	// ShortId Search by shortId
	ShortId *StringFilter `json:"shortId,omitempty"`
}

ParcelInformationSearchQuery ParcelInformationSearchQuery

type ParcelInvoiceFilter

type ParcelInvoiceFilter struct {
	// CompanyName Search by companyName
	CompanyName *StringSearchFilter `json:"companyName,omitempty"`

	// Email Search by email
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *StringSearchFilter `json:"email,omitempty"`

	// FirstName Search by firstName
	FirstName *StringSearchFilter `json:"firstName,omitempty"`

	// LastName Search by lastName
	LastName *StringSearchFilter `json:"lastName,omitempty"`
}

ParcelInvoiceFilter ParcelInvoiceFilter

type ParcelItemsArticleFilter

type ParcelItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringSearchFilter `json:"tenantArticleId,omitempty"`

	// Title Search by title
	Title *StringSearchFilter `json:"title,omitempty"`
}

ParcelItemsArticleFilter ParcelItemsArticleFilter

type ParcelItemsFilter

type ParcelItemsFilter struct {
	// Article Nested search by article
	Article *ParcelItemsArticleFilter `json:"article,omitempty"`
}

ParcelItemsFilter ParcelItemsFilter

type ParcelItemsListFilter

type ParcelItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *ParcelItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

ParcelItemsListFilter ParcelItemsListFilter

type ParcelLabelClassification

type ParcelLabelClassification struct {
	// Dimensions Dimensions for this parcel label classification
	Dimensions *ParcelDimensions `json:"dimensions"`

	// Name Name of the parcel label classification
	//
	// Example: S-Parcel
	Name *string `json:"name,omitempty"`

	// NameLocalized Localized name for parcel label classification
	//
	// Example: {"de_DE":"S-Paket","en_US":"S-Parcel","ru_RU":"S-пакет"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// Services Services available for this parcel label classification
	Services *ParcelLabelClassificationServices `json:"services,omitempty"`
}

ParcelLabelClassification ParcelLabelClassification

type ParcelLabelClassificationForCreation

type ParcelLabelClassificationForCreation struct {
	// Dimensions Dimensions for this parcel label classification
	Dimensions *ParcelDimensions `json:"dimensions"`

	// NameLocalized Localized name for parcel label classification
	//
	// Example: {"de_DE":"S-Paket","en_US":"S-Parcel","ru_RU":"S-пакет"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// Services Services available for this parcel label classification
	Services *ParcelLabelClassificationServices `json:"services,omitempty"`
}

ParcelLabelClassificationForCreation ParcelLabelClassificationForCreation

type ParcelLabelClassificationServices

type ParcelLabelClassificationServices struct {
	// BulkyGoods Indicates if this label classification is for bulky goods
	BulkyGoods *bool `json:"bulkyGoods,omitempty"`
}

ParcelLabelClassificationServices ParcelLabelClassificationServices

type ParcelProductValue

type ParcelProductValue struct {
	// Currency The currency of the price as an ISO 4217 code.
	//
	// Example: EUR
	Currency *CurrencyCode `json:"currency"`

	// DecimalPlaces Number of decimal places for the given currency
	//
	// Example: 2
	DecimalPlaces int `json:"decimalPlaces"`

	// Value Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.
	//
	// Example: 25000
	Value int `json:"value"`
}

ParcelProductValue ParcelProductValue

type ParcelRecipientFilter

type ParcelRecipientFilter struct {
	// CompanyName Search by companyName
	CompanyName *StringSearchFilter `json:"companyName,omitempty"`

	// Email Search by email
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *StringSearchFilter `json:"email,omitempty"`

	// FirstName Search by firstName
	FirstName *StringSearchFilter `json:"firstName,omitempty"`

	// LastName Search by lastName
	LastName *StringSearchFilter `json:"lastName,omitempty"`
}

ParcelRecipientFilter ParcelRecipientFilter

type ParcelResultFilter

type ParcelResultFilter struct {
	// CarrierTrackingNumber Search by carrierTrackingNumber
	CarrierTrackingNumber *StringFilter `json:"carrierTrackingNumber,omitempty"`
}

ParcelResultFilter ParcelResultFilter

type ParcelSearchQuery

type ParcelSearchQuery struct {
	And *[]ParcelSearchQuery `json:"and,omitempty"`

	// CarrierRef Search by carrierRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	CarrierRef *StringFilter `json:"carrierRef,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Invoice Nested search by invoice
	Invoice *ParcelInvoiceFilter `json:"invoice,omitempty"`

	// Items Nested list search by items
	Items *ParcelItemsListFilter `json:"items,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter          `json:"lastModified,omitempty"`
	Or           *[]ParcelSearchQuery `json:"or,omitempty"`

	// Recipient Nested search by recipient
	Recipient *ParcelRecipientFilter `json:"recipient,omitempty"`

	// Result Nested search by result
	Result *ParcelResultFilter `json:"result,omitempty"`

	// ShipmentRef Search by shipmentRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	ShipmentRef *StringFilter `json:"shipmentRef,omitempty"`

	// ShortId Search by shortId
	ShortId *StringFilter `json:"shortId,omitempty"`

	// Status Search by status
	Status *ParcelStatusEnumFilter `json:"status,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringFilter `json:"tenantOrderId,omitempty"`
}

ParcelSearchQuery ParcelSearchQuery

type ParcelStatusEnumFilter

type ParcelStatusEnumFilter struct {
	// Eq Search by status
	Eq *ParcelStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ParcelStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ParcelStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ParcelStatusEnumFilter ParcelStatusEnumFilter

type ParcelStatusEnumFilterEq

type ParcelStatusEnumFilterEq string

ParcelStatusEnumFilterEq Search by status

const (
	ParcelStatusEnumFilterEqCANCELED        ParcelStatusEnumFilterEq = "CANCELED"
	ParcelStatusEnumFilterEqDONE            ParcelStatusEnumFilterEq = "DONE"
	ParcelStatusEnumFilterEqFAILED          ParcelStatusEnumFilterEq = "FAILED"
	ParcelStatusEnumFilterEqOBSOLETE        ParcelStatusEnumFilterEq = "OBSOLETE"
	ParcelStatusEnumFilterEqOPEN            ParcelStatusEnumFilterEq = "OPEN"
	ParcelStatusEnumFilterEqPROCESSING      ParcelStatusEnumFilterEq = "PROCESSING"
	ParcelStatusEnumFilterEqWAITINGFORINPUT ParcelStatusEnumFilterEq = "WAITING_FOR_INPUT"
)

Defines values for ParcelStatusEnumFilterEq.

func (ParcelStatusEnumFilterEq) Valid

func (e ParcelStatusEnumFilterEq) Valid() bool

Valid indicates whether the value is a known member of the ParcelStatusEnumFilterEq enum.

type ParcelStatusEnumFilterIn

type ParcelStatusEnumFilterIn string

ParcelStatusEnumFilterIn defines model for ParcelStatusEnumFilter.In.

const (
	ParcelStatusEnumFilterInCANCELED        ParcelStatusEnumFilterIn = "CANCELED"
	ParcelStatusEnumFilterInDONE            ParcelStatusEnumFilterIn = "DONE"
	ParcelStatusEnumFilterInFAILED          ParcelStatusEnumFilterIn = "FAILED"
	ParcelStatusEnumFilterInOBSOLETE        ParcelStatusEnumFilterIn = "OBSOLETE"
	ParcelStatusEnumFilterInOPEN            ParcelStatusEnumFilterIn = "OPEN"
	ParcelStatusEnumFilterInPROCESSING      ParcelStatusEnumFilterIn = "PROCESSING"
	ParcelStatusEnumFilterInWAITINGFORINPUT ParcelStatusEnumFilterIn = "WAITING_FOR_INPUT"
)

Defines values for ParcelStatusEnumFilterIn.

func (ParcelStatusEnumFilterIn) Valid

func (e ParcelStatusEnumFilterIn) Valid() bool

Valid indicates whether the value is a known member of the ParcelStatusEnumFilterIn enum.

type ParcelStatusEnumFilterNotEq

type ParcelStatusEnumFilterNotEq string

ParcelStatusEnumFilterNotEq Search by status

const (
	ParcelStatusEnumFilterNotEqCANCELED        ParcelStatusEnumFilterNotEq = "CANCELED"
	ParcelStatusEnumFilterNotEqDONE            ParcelStatusEnumFilterNotEq = "DONE"
	ParcelStatusEnumFilterNotEqFAILED          ParcelStatusEnumFilterNotEq = "FAILED"
	ParcelStatusEnumFilterNotEqOBSOLETE        ParcelStatusEnumFilterNotEq = "OBSOLETE"
	ParcelStatusEnumFilterNotEqOPEN            ParcelStatusEnumFilterNotEq = "OPEN"
	ParcelStatusEnumFilterNotEqPROCESSING      ParcelStatusEnumFilterNotEq = "PROCESSING"
	ParcelStatusEnumFilterNotEqWAITINGFORINPUT ParcelStatusEnumFilterNotEq = "WAITING_FOR_INPUT"
)

Defines values for ParcelStatusEnumFilterNotEq.

func (ParcelStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ParcelStatusEnumFilterNotEq enum.

type PartialStock

type PartialStock struct {
	// EventLastModified The date when the inventory domain comunicated a change in this partial stock
	//
	// Example: 2020-02-03T08:45:50.525Z
	EventLastModified *time.Time `json:"eventLastModified,omitempty"`

	// Location Location
	Location *Location `json:"location,omitempty"`
	Scores   *[]Score  `json:"scores,omitempty"`

	// Stockinformation @deprecated This object is deprecated since 11th of September 2023.
	Stockinformation StockInformation `json:"stockinformation"`

	// TenantPartialStockId The id associated with the partial stock
	TenantPartialStockId string `json:"tenantPartialStockId"`
}

PartialStock PartialStock

type PartialStockForCreation

type PartialStockForCreation struct {
	// Location Location
	Location *Location `json:"location,omitempty"`
	Scores   *[]Score  `json:"scores,omitempty"`

	// Stockinformation @deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Stockinformation StockInformationForCreation `json:"stockinformation"`

	// TenantPartialStockId The id associated with the partial stock
	TenantPartialStockId string `json:"tenantPartialStockId"`
}

PartialStockForCreation PartialStockForCreation

type PartialStockPatchActions

type PartialStockPatchActions struct {
	Actions []ModifyPartialStock `json:"actions"`

	// Version The version of the listing where we want to patch the partialStocks, to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

PartialStockPatchActions PartialStockPatchActions

type PartialStocksForReplacement

type PartialStocksForReplacement struct {
	PartialStocks []PartialStockForCreation `json:"partialStocks"`

	// Version The version of the listing where we want to put the partialStocks, to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

PartialStocksForReplacement PartialStocksForReplacement

type PatchFacility200JSONResponseBody

type PatchFacility200JSONResponseBody struct {
	// contains filtered or unexported fields
}

PatchFacility200JSONResponseBody defines parameters for PatchFacility.

func (PatchFacility200JSONResponseBody) AsManagedFacility

func (t PatchFacility200JSONResponseBody) AsManagedFacility() (ManagedFacility, error)

AsManagedFacility returns the union data inside the PatchFacility200JSONResponseBody as a ManagedFacility

func (PatchFacility200JSONResponseBody) AsSupplier

AsSupplier returns the union data inside the PatchFacility200JSONResponseBody as a Supplier

func (*PatchFacility200JSONResponseBody) FromManagedFacility

func (t *PatchFacility200JSONResponseBody) FromManagedFacility(v ManagedFacility) error

FromManagedFacility overwrites any union data inside the PatchFacility200JSONResponseBody as the provided ManagedFacility

func (*PatchFacility200JSONResponseBody) FromSupplier

func (t *PatchFacility200JSONResponseBody) FromSupplier(v Supplier) error

FromSupplier overwrites any union data inside the PatchFacility200JSONResponseBody as the provided Supplier

func (PatchFacility200JSONResponseBody) MarshalJSON

func (t PatchFacility200JSONResponseBody) MarshalJSON() ([]byte, error)

func (*PatchFacility200JSONResponseBody) MergeManagedFacility

func (t *PatchFacility200JSONResponseBody) MergeManagedFacility(v ManagedFacility) error

MergeManagedFacility performs a merge with any union data inside the PatchFacility200JSONResponseBody, using the provided ManagedFacility

func (*PatchFacility200JSONResponseBody) MergeSupplier

func (t *PatchFacility200JSONResponseBody) MergeSupplier(v Supplier) error

MergeSupplier performs a merge with any union data inside the PatchFacility200JSONResponseBody, using the provided Supplier

func (*PatchFacility200JSONResponseBody) UnmarshalJSON

func (t *PatchFacility200JSONResponseBody) UnmarshalJSON(b []byte) error

type PatchFacilityJSONBody

type PatchFacilityJSONBody struct {
	// contains filtered or unexported fields
}

PatchFacilityJSONBody defines parameters for PatchFacility.

func (PatchFacilityJSONBody) AsFacilityPatchActions

func (t PatchFacilityJSONBody) AsFacilityPatchActions() (FacilityPatchActions, error)

AsFacilityPatchActions returns the union data inside the PatchFacilityJSONBody as a FacilityPatchActions

func (PatchFacilityJSONBody) AsManagedFacilityForModification

func (t PatchFacilityJSONBody) AsManagedFacilityForModification() (ManagedFacilityForModification, error)

AsManagedFacilityForModification returns the union data inside the PatchFacilityJSONBody as a ManagedFacilityForModification

func (PatchFacilityJSONBody) AsSupplierForModification

func (t PatchFacilityJSONBody) AsSupplierForModification() (SupplierForModification, error)

AsSupplierForModification returns the union data inside the PatchFacilityJSONBody as a SupplierForModification

func (*PatchFacilityJSONBody) FromFacilityPatchActions

func (t *PatchFacilityJSONBody) FromFacilityPatchActions(v FacilityPatchActions) error

FromFacilityPatchActions overwrites any union data inside the PatchFacilityJSONBody as the provided FacilityPatchActions

func (*PatchFacilityJSONBody) FromManagedFacilityForModification

func (t *PatchFacilityJSONBody) FromManagedFacilityForModification(v ManagedFacilityForModification) error

FromManagedFacilityForModification overwrites any union data inside the PatchFacilityJSONBody as the provided ManagedFacilityForModification

func (*PatchFacilityJSONBody) FromSupplierForModification

func (t *PatchFacilityJSONBody) FromSupplierForModification(v SupplierForModification) error

FromSupplierForModification overwrites any union data inside the PatchFacilityJSONBody as the provided SupplierForModification

func (PatchFacilityJSONBody) MarshalJSON

func (t PatchFacilityJSONBody) MarshalJSON() ([]byte, error)

func (*PatchFacilityJSONBody) MergeFacilityPatchActions

func (t *PatchFacilityJSONBody) MergeFacilityPatchActions(v FacilityPatchActions) error

MergeFacilityPatchActions performs a merge with any union data inside the PatchFacilityJSONBody, using the provided FacilityPatchActions

func (*PatchFacilityJSONBody) MergeManagedFacilityForModification

func (t *PatchFacilityJSONBody) MergeManagedFacilityForModification(v ManagedFacilityForModification) error

MergeManagedFacilityForModification performs a merge with any union data inside the PatchFacilityJSONBody, using the provided ManagedFacilityForModification

func (*PatchFacilityJSONBody) MergeSupplierForModification

func (t *PatchFacilityJSONBody) MergeSupplierForModification(v SupplierForModification) error

MergeSupplierForModification performs a merge with any union data inside the PatchFacilityJSONBody, using the provided SupplierForModification

func (*PatchFacilityJSONBody) UnmarshalJSON

func (t *PatchFacilityJSONBody) UnmarshalJSON(b []byte) error

type PatchFacilityJSONRequestBody

type PatchFacilityJSONRequestBody PatchFacilityJSONBody

PatchFacilityJSONRequestBody defines body for PatchFacility for application/json ContentType.

type PatchFacilityListingJSONRequestBody

type PatchFacilityListingJSONRequestBody = ListingPatchActions

PatchFacilityListingJSONRequestBody defines body for PatchFacilityListing for application/json ContentType.

type PatchFacilityListingPartialStockJSONRequestBody deprecated

type PatchFacilityListingPartialStockJSONRequestBody = PartialStockPatchActions

PatchFacilityListingPartialStockJSONRequestBody defines body for PatchFacilityListingPartialStock for application/json ContentType.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type PatchFacilityListingPartialStockResponse

type PatchFacilityListingPartialStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParsePatchFacilityListingPartialStockResponse

func ParsePatchFacilityListingPartialStockResponse(rsp *http.Response) (*PatchFacilityListingPartialStockResponse, error)

ParsePatchFacilityListingPartialStockResponse parses an HTTP response from a PatchFacilityListingPartialStockWithResponse call

func (PatchFacilityListingPartialStockResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PatchFacilityListingPartialStockResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (PatchFacilityListingPartialStockResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PatchFacilityListingPartialStockResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PatchFacilityListingPartialStockResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PatchFacilityListingPartialStockResponse) Status

Status returns HTTPResponse.Status

func (PatchFacilityListingPartialStockResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PatchFacilityListingResponse

type PatchFacilityListingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]Listing
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ApiError
}

func ParsePatchFacilityListingResponse

func ParsePatchFacilityListingResponse(rsp *http.Response) (*PatchFacilityListingResponse, error)

ParsePatchFacilityListingResponse parses an HTTP response from a PatchFacilityListingWithResponse call

func (PatchFacilityListingResponse) ContentType

func (r PatchFacilityListingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PatchFacilityListingResponse) GetBody added in v0.8.0

func (r PatchFacilityListingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PatchFacilityListingResponse) GetJSON200 added in v0.8.0

func (r PatchFacilityListingResponse) GetJSON200() *[]Listing

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PatchFacilityListingResponse) GetJSON400 added in v0.8.0

func (r PatchFacilityListingResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PatchFacilityListingResponse) GetJSON401 added in v0.8.0

func (r PatchFacilityListingResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PatchFacilityListingResponse) GetJSON403 added in v0.8.0

func (r PatchFacilityListingResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PatchFacilityListingResponse) GetJSON404 added in v0.8.0

func (r PatchFacilityListingResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PatchFacilityListingResponse) GetJSON409 added in v0.8.0

func (r PatchFacilityListingResponse) GetJSON409() *ApiError

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PatchFacilityListingResponse) Status

Status returns HTTPResponse.Status

func (PatchFacilityListingResponse) StatusCode

func (r PatchFacilityListingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PatchFacilityResponse

type PatchFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PatchFacility200JSONResponseBody
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ApiError
}

func ParsePatchFacilityResponse

func ParsePatchFacilityResponse(rsp *http.Response) (*PatchFacilityResponse, error)

ParsePatchFacilityResponse parses an HTTP response from a PatchFacilityWithResponse call

func (PatchFacilityResponse) ContentType

func (r PatchFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PatchFacilityResponse) GetBody added in v0.8.0

func (r PatchFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PatchFacilityResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PatchFacilityResponse) GetJSON401 added in v0.8.0

func (r PatchFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PatchFacilityResponse) GetJSON403 added in v0.8.0

func (r PatchFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PatchFacilityResponse) GetJSON404 added in v0.8.0

func (r PatchFacilityResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PatchFacilityResponse) GetJSON409 added in v0.8.0

func (r PatchFacilityResponse) GetJSON409() *ApiError

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PatchFacilityResponse) Status

func (r PatchFacilityResponse) Status() string

Status returns HTTPResponse.Status

func (PatchFacilityResponse) StatusCode

func (r PatchFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PatchRoleJSONRequestBody

type PatchRoleJSONRequestBody = RoleForPatch

PatchRoleJSONRequestBody defines body for PatchRole for application/json ContentType.

type PatchRoleResponse

type PatchRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Role
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParsePatchRoleResponse

func ParsePatchRoleResponse(rsp *http.Response) (*PatchRoleResponse, error)

ParsePatchRoleResponse parses an HTTP response from a PatchRoleWithResponse call

func (PatchRoleResponse) ContentType

func (r PatchRoleResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PatchRoleResponse) GetBody added in v0.8.0

func (r PatchRoleResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PatchRoleResponse) GetJSON200 added in v0.8.0

func (r PatchRoleResponse) GetJSON200() *Role

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PatchRoleResponse) GetJSON401 added in v0.8.0

func (r PatchRoleResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PatchRoleResponse) GetJSON403 added in v0.8.0

func (r PatchRoleResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PatchRoleResponse) GetJSON404 added in v0.8.0

func (r PatchRoleResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PatchRoleResponse) Status

func (r PatchRoleResponse) Status() string

Status returns HTTPResponse.Status

func (PatchRoleResponse) StatusCode

func (r PatchRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PerformStocksActionsJSONRequestBody

type PerformStocksActionsJSONRequestBody = StockAction

PerformStocksActionsJSONRequestBody defines body for PerformStocksActions for application/json ContentType.

type PerformStocksActionsResponse

type PerformStocksActionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StockActionResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParsePerformStocksActionsResponse

func ParsePerformStocksActionsResponse(rsp *http.Response) (*PerformStocksActionsResponse, error)

ParsePerformStocksActionsResponse parses an HTTP response from a PerformStocksActionsWithResponse call

func (PerformStocksActionsResponse) ContentType

func (r PerformStocksActionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PerformStocksActionsResponse) GetBody added in v0.8.0

func (r PerformStocksActionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PerformStocksActionsResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PerformStocksActionsResponse) GetJSON401 added in v0.8.0

func (r PerformStocksActionsResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PerformStocksActionsResponse) GetJSON403 added in v0.8.0

func (r PerformStocksActionsResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PerformStocksActionsResponse) Status

Status returns HTTPResponse.Status

func (PerformStocksActionsResponse) StatusCode

func (r PerformStocksActionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Permission

type Permission struct {
	// Description The localized description of the permission
	Description *string `json:"description,omitempty"`

	// Group The group of the permission
	Group PermissionGroup `json:"group"`

	// Key The key of the permission
	Key PermissionKey `json:"key"`

	// Operation The operation of the permission
	Operation PermissionOperation `json:"operation"`

	// SubGroup The subgroup of the permission
	SubGroup PermissionSubGroup `json:"subGroup"`
}

Permission Permission

type PermissionGroup

type PermissionGroup string

PermissionGroup The group of the permission

const (
	PermissionGroupADMIN                PermissionGroup = "ADMIN"
	PermissionGroupCORE                 PermissionGroup = "CORE"
	PermissionGroupFOUNDATION           PermissionGroup = "FOUNDATION"
	PermissionGroupINVENTORY            PermissionGroup = "INVENTORY"
	PermissionGroupOPERATIONS           PermissionGroup = "OPERATIONS"
	PermissionGroupORDERMANAGEMENT      PermissionGroup = "ORDER_MANAGEMENT"
	PermissionGroupSYSTEMADMINISTRATION PermissionGroup = "SYSTEM_ADMINISTRATION"
	PermissionGroupUSERMANAGEMENT       PermissionGroup = "USER_MANAGEMENT"
)

Defines values for PermissionGroup.

func (PermissionGroup) Valid

func (e PermissionGroup) Valid() bool

Valid indicates whether the value is a known member of the PermissionGroup enum.

type PermissionKey

type PermissionKey string

PermissionKey The key of the permission

const (
	PermissionKeyADMINDATARESET                        PermissionKey = "ADMIN_DATA_RESET"
	PermissionKeyADMININTERFACILITYCONNECTIONMIGRATION PermissionKey = "ADMIN_INTER_FACILITY_CONNECTION_MIGRATION"
	PermissionKeyADMINMODULESREAD                      PermissionKey = "ADMIN_MODULES_READ"
	PermissionKeyADMINMODULESWRITE                     PermissionKey = "ADMIN_MODULES_WRITE"
	PermissionKeyADMINROUTINGPLANANALYSIS              PermissionKey = "ADMIN_ROUTING_PLAN_ANALYSIS"
	PermissionKeyAIASSISTANTACCESS                     PermissionKey = "AI_ASSISTANT_ACCESS"
	PermissionKeyANALYTICSDASHBOARDREAD                PermissionKey = "ANALYTICS_DASHBOARD_READ"
	PermissionKeyAUDITREAD                             PermissionKey = "AUDIT_READ"
	PermissionKeyAVAILABILITYCHANNELREAD               PermissionKey = "AVAILABILITY_CHANNEL_READ"
	PermissionKeyAVAILABILITYCHANNELWRITE              PermissionKey = "AVAILABILITY_CHANNEL_WRITE"
	PermissionKeyAVAILABILITYTHRESHOLDSREAD            PermissionKey = "AVAILABILITY_THRESHOLDS_READ"
	PermissionKeyAVAILABILITYTHRESHOLDSWRITE           PermissionKey = "AVAILABILITY_THRESHOLDS_WRITE"
	PermissionKeyBRANDREAD                             PermissionKey = "BRAND_READ"
	PermissionKeyCARRIERREAD                           PermissionKey = "CARRIER_READ"
	PermissionKeyCARRIERWRITE                          PermissionKey = "CARRIER_WRITE"
	PermissionKeyCATEGORYREAD                          PermissionKey = "CATEGORY_READ"
	PermissionKeyCATEGORYWRITE                         PermissionKey = "CATEGORY_WRITE"
	PermissionKeyCONFIGREAD                            PermissionKey = "CONFIG_READ"
	PermissionKeyCONFIGWRITE                           PermissionKey = "CONFIG_WRITE"
	PermissionKeyCURRENTUSERMODIFY                     PermissionKey = "CURRENT_USER_MODIFY"
	PermissionKeyCURRENTUSERREAD                       PermissionKey = "CURRENT_USER_READ"
	PermissionKeyCUSTOMSERVICEREAD                     PermissionKey = "CUSTOM_SERVICE_READ"
	PermissionKeyCUSTOMSERVICEWRITE                    PermissionKey = "CUSTOM_SERVICE_WRITE"
	PermissionKeyDELIVERYNOTEWRITE                     PermissionKey = "DELIVERYNOTE_WRITE"
	PermissionKeyDOCUMENTSETREAD                       PermissionKey = "DOCUMENT_SET_READ"
	PermissionKeyDOCUMENTSETWRITE                      PermissionKey = "DOCUMENT_SET_WRITE"
	PermissionKeyDOMSSTATISTICSREAD                    PermissionKey = "DOMS_STATISTICS_READ"
	PermissionKeyDOMSTOOLKITREAD                       PermissionKey = "DOMS_TOOLKIT_READ"
	PermissionKeyDOMSTOOLKITWRITE                      PermissionKey = "DOMS_TOOLKIT_WRITE"
	PermissionKeyEVENTREAD                             PermissionKey = "EVENT_READ"
	PermissionKeyEXPIRIESREAD                          PermissionKey = "EXPIRIES_READ"
	PermissionKeyEXPIRIESWRITE                         PermissionKey = "EXPIRIES_WRITE"
	PermissionKeyEXPORTREAD                            PermissionKey = "EXPORT_READ"
	PermissionKeyEXPORTWRITE                           PermissionKey = "EXPORT_WRITE"
	PermissionKeyEXTERNALACTIONSREAD                   PermissionKey = "EXTERNAL_ACTIONS_READ"
	PermissionKeyEXTERNALACTIONSWRITE                  PermissionKey = "EXTERNAL_ACTIONS_WRITE"
	PermissionKeyEXTERNALSTOCKCHANGEREASONSREAD        PermissionKey = "EXTERNAL_STOCK_CHANGE_REASONS_READ"
	PermissionKeyEXTERNALSTOCKCHANGEREASONSWRITE       PermissionKey = "EXTERNAL_STOCK_CHANGE_REASONS_WRITE"
	PermissionKeyFACILITYCREATE                        PermissionKey = "FACILITY_CREATE"
	PermissionKeyFACILITYDELETE                        PermissionKey = "FACILITY_DELETE"
	PermissionKeyFACILITYGROUPREAD                     PermissionKey = "FACILITY_GROUP_READ"
	PermissionKeyFACILITYGROUPWRITE                    PermissionKey = "FACILITY_GROUP_WRITE"
	PermissionKeyFACILITYREAD                          PermissionKey = "FACILITY_READ"
	PermissionKeyFACILITYWRITE                         PermissionKey = "FACILITY_WRITE"
	PermissionKeyFILTERENTITYREAD                      PermissionKey = "FILTER_ENTITY_READ"
	PermissionKeyHANDOVERCONTAINERREAD                 PermissionKey = "HANDOVER_CONTAINER_READ"
	PermissionKeyHANDOVERCONTAINERWRITE                PermissionKey = "HANDOVER_CONTAINER_WRITE"
	PermissionKeyHANDOVERJOBREAD                       PermissionKey = "HANDOVERJOB_READ"
	PermissionKeyHANDOVERJOBWRITE                      PermissionKey = "HANDOVERJOB_WRITE"
	PermissionKeyINBOUNDPROCESSREAD                    PermissionKey = "INBOUND_PROCESS_READ"
	PermissionKeyINBOUNDPROCESSWRITE                   PermissionKey = "INBOUND_PROCESS_WRITE"
	PermissionKeyKPIREAD                               PermissionKey = "KPI_READ"
	PermissionKeyLINEITEMADD                           PermissionKey = "LINE_ITEM_ADD"
	PermissionKeyLINEITEMDELETE                        PermissionKey = "LINE_ITEM_DELETE"
	PermissionKeyLINEITEMPRICINGREAD                   PermissionKey = "LINE_ITEM_PRICING_READ"
	PermissionKeyLINEITEMQUANTITYDECREASE              PermissionKey = "LINE_ITEM_QUANTITY_DECREASE"
	PermissionKeyLINEITEMQUANTITYINCREASE              PermissionKey = "LINE_ITEM_QUANTITY_INCREASE"
	PermissionKeyLINKEDSERVICEJOBSREAD                 PermissionKey = "LINKED_SERVICE_JOBS_READ"
	PermissionKeyLINKEDSERVICEJOBSWRITE                PermissionKey = "LINKED_SERVICE_JOBS_WRITE"
	PermissionKeyLISTINGDELETE                         PermissionKey = "LISTING_DELETE"
	PermissionKeyLISTINGREAD                           PermissionKey = "LISTING_READ"
	PermissionKeyLISTINGWRITE                          PermissionKey = "LISTING_WRITE"
	PermissionKeyLOADUNITREAD                          PermissionKey = "LOADUNIT_READ"
	PermissionKeyLOADUNITTYPEREAD                      PermissionKey = "LOADUNITTYPE_READ"
	PermissionKeyLOADUNITTYPEWRITE                     PermissionKey = "LOADUNITTYPE_WRITE"
	PermissionKeyLOADUNITWRITE                         PermissionKey = "LOADUNIT_WRITE"
	PermissionKeyLOCALEWRITE                           PermissionKey = "LOCALE_WRITE"
	PermissionKeyLOOKUPRECORDREAD                      PermissionKey = "LOOKUP_RECORD_READ"
	PermissionKeyLOOKUPRECORDWRITE                     PermissionKey = "LOOKUP_RECORD_WRITE"
	PermissionKeyMEASUREMENTUNITREAD                   PermissionKey = "MEASUREMENTUNIT_READ"
	PermissionKeyMEASUREMENTUNITWRITE                  PermissionKey = "MEASUREMENTUNIT_WRITE"
	PermissionKeyNOTIFICATIONCENTERCONFIGREAD          PermissionKey = "NOTIFICATION_CENTER_CONFIG_READ"
	PermissionKeyNOTIFICATIONCENTERCONFIGWRITE         PermissionKey = "NOTIFICATION_CENTER_CONFIG_WRITE"
	PermissionKeyNOTIFICATIONREAD                      PermissionKey = "NOTIFICATION_READ"
	PermissionKeyNOTIFICATIONWRITE                     PermissionKey = "NOTIFICATION_WRITE"
	PermissionKeyOIDCPROVIDERSCONFIGREAD               PermissionKey = "OIDC_PROVIDERS_CONFIG_READ"
	PermissionKeyOIDCPROVIDERSCONFIGWRITE              PermissionKey = "OIDC_PROVIDERS_CONFIG_WRITE"
	PermissionKeyOPERATIONSTATISTICSREAD               PermissionKey = "OPERATION_STATISTICS_READ"
	PermissionKeyOPERATIVEPROCESSREAD                  PermissionKey = "OPERATIVE_PROCESS_READ"
	PermissionKeyOPERATIVEPROCESSWRITE                 PermissionKey = "OPERATIVE_PROCESS_WRITE"
	PermissionKeyORDERCANCEL                           PermissionKey = "ORDER_CANCEL"
	PermissionKeyORDERCONSUMERWRITE                    PermissionKey = "ORDER_CONSUMER_WRITE"
	PermissionKeyORDERCUSTOMATTRIBUTESWRITE            PermissionKey = "ORDER_CUSTOM_ATTRIBUTES_WRITE"
	PermissionKeyORDERDELIVERYPROMISEWRITE             PermissionKey = "ORDER_DELIVERY_PROMISE_WRITE"
	PermissionKeyORDERFORCECANCEL                      PermissionKey = "ORDER_FORCE_CANCEL"
	PermissionKeyORDERLINEITEMWRITE                    PermissionKey = "ORDER_LINEITEM_WRITE"
	PermissionKeyORDERREAD                             PermissionKey = "ORDER_READ"
	PermissionKeyORDERRECORDREAD                       PermissionKey = "ORDER_RECORD_READ"
	PermissionKeyORDERRECORDWRITE                      PermissionKey = "ORDER_RECORD_WRITE"
	PermissionKeyORDERTOTALREAD                        PermissionKey = "ORDER_TOTAL_READ"
	PermissionKeyORDERUNLOCK                           PermissionKey = "ORDER_UNLOCK"
	PermissionKeyORDERWRITE                            PermissionKey = "ORDER_WRITE"
	PermissionKeyPACKAGINGUNITSREAD                    PermissionKey = "PACKAGING_UNITS_READ"
	PermissionKeyPACKAGINGUNITSWRITE                   PermissionKey = "PACKAGING_UNITS_WRITE"
	PermissionKeyPACKINGCONTAINERTYPEWRITE             PermissionKey = "PACKINGCONTAINER_TYPE_WRITE"
	PermissionKeyPACKINGSOURCECONTAINERREAD            PermissionKey = "PACKING_SOURCE_CONTAINER_READ"
	PermissionKeyPACKINGSOURCECONTAINERWRITE           PermissionKey = "PACKING_SOURCE_CONTAINER_WRITE"
	PermissionKeyPACKJOBREAD                           PermissionKey = "PACKJOB_READ"
	PermissionKeyPACKJOBWRITE                          PermissionKey = "PACKJOB_WRITE"
	PermissionKeyPARCELREAD                            PermissionKey = "PARCEL_READ"
	PermissionKeyPARCELWRITE                           PermissionKey = "PARCEL_WRITE"
	PermissionKeyPERMISSIONREAD                        PermissionKey = "PERMISSION_READ"
	PermissionKeyPICKJOBREAD                           PermissionKey = "PICKJOB_READ"
	PermissionKeyPICKJOBREROUTE                        PermissionKey = "PICKJOB_REROUTE"
	PermissionKeyPICKJOBWRITE                          PermissionKey = "PICKJOB_WRITE"
	PermissionKeyPICKRUNREAD                           PermissionKey = "PICKRUN_READ"
	PermissionKeyPICKRUNWRITE                          PermissionKey = "PICKRUN_WRITE"
	PermissionKeyPICKUPSERVICEREAD                     PermissionKey = "PICKUP_SERVICE_READ"
	PermissionKeyPICKUPSERVICEWRITE                    PermissionKey = "PICKUP_SERVICE_WRITE"
	PermissionKeyPROCESSLOGREAD                        PermissionKey = "PROCESS_LOG_READ"
	PermissionKeyPROCESSREAD                           PermissionKey = "PROCESS_READ"
	PermissionKeyPROCESSREROUTE                        PermissionKey = "PROCESS_REROUTE"
	PermissionKeyPROCESSWRITE                          PermissionKey = "PROCESS_WRITE"
	PermissionKeyPROMISESCONFIGREAD                    PermissionKey = "PROMISES_CONFIG_READ"
	PermissionKeyPROMISESCONFIGWRITE                   PermissionKey = "PROMISES_CONFIG_WRITE"
	PermissionKeyPURCHASEPRICEREAD                     PermissionKey = "PURCHASE_PRICE_READ"
	PermissionKeyREMOTECONFIGREAD                      PermissionKey = "REMOTE_CONFIG_READ"
	PermissionKeyREMOTECONFIGWRITE                     PermissionKey = "REMOTE_CONFIG_WRITE"
	PermissionKeyRESERVATIONREAD                       PermissionKey = "RESERVATION_READ"
	PermissionKeyRESERVATIONWRITE                      PermissionKey = "RESERVATION_WRITE"
	PermissionKeyRESTOWITEMREAD                        PermissionKey = "RESTOW_ITEM_READ"
	PermissionKeyRESTOWITEMWRITE                       PermissionKey = "RESTOW_ITEM_WRITE"
	PermissionKeyRETURNREAD                            PermissionKey = "RETURN_READ"
	PermissionKeyRETURNWRITE                           PermissionKey = "RETURN_WRITE"
	PermissionKeyROLEREAD                              PermissionKey = "ROLE_READ"
	PermissionKeyROLEWRITE                             PermissionKey = "ROLE_WRITE"
	PermissionKeyROUTINGCONFIGREAD                     PermissionKey = "ROUTING_CONFIG_READ"
	PermissionKeyROUTINGCONFIGWRITE                    PermissionKey = "ROUTING_CONFIG_WRITE"
	PermissionKeyROUTINGREAD                           PermissionKey = "ROUTING_READ"
	PermissionKeyROUTINGWRITE                          PermissionKey = "ROUTING_WRITE"
	PermissionKeySAFETYSTOCKREAD                       PermissionKey = "SAFETY_STOCK_READ"
	PermissionKeySAFETYSTOCKWRITE                      PermissionKey = "SAFETY_STOCK_WRITE"
	PermissionKeySERVICEJOBREAD                        PermissionKey = "SERVICE_JOB_READ"
	PermissionKeySERVICEJOBWRITE                       PermissionKey = "SERVICE_JOB_WRITE"
	PermissionKeySHIPMENTREAD                          PermissionKey = "SHIPMENT_READ"
	PermissionKeySHIPMENTWRITE                         PermissionKey = "SHIPMENT_WRITE"
	PermissionKeySIMULATIONORDERREAD                   PermissionKey = "SIMULATION_ORDER_READ"
	PermissionKeySIMULATIONORDERWRITE                  PermissionKey = "SIMULATION_ORDER_WRITE"
	PermissionKeySTACKSREAD                            PermissionKey = "STACKS_READ"
	PermissionKeySTACKSWRITE                           PermissionKey = "STACKS_WRITE"
	PermissionKeySTOCKAVAILABILITIESREAD               PermissionKey = "STOCK_AVAILABILITIES_READ"
	PermissionKeySTOCKREAD                             PermissionKey = "STOCK_READ"
	PermissionKeySTOCKWRITE                            PermissionKey = "STOCK_WRITE"
	PermissionKeySTORAGELOCATIONREAD                   PermissionKey = "STORAGE_LOCATION_READ"
	PermissionKeySTORAGELOCATIONWRITE                  PermissionKey = "STORAGE_LOCATION_WRITE"
	PermissionKeySTOWJOBFULLWRITE                      PermissionKey = "STOW_JOB_FULL_WRITE"
	PermissionKeySTOWJOBOPERATIVEWRITE                 PermissionKey = "STOW_JOB_OPERATIVE_WRITE"
	PermissionKeySTOWJOBREAD                           PermissionKey = "STOW_JOB_READ"
	PermissionKeySUBSCRIPTIONREAD                      PermissionKey = "SUBSCRIPTION_READ"
	PermissionKeySUBSCRIPTIONWRITE                     PermissionKey = "SUBSCRIPTION_WRITE"
	PermissionKeySUBSTITUTEREAD                        PermissionKey = "SUBSTITUTE_READ"
	PermissionKeySUBSTITUTEWRITE                       PermissionKey = "SUBSTITUTE_WRITE"
	PermissionKeyTAGREAD                               PermissionKey = "TAG_READ"
	PermissionKeyTAGWRITE                              PermissionKey = "TAG_WRITE"
	PermissionKeyTENANTCONNECTORCONFIGREAD             PermissionKey = "TENANT_CONNECTOR_CONFIG_READ"
	PermissionKeyUSERMODIFY                            PermissionKey = "USER_MODIFY"
	PermissionKeyUSERREAD                              PermissionKey = "USER_READ"
	PermissionKeyUSERSREAD                             PermissionKey = "USERS_READ"
	PermissionKeyUSERWRITE                             PermissionKey = "USER_WRITE"
	PermissionKeyVALIDATIONSREAD                       PermissionKey = "VALIDATIONS_READ"
	PermissionKeyWORKFLOWDEFINITIONREAD                PermissionKey = "WORKFLOW_DEFINITION_READ"
	PermissionKeyWORKFLOWDEFINITIONWRITE               PermissionKey = "WORKFLOW_DEFINITION_WRITE"
	PermissionKeyZONEREAD                              PermissionKey = "ZONE_READ"
	PermissionKeyZONEWRITE                             PermissionKey = "ZONE_WRITE"
)

Defines values for PermissionKey.

func (PermissionKey) Valid

func (e PermissionKey) Valid() bool

Valid indicates whether the value is a known member of the PermissionKey enum.

type PermissionOperation

type PermissionOperation string

PermissionOperation The operation of the permission

const (
	PermissionOperationADD                   PermissionOperation = "ADD"
	PermissionOperationCANCEL                PermissionOperation = "CANCEL"
	PermissionOperationCONSUMERWRITE         PermissionOperation = "CONSUMER_WRITE"
	PermissionOperationCREATE                PermissionOperation = "CREATE"
	PermissionOperationCUSTOMATTRIBUTESWRITE PermissionOperation = "CUSTOM_ATTRIBUTES_WRITE"
	PermissionOperationDELETE                PermissionOperation = "DELETE"
	PermissionOperationDELIVERYPROMISEWRITE  PermissionOperation = "DELIVERY_PROMISE_WRITE"
	PermissionOperationFORCECANCEL           PermissionOperation = "FORCE_CANCEL"
	PermissionOperationLINEITEMWRITE         PermissionOperation = "LINEITEM_WRITE"
	PermissionOperationLIST                  PermissionOperation = "LIST"
	PermissionOperationMODIFY                PermissionOperation = "MODIFY"
	PermissionOperationPRICINGREAD           PermissionOperation = "PRICING_READ"
	PermissionOperationQUANTITYDECREASE      PermissionOperation = "QUANTITY_DECREASE"
	PermissionOperationQUANTITYINCREASE      PermissionOperation = "QUANTITY_INCREASE"
	PermissionOperationREAD                  PermissionOperation = "READ"
	PermissionOperationREROUTE               PermissionOperation = "REROUTE"
	PermissionOperationRESET                 PermissionOperation = "RESET"
	PermissionOperationTOTALREAD             PermissionOperation = "TOTAL_READ"
	PermissionOperationUNLOCK                PermissionOperation = "UNLOCK"
	PermissionOperationWRITE                 PermissionOperation = "WRITE"
)

Defines values for PermissionOperation.

func (PermissionOperation) Valid

func (e PermissionOperation) Valid() bool

Valid indicates whether the value is a known member of the PermissionOperation enum.

type PermissionSubGroup

type PermissionSubGroup string

PermissionSubGroup The subgroup of the permission

const (
	PermissionSubGroupADMINDATA                  PermissionSubGroup = "ADMIN_DATA"
	PermissionSubGroupADMINMODULES               PermissionSubGroup = "ADMIN_MODULES"
	PermissionSubGroupAISIDEKICK                 PermissionSubGroup = "AI_SIDEKICK"
	PermissionSubGroupANALYTICSDASHBOARD         PermissionSubGroup = "ANALYTICS_DASHBOARD"
	PermissionSubGroupAUDIT                      PermissionSubGroup = "AUDIT"
	PermissionSubGroupAVAILABILITYCHANNEL        PermissionSubGroup = "AVAILABILITY_CHANNEL"
	PermissionSubGroupAVAILABILITYTHRESHOLDS     PermissionSubGroup = "AVAILABILITY_THRESHOLDS"
	PermissionSubGroupBRAND                      PermissionSubGroup = "BRAND"
	PermissionSubGroupCARRIER                    PermissionSubGroup = "CARRIER"
	PermissionSubGroupCATEGORY                   PermissionSubGroup = "CATEGORY"
	PermissionSubGroupCONFIG                     PermissionSubGroup = "CONFIG"
	PermissionSubGroupCURRENTUSER                PermissionSubGroup = "CURRENT_USER"
	PermissionSubGroupCUSTOMSERVICE              PermissionSubGroup = "CUSTOM_SERVICE"
	PermissionSubGroupDELIVERYNOTE               PermissionSubGroup = "DELIVERYNOTE"
	PermissionSubGroupDOCUMENTSET                PermissionSubGroup = "DOCUMENT_SET"
	PermissionSubGroupDOMSSTATISTICS             PermissionSubGroup = "DOMS_STATISTICS"
	PermissionSubGroupDOMSTOOLKIT                PermissionSubGroup = "DOMS_TOOLKIT"
	PermissionSubGroupEVENT                      PermissionSubGroup = "EVENT"
	PermissionSubGroupEXPIRY                     PermissionSubGroup = "EXPIRY"
	PermissionSubGroupEXPORT                     PermissionSubGroup = "EXPORT"
	PermissionSubGroupEXTERNALACTIONS            PermissionSubGroup = "EXTERNAL_ACTIONS"
	PermissionSubGroupEXTERNALSTOCKCHANGEREASONS PermissionSubGroup = "EXTERNAL_STOCK_CHANGE_REASONS"
	PermissionSubGroupFACILITY                   PermissionSubGroup = "FACILITY"
	PermissionSubGroupFACILITYGROUP              PermissionSubGroup = "FACILITY_GROUP"
	PermissionSubGroupFILTERENTITY               PermissionSubGroup = "FILTER_ENTITY"
	PermissionSubGroupHANDOVERCONTAINER          PermissionSubGroup = "HANDOVER_CONTAINER"
	PermissionSubGroupHANDOVERJOB                PermissionSubGroup = "HANDOVERJOB"
	PermissionSubGroupHANDOVERJOB1               PermissionSubGroup = "HANDOVER_JOB"
	PermissionSubGroupINBOUNDPROCESS             PermissionSubGroup = "INBOUND_PROCESS"
	PermissionSubGroupKPI                        PermissionSubGroup = "KPI"
	PermissionSubGroupLINEITEM                   PermissionSubGroup = "LINE_ITEM"
	PermissionSubGroupLINKEDSERVICEJOBS          PermissionSubGroup = "LINKED_SERVICE_JOBS"
	PermissionSubGroupLISTING                    PermissionSubGroup = "LISTING"
	PermissionSubGroupLOADUNIT                   PermissionSubGroup = "LOADUNIT"
	PermissionSubGroupLOADUNIT1                  PermissionSubGroup = "LOAD_UNIT"
	PermissionSubGroupLOADUNITTYPE               PermissionSubGroup = "LOADUNIT_TYPE"
	PermissionSubGroupLOADUNITTYPE1              PermissionSubGroup = "LOAD_UNIT_TYPE"
	PermissionSubGroupLOCALE                     PermissionSubGroup = "LOCALE"
	PermissionSubGroupLOOKUPRECORD               PermissionSubGroup = "LOOKUP_RECORD"
	PermissionSubGroupMEASUREMENTUNIT            PermissionSubGroup = "MEASUREMENT_UNIT"
	PermissionSubGroupNOTIFICATION               PermissionSubGroup = "NOTIFICATION"
	PermissionSubGroupNOTIFICATIONCENTERCONFIG   PermissionSubGroup = "NOTIFICATION_CENTER_CONFIG"
	PermissionSubGroupOIDCPROVIDERCONFIG         PermissionSubGroup = "OIDC_PROVIDER_CONFIG"
	PermissionSubGroupOPERATIONSTATISTICS        PermissionSubGroup = "OPERATION_STATISTICS"
	PermissionSubGroupOPERATIVEPROCESS           PermissionSubGroup = "OPERATIVE_PROCESS"
	PermissionSubGroupORDER                      PermissionSubGroup = "ORDER"
	PermissionSubGroupORDERRECORD                PermissionSubGroup = "ORDER_RECORD"
	PermissionSubGroupPACKAGINGUNITS             PermissionSubGroup = "PACKAGING_UNITS"
	PermissionSubGroupPACKINGCONTAINERTYPE       PermissionSubGroup = "PACKINGCONTAINER_TYPE"
	PermissionSubGroupPACKINGCONTAINERTYPE1      PermissionSubGroup = "PACKING_CONTAINER_TYPE"
	PermissionSubGroupPACKINGSOURCECONTAINER     PermissionSubGroup = "PACKING_SOURCE_CONTAINER"
	PermissionSubGroupPACKJOB                    PermissionSubGroup = "PACKJOB"
	PermissionSubGroupPACKJOB1                   PermissionSubGroup = "PACK_JOB"
	PermissionSubGroupPARCEL                     PermissionSubGroup = "PARCEL"
	PermissionSubGroupPERMISSION                 PermissionSubGroup = "PERMISSION"
	PermissionSubGroupPICKJOB                    PermissionSubGroup = "PICKJOB"
	PermissionSubGroupPICKJOB1                   PermissionSubGroup = "PICK_JOB"
	PermissionSubGroupPICKRUN                    PermissionSubGroup = "PICKRUN"
	PermissionSubGroupPICKRUN1                   PermissionSubGroup = "PICK_RUN"
	PermissionSubGroupPICKUPSERVICE              PermissionSubGroup = "PICKUP_SERVICE"
	PermissionSubGroupPROCESS                    PermissionSubGroup = "PROCESS"
	PermissionSubGroupPROCESSLOGS                PermissionSubGroup = "PROCESS_LOGS"
	PermissionSubGroupPROMISESCONFIG             PermissionSubGroup = "PROMISES_CONFIG"
	PermissionSubGroupPURCHASEPRICE              PermissionSubGroup = "PURCHASE_PRICE"
	PermissionSubGroupREMOTECONFIG               PermissionSubGroup = "REMOTE_CONFIG"
	PermissionSubGroupRESERVATION                PermissionSubGroup = "RESERVATION"
	PermissionSubGroupRESTOWITEM                 PermissionSubGroup = "RESTOW_ITEM"
	PermissionSubGroupRETURN                     PermissionSubGroup = "RETURN"
	PermissionSubGroupROLE                       PermissionSubGroup = "ROLE"
	PermissionSubGroupROUTING                    PermissionSubGroup = "ROUTING"
	PermissionSubGroupROUTINGCONFIG              PermissionSubGroup = "ROUTING_CONFIG"
	PermissionSubGroupSAFETYSTOCK                PermissionSubGroup = "SAFETY_STOCK"
	PermissionSubGroupSERVICEJOB                 PermissionSubGroup = "SERVICE_JOB"
	PermissionSubGroupSHIPMENT                   PermissionSubGroup = "SHIPMENT"
	PermissionSubGroupSIMULATIONORDER            PermissionSubGroup = "SIMULATION_ORDER"
	PermissionSubGroupSTACKS                     PermissionSubGroup = "STACKS"
	PermissionSubGroupSTOCK                      PermissionSubGroup = "STOCK"
	PermissionSubGroupSTOCKAVAILABILITIES        PermissionSubGroup = "STOCK_AVAILABILITIES"
	PermissionSubGroupSTORAGELOCATION            PermissionSubGroup = "STORAGE_LOCATION"
	PermissionSubGroupSTOWJOB                    PermissionSubGroup = "STOW_JOB"
	PermissionSubGroupSUBSCRIPTION               PermissionSubGroup = "SUBSCRIPTION"
	PermissionSubGroupSUBSTITUTE                 PermissionSubGroup = "SUBSTITUTE"
	PermissionSubGroupTAG                        PermissionSubGroup = "TAG"
	PermissionSubGroupTENANTCONNECTORCONFIG      PermissionSubGroup = "TENANT_CONNECTOR_CONFIG"
	PermissionSubGroupUSER                       PermissionSubGroup = "USER"
	PermissionSubGroupVALIDATIONS                PermissionSubGroup = "VALIDATIONS"
	PermissionSubGroupWORKFLOWDEFINITION         PermissionSubGroup = "WORKFLOW_DEFINITION"
	PermissionSubGroupZONE                       PermissionSubGroup = "ZONE"
)

Defines values for PermissionSubGroup.

func (PermissionSubGroup) Valid

func (e PermissionSubGroup) Valid() bool

Valid indicates whether the value is a known member of the PermissionSubGroup enum.

type PermissionsResponse

type PermissionsResponse struct {
	// Permissions The list of permissions
	Permissions []Permission `json:"permissions"`

	// Total The total number of (filtered) permissions
	Total float32 `json:"total"`
}

PermissionsResponse PermissionsResponse

type PickJobPickingMethodEnumEnumFilter

type PickJobPickingMethodEnumEnumFilter struct {
	// Eq Search by preferredPickingMethods
	Eq *PickJobPickingMethodEnumEnumFilterEq `json:"eq,omitempty"`

	// In Search by preferredPickingMethods
	In *[]PickJobPickingMethodEnumEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by preferredPickingMethods
	NotEq *PickJobPickingMethodEnumEnumFilterNotEq `json:"notEq,omitempty"`
}

PickJobPickingMethodEnumEnumFilter PickJobPickingMethodEnumEnumFilter

type PickJobPickingMethodEnumEnumFilterEq

type PickJobPickingMethodEnumEnumFilterEq string

PickJobPickingMethodEnumEnumFilterEq Search by preferredPickingMethods

const (
	PickJobPickingMethodEnumEnumFilterEqBATCH        PickJobPickingMethodEnumEnumFilterEq = "BATCH"
	PickJobPickingMethodEnumEnumFilterEqBATCHPICKING PickJobPickingMethodEnumEnumFilterEq = "BATCH_PICKING"
	PickJobPickingMethodEnumEnumFilterEqMULTIORDER   PickJobPickingMethodEnumEnumFilterEq = "MULTI_ORDER"
	PickJobPickingMethodEnumEnumFilterEqSINGLEORDER  PickJobPickingMethodEnumEnumFilterEq = "SINGLE_ORDER"
)

Defines values for PickJobPickingMethodEnumEnumFilterEq.

func (PickJobPickingMethodEnumEnumFilterEq) Valid

Valid indicates whether the value is a known member of the PickJobPickingMethodEnumEnumFilterEq enum.

type PickJobPickingMethodEnumEnumFilterIn

type PickJobPickingMethodEnumEnumFilterIn string

PickJobPickingMethodEnumEnumFilterIn defines model for PickJobPickingMethodEnumEnumFilter.In.

const (
	PickJobPickingMethodEnumEnumFilterInBATCH        PickJobPickingMethodEnumEnumFilterIn = "BATCH"
	PickJobPickingMethodEnumEnumFilterInBATCHPICKING PickJobPickingMethodEnumEnumFilterIn = "BATCH_PICKING"
	PickJobPickingMethodEnumEnumFilterInMULTIORDER   PickJobPickingMethodEnumEnumFilterIn = "MULTI_ORDER"
	PickJobPickingMethodEnumEnumFilterInSINGLEORDER  PickJobPickingMethodEnumEnumFilterIn = "SINGLE_ORDER"
)

Defines values for PickJobPickingMethodEnumEnumFilterIn.

func (PickJobPickingMethodEnumEnumFilterIn) Valid

Valid indicates whether the value is a known member of the PickJobPickingMethodEnumEnumFilterIn enum.

type PickJobPickingMethodEnumEnumFilterNotEq

type PickJobPickingMethodEnumEnumFilterNotEq string

PickJobPickingMethodEnumEnumFilterNotEq Search by preferredPickingMethods

const (
	PickJobPickingMethodEnumEnumFilterNotEqBATCH        PickJobPickingMethodEnumEnumFilterNotEq = "BATCH"
	PickJobPickingMethodEnumEnumFilterNotEqBATCHPICKING PickJobPickingMethodEnumEnumFilterNotEq = "BATCH_PICKING"
	PickJobPickingMethodEnumEnumFilterNotEqMULTIORDER   PickJobPickingMethodEnumEnumFilterNotEq = "MULTI_ORDER"
	PickJobPickingMethodEnumEnumFilterNotEqSINGLEORDER  PickJobPickingMethodEnumEnumFilterNotEq = "SINGLE_ORDER"
)

Defines values for PickJobPickingMethodEnumEnumFilterNotEq.

func (PickJobPickingMethodEnumEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the PickJobPickingMethodEnumEnumFilterNotEq enum.

type PickJobPickingMethodEnumEnumListFilter

type PickJobPickingMethodEnumEnumListFilter struct {
	// Contains Search by preferredPickingMethods
	Contains *PickJobPickingMethodEnumEnumFilter `json:"contains,omitempty"`
}

PickJobPickingMethodEnumEnumListFilter PickJobPickingMethodEnumEnumListFilter

type PickJobSearchQuery

type PickJobSearchQuery struct {
	And *[]PickJobSearchQuery `json:"and,omitempty"`

	// ConsumerName Search by consumerName
	ConsumerName *StringSearchFilter `json:"consumerName,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringEqFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter           `json:"lastModified,omitempty"`
	Or           *[]PickJobSearchQuery `json:"or,omitempty"`

	// OrderRef Search by orderRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	OrderRef *StringEqFilter `json:"orderRef,omitempty"`

	// PreferredPickingMethods Search by preferredPickingMethods
	PreferredPickingMethods *PickJobPickingMethodEnumEnumListFilter `json:"preferredPickingMethods,omitempty"`

	// Status Search by status
	Status *PickJobStatusEnumFilter `json:"status,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`

	// TenantArticleIds Search by tenantArticleIds
	TenantArticleIds *StringListFilter `json:"tenantArticleIds,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringFilter `json:"tenantOrderId,omitempty"`

	// Transfers Nested list search by transfers
	Transfers *PickJobTransfersListFilter `json:"transfers,omitempty"`
}

PickJobSearchQuery PickJobSearchQuery

type PickJobStatusEnumFilter

type PickJobStatusEnumFilter struct {
	// Eq Search by status
	Eq *PickJobStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]PickJobStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *PickJobStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

PickJobStatusEnumFilter PickJobStatusEnumFilter

type PickJobStatusEnumFilterEq

type PickJobStatusEnumFilterEq string

PickJobStatusEnumFilterEq Search by status

const (
	PickJobStatusEnumFilterEqABORTED         PickJobStatusEnumFilterEq = "ABORTED"
	PickJobStatusEnumFilterEqCANCELED        PickJobStatusEnumFilterEq = "CANCELED"
	PickJobStatusEnumFilterEqCLOSED          PickJobStatusEnumFilterEq = "CLOSED"
	PickJobStatusEnumFilterEqEXPIRED         PickJobStatusEnumFilterEq = "EXPIRED"
	PickJobStatusEnumFilterEqINPROGRESS      PickJobStatusEnumFilterEq = "IN_PROGRESS"
	PickJobStatusEnumFilterEqOBSOLETE        PickJobStatusEnumFilterEq = "OBSOLETE"
	PickJobStatusEnumFilterEqOPEN            PickJobStatusEnumFilterEq = "OPEN"
	PickJobStatusEnumFilterEqPAUSED          PickJobStatusEnumFilterEq = "PAUSED"
	PickJobStatusEnumFilterEqPICKED          PickJobStatusEnumFilterEq = "PICKED"
	PickJobStatusEnumFilterEqREJECTED        PickJobStatusEnumFilterEq = "REJECTED"
	PickJobStatusEnumFilterEqREROUTED        PickJobStatusEnumFilterEq = "REROUTED"
	PickJobStatusEnumFilterEqRESTOWED        PickJobStatusEnumFilterEq = "RESTOWED"
	PickJobStatusEnumFilterEqWAITINGFORINPUT PickJobStatusEnumFilterEq = "WAITING_FOR_INPUT"
)

Defines values for PickJobStatusEnumFilterEq.

func (PickJobStatusEnumFilterEq) Valid

func (e PickJobStatusEnumFilterEq) Valid() bool

Valid indicates whether the value is a known member of the PickJobStatusEnumFilterEq enum.

type PickJobStatusEnumFilterIn

type PickJobStatusEnumFilterIn string

PickJobStatusEnumFilterIn defines model for PickJobStatusEnumFilter.In.

const (
	PickJobStatusEnumFilterInABORTED         PickJobStatusEnumFilterIn = "ABORTED"
	PickJobStatusEnumFilterInCANCELED        PickJobStatusEnumFilterIn = "CANCELED"
	PickJobStatusEnumFilterInCLOSED          PickJobStatusEnumFilterIn = "CLOSED"
	PickJobStatusEnumFilterInEXPIRED         PickJobStatusEnumFilterIn = "EXPIRED"
	PickJobStatusEnumFilterInINPROGRESS      PickJobStatusEnumFilterIn = "IN_PROGRESS"
	PickJobStatusEnumFilterInOBSOLETE        PickJobStatusEnumFilterIn = "OBSOLETE"
	PickJobStatusEnumFilterInOPEN            PickJobStatusEnumFilterIn = "OPEN"
	PickJobStatusEnumFilterInPAUSED          PickJobStatusEnumFilterIn = "PAUSED"
	PickJobStatusEnumFilterInPICKED          PickJobStatusEnumFilterIn = "PICKED"
	PickJobStatusEnumFilterInREJECTED        PickJobStatusEnumFilterIn = "REJECTED"
	PickJobStatusEnumFilterInREROUTED        PickJobStatusEnumFilterIn = "REROUTED"
	PickJobStatusEnumFilterInRESTOWED        PickJobStatusEnumFilterIn = "RESTOWED"
	PickJobStatusEnumFilterInWAITINGFORINPUT PickJobStatusEnumFilterIn = "WAITING_FOR_INPUT"
)

Defines values for PickJobStatusEnumFilterIn.

func (PickJobStatusEnumFilterIn) Valid

func (e PickJobStatusEnumFilterIn) Valid() bool

Valid indicates whether the value is a known member of the PickJobStatusEnumFilterIn enum.

type PickJobStatusEnumFilterNotEq

type PickJobStatusEnumFilterNotEq string

PickJobStatusEnumFilterNotEq Search by status

const (
	PickJobStatusEnumFilterNotEqABORTED         PickJobStatusEnumFilterNotEq = "ABORTED"
	PickJobStatusEnumFilterNotEqCANCELED        PickJobStatusEnumFilterNotEq = "CANCELED"
	PickJobStatusEnumFilterNotEqCLOSED          PickJobStatusEnumFilterNotEq = "CLOSED"
	PickJobStatusEnumFilterNotEqEXPIRED         PickJobStatusEnumFilterNotEq = "EXPIRED"
	PickJobStatusEnumFilterNotEqINPROGRESS      PickJobStatusEnumFilterNotEq = "IN_PROGRESS"
	PickJobStatusEnumFilterNotEqOBSOLETE        PickJobStatusEnumFilterNotEq = "OBSOLETE"
	PickJobStatusEnumFilterNotEqOPEN            PickJobStatusEnumFilterNotEq = "OPEN"
	PickJobStatusEnumFilterNotEqPAUSED          PickJobStatusEnumFilterNotEq = "PAUSED"
	PickJobStatusEnumFilterNotEqPICKED          PickJobStatusEnumFilterNotEq = "PICKED"
	PickJobStatusEnumFilterNotEqREJECTED        PickJobStatusEnumFilterNotEq = "REJECTED"
	PickJobStatusEnumFilterNotEqREROUTED        PickJobStatusEnumFilterNotEq = "REROUTED"
	PickJobStatusEnumFilterNotEqRESTOWED        PickJobStatusEnumFilterNotEq = "RESTOWED"
	PickJobStatusEnumFilterNotEqWAITINGFORINPUT PickJobStatusEnumFilterNotEq = "WAITING_FOR_INPUT"
)

Defines values for PickJobStatusEnumFilterNotEq.

func (PickJobStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the PickJobStatusEnumFilterNotEq enum.

type PickJobTransfersFilter

type PickJobTransfersFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringEqFilter `json:"id,omitempty"`
}

PickJobTransfersFilter PickJobTransfersFilter

type PickJobTransfersListFilter

type PickJobTransfersListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *PickJobTransfersFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

PickJobTransfersListFilter PickJobTransfersListFilter

type PickingMethodEnum

type PickingMethodEnum string

PickingMethodEnum Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead

Example: SINGLE_ORDER

const (
	PickingMethodEnumBATCH        PickingMethodEnum = "BATCH"
	PickingMethodEnumBATCHPICKING PickingMethodEnum = "BATCH_PICKING"
	PickingMethodEnumMULTIORDER   PickingMethodEnum = "MULTI_ORDER"
	PickingMethodEnumSINGLEORDER  PickingMethodEnum = "SINGLE_ORDER"
)

Defines values for PickingMethodEnum.

func (PickingMethodEnum) Valid

func (e PickingMethodEnum) Valid() bool

Valid indicates whether the value is a known member of the PickingMethodEnum enum.

type PickingTimes

type PickingTimes struct {
	Friday    *[]TimeRange `json:"friday,omitempty"`
	Monday    *[]TimeRange `json:"monday,omitempty"`
	Saturday  *[]TimeRange `json:"saturday,omitempty"`
	Sunday    *[]TimeRange `json:"sunday,omitempty"`
	Thursday  *[]TimeRange `json:"thursday,omitempty"`
	Tuesday   *[]TimeRange `json:"tuesday,omitempty"`
	Wednesday *[]TimeRange `json:"wednesday,omitempty"`
}

PickingTimes Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day

type PostDeliveryPromiseJSONRequestBody added in v0.3.0

type PostDeliveryPromiseJSONRequestBody = PromiseRequest

PostDeliveryPromiseJSONRequestBody defines body for PostDeliveryPromise for application/json ContentType.

type PostDeliveryPromiseResponse added in v0.3.0

type PostDeliveryPromiseResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *ResponseForDeliveryPromise
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParsePostDeliveryPromiseResponse added in v0.3.0

func ParsePostDeliveryPromiseResponse(rsp *http.Response) (*PostDeliveryPromiseResponse, error)

ParsePostDeliveryPromiseResponse parses an HTTP response from a PostDeliveryPromiseWithResponse call

func (PostDeliveryPromiseResponse) ContentType added in v0.3.0

func (r PostDeliveryPromiseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostDeliveryPromiseResponse) GetBody added in v0.8.0

func (r PostDeliveryPromiseResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostDeliveryPromiseResponse) GetJSON201 added in v0.8.0

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (PostDeliveryPromiseResponse) GetJSON400 added in v0.8.0

func (r PostDeliveryPromiseResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostDeliveryPromiseResponse) GetJSON401 added in v0.8.0

func (r PostDeliveryPromiseResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostDeliveryPromiseResponse) GetJSON403 added in v0.8.0

func (r PostDeliveryPromiseResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostDeliveryPromiseResponse) Status added in v0.3.0

Status returns HTTPResponse.Status

func (PostDeliveryPromiseResponse) StatusCode added in v0.3.0

func (r PostDeliveryPromiseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostRoutingStrategyJSONRequestBody added in v0.6.0

type PostRoutingStrategyJSONRequestBody = RoutingStrategyForCreation

PostRoutingStrategyJSONRequestBody defines body for PostRoutingStrategy for application/json ContentType.

type PostRoutingStrategyNodeConfigCategoryJSONRequestBody added in v0.6.0

type PostRoutingStrategyNodeConfigCategoryJSONRequestBody = RoutingStrategyNodeConfigCategoryForCreation

PostRoutingStrategyNodeConfigCategoryJSONRequestBody defines body for PostRoutingStrategyNodeConfigCategory for application/json ContentType.

type PostRoutingStrategyNodeConfigCategoryResponse added in v0.6.0

type PostRoutingStrategyNodeConfigCategoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *RoutingStrategyNodeConfigCategoryForResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParsePostRoutingStrategyNodeConfigCategoryResponse added in v0.6.0

func ParsePostRoutingStrategyNodeConfigCategoryResponse(rsp *http.Response) (*PostRoutingStrategyNodeConfigCategoryResponse, error)

ParsePostRoutingStrategyNodeConfigCategoryResponse parses an HTTP response from a PostRoutingStrategyNodeConfigCategoryWithResponse call

func (PostRoutingStrategyNodeConfigCategoryResponse) ContentType added in v0.6.0

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostRoutingStrategyNodeConfigCategoryResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (PostRoutingStrategyNodeConfigCategoryResponse) GetJSON201 added in v0.8.0

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (PostRoutingStrategyNodeConfigCategoryResponse) GetJSON400 added in v0.8.0

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostRoutingStrategyNodeConfigCategoryResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostRoutingStrategyNodeConfigCategoryResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostRoutingStrategyNodeConfigCategoryResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (PostRoutingStrategyNodeConfigCategoryResponse) StatusCode added in v0.6.0

StatusCode returns HTTPResponse.StatusCode

type PostRoutingStrategyResponse added in v0.6.0

type PostRoutingStrategyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *RoutingStrategy
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParsePostRoutingStrategyResponse added in v0.6.0

func ParsePostRoutingStrategyResponse(rsp *http.Response) (*PostRoutingStrategyResponse, error)

ParsePostRoutingStrategyResponse parses an HTTP response from a PostRoutingStrategyWithResponse call

func (PostRoutingStrategyResponse) ContentType added in v0.6.0

func (r PostRoutingStrategyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostRoutingStrategyResponse) GetBody added in v0.8.0

func (r PostRoutingStrategyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostRoutingStrategyResponse) GetJSON201 added in v0.8.0

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (PostRoutingStrategyResponse) GetJSON400 added in v0.8.0

func (r PostRoutingStrategyResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostRoutingStrategyResponse) GetJSON401 added in v0.8.0

func (r PostRoutingStrategyResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostRoutingStrategyResponse) GetJSON403 added in v0.8.0

func (r PostRoutingStrategyResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostRoutingStrategyResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (PostRoutingStrategyResponse) StatusCode added in v0.6.0

func (r PostRoutingStrategyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PreferredCarrier added in v0.2.0

type PreferredCarrier = string

PreferredCarrier Keys of the preferred carriers to handle out the order

type PreferredCarrierWithProduct added in v0.2.0

type PreferredCarrierWithProduct struct {
	// CarrierKey Example: DPD
	CarrierKey string `json:"carrierKey"`

	// CarrierProduct Example: WORLDWIDE
	CarrierProduct  *string            `json:"carrierProduct,omitempty"`
	CarrierServices *[]CarrierServices `json:"carrierServices,omitempty"`
}

PreferredCarrierWithProduct PreferredCarrierWithProduct

type PreselectedFacility added in v0.2.0

type PreselectedFacility struct {
	// FacilityRef Reference to the facility which is supposed to fulfill the order.
	FacilityRef *string `json:"facilityRef,omitempty"`

	// TenantFacilityId Reference to the facility which is supposed to fulfill the order.
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`
	// contains filtered or unexported fields
}

PreselectedFacility PreselectedFacility

func (PreselectedFacility) AsPreselectedFacility0 added in v0.2.0

func (t PreselectedFacility) AsPreselectedFacility0() (PreselectedFacility0, error)

AsPreselectedFacility0 returns the union data inside the PreselectedFacility as a PreselectedFacility0

func (PreselectedFacility) AsPreselectedFacility1 added in v0.2.0

func (t PreselectedFacility) AsPreselectedFacility1() (PreselectedFacility1, error)

AsPreselectedFacility1 returns the union data inside the PreselectedFacility as a PreselectedFacility1

func (*PreselectedFacility) FromPreselectedFacility0 added in v0.2.0

func (t *PreselectedFacility) FromPreselectedFacility0(v PreselectedFacility0) error

FromPreselectedFacility0 overwrites any union data inside the PreselectedFacility as the provided PreselectedFacility0

func (*PreselectedFacility) FromPreselectedFacility1 added in v0.2.0

func (t *PreselectedFacility) FromPreselectedFacility1(v PreselectedFacility1) error

FromPreselectedFacility1 overwrites any union data inside the PreselectedFacility as the provided PreselectedFacility1

func (PreselectedFacility) MarshalJSON added in v0.2.0

func (t PreselectedFacility) MarshalJSON() ([]byte, error)

func (*PreselectedFacility) MergePreselectedFacility0 added in v0.2.0

func (t *PreselectedFacility) MergePreselectedFacility0(v PreselectedFacility0) error

MergePreselectedFacility0 performs a merge with any union data inside the PreselectedFacility, using the provided PreselectedFacility0

func (*PreselectedFacility) MergePreselectedFacility1 added in v0.2.0

func (t *PreselectedFacility) MergePreselectedFacility1(v PreselectedFacility1) error

MergePreselectedFacility1 performs a merge with any union data inside the PreselectedFacility, using the provided PreselectedFacility1

func (*PreselectedFacility) UnmarshalJSON added in v0.2.0

func (t *PreselectedFacility) UnmarshalJSON(b []byte) error

type PreselectedFacility0 added in v0.2.0

type PreselectedFacility0 = interface{}

PreselectedFacility0 defines model for PreselectedFacility.0.

type PreselectedFacility1 added in v0.2.0

type PreselectedFacility1 = interface{}

PreselectedFacility1 defines model for PreselectedFacility.1.

type PriceRange

type PriceRange struct {
	// Currency The currency of the price as an ISO 4217 code.
	//
	// Example: EUR
	Currency string `json:"currency"`

	// DecimalPlaces Number of decimal places for the given currency
	//
	// Example: 2
	DecimalPlaces int32 `json:"decimalPlaces"`

	// From Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.
	//
	// Example: 1299
	From float32 `json:"from"`

	// To Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.
	//
	// Example: 25000
	To float32 `json:"to"`
}

PriceRange PriceRange

type PriorityRatingResult added in v0.7.0

type PriorityRatingResult struct {
	Id                     string  `json:"id"`
	MatchesPriorityMinimum bool    `json:"matchesPriorityMinimum"`
	Name                   *string `json:"name,omitempty"`
	RoutingStrategyNodeId  string  `json:"routingStrategyNodeId"`

	// Type RatingResultType
	Type RatingResultType `json:"type"`
}

PriorityRatingResult PriorityRatingResult

type ProcessDomainStatusesDomainStatusEnumFilter

type ProcessDomainStatusesDomainStatusEnumFilter struct {
	// Eq Search by order
	Eq *ProcessDomainStatusesDomainStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by order
	In *[]ProcessDomainStatusesDomainStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by order
	NotEq *ProcessDomainStatusesDomainStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessDomainStatusesDomainStatusEnumFilter ProcessDomainStatusesDomainStatusEnumFilter

type ProcessDomainStatusesDomainStatusEnumFilterEq

type ProcessDomainStatusesDomainStatusEnumFilterEq string

ProcessDomainStatusesDomainStatusEnumFilterEq Search by order

const (
	ProcessDomainStatusesDomainStatusEnumFilterEqCANCELED   ProcessDomainStatusesDomainStatusEnumFilterEq = "CANCELED"
	ProcessDomainStatusesDomainStatusEnumFilterEqCREATED    ProcessDomainStatusesDomainStatusEnumFilterEq = "CREATED"
	ProcessDomainStatusesDomainStatusEnumFilterEqFINISHED   ProcessDomainStatusesDomainStatusEnumFilterEq = "FINISHED"
	ProcessDomainStatusesDomainStatusEnumFilterEqINPROGRESS ProcessDomainStatusesDomainStatusEnumFilterEq = "IN_PROGRESS"
	ProcessDomainStatusesDomainStatusEnumFilterEqOBSOLETE   ProcessDomainStatusesDomainStatusEnumFilterEq = "OBSOLETE"
	ProcessDomainStatusesDomainStatusEnumFilterEqPENDING    ProcessDomainStatusesDomainStatusEnumFilterEq = "PENDING"
	ProcessDomainStatusesDomainStatusEnumFilterEqSTUCK      ProcessDomainStatusesDomainStatusEnumFilterEq = "STUCK"
)

Defines values for ProcessDomainStatusesDomainStatusEnumFilterEq.

func (ProcessDomainStatusesDomainStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessDomainStatusesDomainStatusEnumFilterEq enum.

type ProcessDomainStatusesDomainStatusEnumFilterIn

type ProcessDomainStatusesDomainStatusEnumFilterIn string

ProcessDomainStatusesDomainStatusEnumFilterIn defines model for ProcessDomainStatusesDomainStatusEnumFilter.In.

const (
	ProcessDomainStatusesDomainStatusEnumFilterInCANCELED   ProcessDomainStatusesDomainStatusEnumFilterIn = "CANCELED"
	ProcessDomainStatusesDomainStatusEnumFilterInCREATED    ProcessDomainStatusesDomainStatusEnumFilterIn = "CREATED"
	ProcessDomainStatusesDomainStatusEnumFilterInFINISHED   ProcessDomainStatusesDomainStatusEnumFilterIn = "FINISHED"
	ProcessDomainStatusesDomainStatusEnumFilterInINPROGRESS ProcessDomainStatusesDomainStatusEnumFilterIn = "IN_PROGRESS"
	ProcessDomainStatusesDomainStatusEnumFilterInOBSOLETE   ProcessDomainStatusesDomainStatusEnumFilterIn = "OBSOLETE"
	ProcessDomainStatusesDomainStatusEnumFilterInPENDING    ProcessDomainStatusesDomainStatusEnumFilterIn = "PENDING"
	ProcessDomainStatusesDomainStatusEnumFilterInSTUCK      ProcessDomainStatusesDomainStatusEnumFilterIn = "STUCK"
)

Defines values for ProcessDomainStatusesDomainStatusEnumFilterIn.

func (ProcessDomainStatusesDomainStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessDomainStatusesDomainStatusEnumFilterIn enum.

type ProcessDomainStatusesDomainStatusEnumFilterNotEq

type ProcessDomainStatusesDomainStatusEnumFilterNotEq string

ProcessDomainStatusesDomainStatusEnumFilterNotEq Search by order

const (
	ProcessDomainStatusesDomainStatusEnumFilterNotEqCANCELED   ProcessDomainStatusesDomainStatusEnumFilterNotEq = "CANCELED"
	ProcessDomainStatusesDomainStatusEnumFilterNotEqCREATED    ProcessDomainStatusesDomainStatusEnumFilterNotEq = "CREATED"
	ProcessDomainStatusesDomainStatusEnumFilterNotEqFINISHED   ProcessDomainStatusesDomainStatusEnumFilterNotEq = "FINISHED"
	ProcessDomainStatusesDomainStatusEnumFilterNotEqINPROGRESS ProcessDomainStatusesDomainStatusEnumFilterNotEq = "IN_PROGRESS"
	ProcessDomainStatusesDomainStatusEnumFilterNotEqOBSOLETE   ProcessDomainStatusesDomainStatusEnumFilterNotEq = "OBSOLETE"
	ProcessDomainStatusesDomainStatusEnumFilterNotEqPENDING    ProcessDomainStatusesDomainStatusEnumFilterNotEq = "PENDING"
	ProcessDomainStatusesDomainStatusEnumFilterNotEqSTUCK      ProcessDomainStatusesDomainStatusEnumFilterNotEq = "STUCK"
)

Defines values for ProcessDomainStatusesDomainStatusEnumFilterNotEq.

func (ProcessDomainStatusesDomainStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessDomainStatusesDomainStatusEnumFilterNotEq enum.

type ProcessDomainStatusesDomainStatusEnumListFilter

type ProcessDomainStatusesDomainStatusEnumListFilter struct {
	// Contains Search by order
	Contains *ProcessDomainStatusesDomainStatusEnumFilter `json:"contains,omitempty"`
}

ProcessDomainStatusesDomainStatusEnumListFilter ProcessDomainStatusesDomainStatusEnumListFilter

type ProcessDomainStatusesFilter

type ProcessDomainStatusesFilter struct {
	// Handover Search by handover
	Handover *ProcessDomainStatusesDomainStatusEnumListFilter `json:"handover,omitempty"`

	// Order Search by order
	Order *ProcessDomainStatusesDomainStatusEnumListFilter `json:"order,omitempty"`

	// Packing Search by packing
	Packing *ProcessDomainStatusesDomainStatusEnumListFilter `json:"packing,omitempty"`

	// Picking Search by picking
	Picking *ProcessDomainStatusesDomainStatusEnumListFilter `json:"picking,omitempty"`

	// Return Search by return
	Return *ProcessDomainStatusesDomainStatusEnumListFilter `json:"return,omitempty"`

	// Routing Search by routing
	Routing *ProcessDomainStatusesDomainStatusEnumListFilter `json:"routing,omitempty"`

	// Service Search by service
	Service *ProcessDomainStatusesDomainStatusEnumListFilter `json:"service,omitempty"`

	// Shipping Search by shipping
	Shipping *ProcessDomainStatusesDomainStatusEnumListFilter `json:"shipping,omitempty"`
}

ProcessDomainStatusesFilter ProcessDomainStatusesFilter

type ProcessReferencedBrandFilter

type ProcessReferencedBrandFilter struct {
	// Name Search by name
	Name *StringSearchFilter `json:"name,omitempty"`
}

ProcessReferencedBrandFilter ProcessReferencedBrandFilter

type ProcessReferencedCarrierFilter

type ProcessReferencedCarrierFilter struct {
	// CarrierTrackingNumber Search by carrierTrackingNumber
	CarrierTrackingNumber *StringSearchFilter `json:"carrierTrackingNumber,omitempty"`

	// Name Search by name
	Name *StringSearchFilter `json:"name,omitempty"`
}

ProcessReferencedCarrierFilter ProcessReferencedCarrierFilter

type ProcessReferencedConsumerAddressFilter

type ProcessReferencedConsumerAddressFilter struct {
	// Country Search by country
	//
	// Example: US
	Country *StringSearchFilter `json:"country,omitempty"`

	// DeliveryCountry Search by deliveryCountry
	DeliveryCountry *StringSearchFilter `json:"deliveryCountry,omitempty"`
}

ProcessReferencedConsumerAddressFilter ProcessReferencedConsumerAddressFilter

type ProcessReferencedFacilityAddressFilter

type ProcessReferencedFacilityAddressFilter struct {
	// Country Search by country
	//
	// Example: US
	Country *StringSearchFilter `json:"country,omitempty"`
}

ProcessReferencedFacilityAddressFilter ProcessReferencedFacilityAddressFilter

type ProcessReferencedFacilityFilter

type ProcessReferencedFacilityFilter struct {
	// Address Nested search by address
	Address *ProcessReferencedFacilityAddressFilter `json:"address,omitempty"`

	// Name Search by name
	Name *StringSearchFilter `json:"name,omitempty"`
}

ProcessReferencedFacilityFilter ProcessReferencedFacilityFilter

type ProcessReferencedFilter

type ProcessReferencedFilter struct {
	// Brand Nested search by brand
	Brand *ProcessReferencedBrandFilter `json:"brand,omitempty"`

	// Carrier Nested search by carrier
	Carrier *ProcessReferencedCarrierFilter `json:"carrier,omitempty"`

	// ConsumerAddress Nested search by consumerAddress
	ConsumerAddress *ProcessReferencedConsumerAddressFilter `json:"consumerAddress,omitempty"`

	// Facility Nested search by facility
	Facility *ProcessReferencedFacilityFilter `json:"facility,omitempty"`

	// HandoverJob Nested search by handoverJob
	HandoverJob *ProcessReferencedHandoverJobFilter `json:"handoverJob,omitempty"`

	// Order Nested search by order
	Order *ProcessReferencedOrderFilter `json:"order,omitempty"`

	// PackJob Nested search by packJob
	PackJob *ProcessReferencedPackJobFilter `json:"packJob,omitempty"`

	// Parcel Nested search by parcel
	Parcel *ProcessReferencedParcelFilter `json:"parcel,omitempty"`

	// ParcelTrackingStatus Search by parcelTrackingStatus
	ParcelTrackingStatus *ProcessReferencedParcelTrackingStatusEnumListFilter `json:"parcelTrackingStatus,omitempty"`

	// PickJob Nested search by pickJob
	PickJob *ProcessReferencedPickJobFilter `json:"pickJob,omitempty"`

	// ReturnJob Nested search by returnJob
	ReturnJob *ProcessReferencedReturnJobFilter `json:"returnJob,omitempty"`

	// RoutingPlan Nested search by routingPlan
	RoutingPlan *ProcessReferencedRoutingPlanFilter `json:"routingPlan,omitempty"`

	// ServiceJob Nested search by serviceJob
	ServiceJob *ProcessReferencedServiceJobFilter `json:"serviceJob,omitempty"`

	// ServiceLevel Search by serviceLevel
	ServiceLevel *ProcessReferencedServiceLevelEnumListFilter `json:"serviceLevel,omitempty"`

	// ServiceType Search by serviceType
	ServiceType *StringSearchFilter `json:"serviceType,omitempty"`

	// Shipment Nested search by shipment
	Shipment *ProcessReferencedShipmentFilter `json:"shipment,omitempty"`

	// Sticker Nested search by sticker
	Sticker *ProcessReferencedStickerFilter `json:"sticker,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`

	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringSearchFilter `json:"tenantArticleId,omitempty"`
}

ProcessReferencedFilter ProcessReferencedFilter

type ProcessReferencedHandoverJobFilter

type ProcessReferencedHandoverJobFilter struct {
	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// GlobalActor Nested search by globalActor
	GlobalActor *ProcessReferencedHandoverJobGlobalActorFilter `json:"globalActor,omitempty"`

	// PickupIdentifier Search by pickupIdentifier
	PickupIdentifier *StringSearchFilter `json:"pickupIdentifier,omitempty"`

	// Status Search by status
	Status *ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter `json:"status,omitempty"`
}

ProcessReferencedHandoverJobFilter ProcessReferencedHandoverJobFilter

type ProcessReferencedHandoverJobGlobalActorFilter added in v0.8.0

type ProcessReferencedHandoverJobGlobalActorFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringSearchFilter `json:"id,omitempty"`
}

ProcessReferencedHandoverJobGlobalActorFilter ProcessReferencedHandoverJobGlobalActorFilter

type ProcessReferencedHandoverJobHandoverjobStatusEnumFilter

type ProcessReferencedHandoverJobHandoverjobStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedHandoverJobHandoverjobStatusEnumFilter ProcessReferencedHandoverJobHandoverjobStatusEnumFilter

type ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq

type ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq string

ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq Search by status

const (
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEqCANCELED        ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq = "CANCELED"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEqHANDEDOVER      ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq = "HANDED_OVER"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEqOBSOLETE        ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq = "OBSOLETE"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEqOPEN            ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq = "OPEN"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEqWAITINGFORINPUT ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq.

func (ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedHandoverJobHandoverjobStatusEnumFilterEq enum.

type ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn

type ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn string

ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn defines model for ProcessReferencedHandoverJobHandoverjobStatusEnumFilter.In.

const (
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterInCANCELED        ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn = "CANCELED"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterInHANDEDOVER      ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn = "HANDED_OVER"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterInOBSOLETE        ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn = "OBSOLETE"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterInOPEN            ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn = "OPEN"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterInWAITINGFORINPUT ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn.

func (ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedHandoverJobHandoverjobStatusEnumFilterIn enum.

type ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq

type ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq string

ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq Search by status

const (
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEqCANCELED        ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq = "CANCELED"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEqHANDEDOVER      ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq = "HANDED_OVER"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEqOBSOLETE        ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq = "OBSOLETE"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEqOPEN            ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq = "OPEN"
	ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEqWAITINGFORINPUT ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq.

func (ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedHandoverJobHandoverjobStatusEnumFilterNotEq enum.

type ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter

type ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter struct {
	// Contains Search by status
	Contains *ProcessReferencedHandoverJobHandoverjobStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter

type ProcessReferencedOrderFilter

type ProcessReferencedOrderFilter struct {
	// ConsumerId Search by consumerId
	ConsumerId *StringSearchFilter `json:"consumerId,omitempty"`

	// DesiredDeliveryTime Search by desiredDeliveryTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	DesiredDeliveryTime *DateFilter `json:"desiredDeliveryTime,omitempty"`

	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// GlobalActor Nested search by globalActor
	GlobalActor *ProcessReferencedOrderGlobalActorFilter `json:"globalActor,omitempty"`

	// OrderDate Search by orderDate
	//
	// Example: 2026-06-17T12:00:00.000Z
	OrderDate *DateFilter `json:"orderDate,omitempty"`

	// OrderedAmount Search by orderedAmount
	OrderedAmount *NumberFilter `json:"orderedAmount,omitempty"`

	// ProvisioningTime Search by provisioningTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	ProvisioningTime *DateFilter `json:"provisioningTime,omitempty"`

	// Status Search by status
	Status *ProcessReferencedOrderOrderStatusEnumListFilter `json:"status,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringSearchFilter `json:"tenantOrderId,omitempty"`
}

ProcessReferencedOrderFilter ProcessReferencedOrderFilter

type ProcessReferencedOrderGlobalActorFilter added in v0.8.0

type ProcessReferencedOrderGlobalActorFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringSearchFilter `json:"id,omitempty"`
}

ProcessReferencedOrderGlobalActorFilter ProcessReferencedOrderGlobalActorFilter

type ProcessReferencedOrderOrderStatusEnumFilter

type ProcessReferencedOrderOrderStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessReferencedOrderOrderStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessReferencedOrderOrderStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessReferencedOrderOrderStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedOrderOrderStatusEnumFilter ProcessReferencedOrderOrderStatusEnumFilter

type ProcessReferencedOrderOrderStatusEnumFilterEq

type ProcessReferencedOrderOrderStatusEnumFilterEq string

ProcessReferencedOrderOrderStatusEnumFilterEq Search by status

const (
	ProcessReferencedOrderOrderStatusEnumFilterEqCANCELLED ProcessReferencedOrderOrderStatusEnumFilterEq = "CANCELLED"
	ProcessReferencedOrderOrderStatusEnumFilterEqLOCKED    ProcessReferencedOrderOrderStatusEnumFilterEq = "LOCKED"
	ProcessReferencedOrderOrderStatusEnumFilterEqOBSOLETE  ProcessReferencedOrderOrderStatusEnumFilterEq = "OBSOLETE"
	ProcessReferencedOrderOrderStatusEnumFilterEqOPEN      ProcessReferencedOrderOrderStatusEnumFilterEq = "OPEN"
	ProcessReferencedOrderOrderStatusEnumFilterEqPROMISED  ProcessReferencedOrderOrderStatusEnumFilterEq = "PROMISED"
)

Defines values for ProcessReferencedOrderOrderStatusEnumFilterEq.

func (ProcessReferencedOrderOrderStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedOrderOrderStatusEnumFilterEq enum.

type ProcessReferencedOrderOrderStatusEnumFilterIn

type ProcessReferencedOrderOrderStatusEnumFilterIn string

ProcessReferencedOrderOrderStatusEnumFilterIn defines model for ProcessReferencedOrderOrderStatusEnumFilter.In.

const (
	ProcessReferencedOrderOrderStatusEnumFilterInCANCELLED ProcessReferencedOrderOrderStatusEnumFilterIn = "CANCELLED"
	ProcessReferencedOrderOrderStatusEnumFilterInLOCKED    ProcessReferencedOrderOrderStatusEnumFilterIn = "LOCKED"
	ProcessReferencedOrderOrderStatusEnumFilterInOBSOLETE  ProcessReferencedOrderOrderStatusEnumFilterIn = "OBSOLETE"
	ProcessReferencedOrderOrderStatusEnumFilterInOPEN      ProcessReferencedOrderOrderStatusEnumFilterIn = "OPEN"
	ProcessReferencedOrderOrderStatusEnumFilterInPROMISED  ProcessReferencedOrderOrderStatusEnumFilterIn = "PROMISED"
)

Defines values for ProcessReferencedOrderOrderStatusEnumFilterIn.

func (ProcessReferencedOrderOrderStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedOrderOrderStatusEnumFilterIn enum.

type ProcessReferencedOrderOrderStatusEnumFilterNotEq

type ProcessReferencedOrderOrderStatusEnumFilterNotEq string

ProcessReferencedOrderOrderStatusEnumFilterNotEq Search by status

const (
	ProcessReferencedOrderOrderStatusEnumFilterNotEqCANCELLED ProcessReferencedOrderOrderStatusEnumFilterNotEq = "CANCELLED"
	ProcessReferencedOrderOrderStatusEnumFilterNotEqLOCKED    ProcessReferencedOrderOrderStatusEnumFilterNotEq = "LOCKED"
	ProcessReferencedOrderOrderStatusEnumFilterNotEqOBSOLETE  ProcessReferencedOrderOrderStatusEnumFilterNotEq = "OBSOLETE"
	ProcessReferencedOrderOrderStatusEnumFilterNotEqOPEN      ProcessReferencedOrderOrderStatusEnumFilterNotEq = "OPEN"
	ProcessReferencedOrderOrderStatusEnumFilterNotEqPROMISED  ProcessReferencedOrderOrderStatusEnumFilterNotEq = "PROMISED"
)

Defines values for ProcessReferencedOrderOrderStatusEnumFilterNotEq.

func (ProcessReferencedOrderOrderStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedOrderOrderStatusEnumFilterNotEq enum.

type ProcessReferencedOrderOrderStatusEnumListFilter

type ProcessReferencedOrderOrderStatusEnumListFilter struct {
	// Contains Search by status
	Contains *ProcessReferencedOrderOrderStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedOrderOrderStatusEnumListFilter ProcessReferencedOrderOrderStatusEnumListFilter

type ProcessReferencedPackJobFilter

type ProcessReferencedPackJobFilter struct {
	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// GlobalActor Nested search by globalActor
	GlobalActor *ProcessReferencedPackJobGlobalActorFilter `json:"globalActor,omitempty"`

	// Status Search by status
	Status *ProcessReferencedPackJobPackJobStatusEnumListFilter `json:"status,omitempty"`
}

ProcessReferencedPackJobFilter ProcessReferencedPackJobFilter

type ProcessReferencedPackJobGlobalActorFilter added in v0.8.0

type ProcessReferencedPackJobGlobalActorFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringSearchFilter `json:"id,omitempty"`
}

ProcessReferencedPackJobGlobalActorFilter ProcessReferencedPackJobGlobalActorFilter

type ProcessReferencedPackJobPackJobStatusEnumFilter

type ProcessReferencedPackJobPackJobStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessReferencedPackJobPackJobStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessReferencedPackJobPackJobStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessReferencedPackJobPackJobStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedPackJobPackJobStatusEnumFilter ProcessReferencedPackJobPackJobStatusEnumFilter

type ProcessReferencedPackJobPackJobStatusEnumFilterEq

type ProcessReferencedPackJobPackJobStatusEnumFilterEq string

ProcessReferencedPackJobPackJobStatusEnumFilterEq Search by status

const (
	ProcessReferencedPackJobPackJobStatusEnumFilterEqCANCELED   ProcessReferencedPackJobPackJobStatusEnumFilterEq = "CANCELED"
	ProcessReferencedPackJobPackJobStatusEnumFilterEqCLOSED     ProcessReferencedPackJobPackJobStatusEnumFilterEq = "CLOSED"
	ProcessReferencedPackJobPackJobStatusEnumFilterEqINPROGRESS ProcessReferencedPackJobPackJobStatusEnumFilterEq = "IN_PROGRESS"
	ProcessReferencedPackJobPackJobStatusEnumFilterEqOBSOLETE   ProcessReferencedPackJobPackJobStatusEnumFilterEq = "OBSOLETE"
	ProcessReferencedPackJobPackJobStatusEnumFilterEqOPEN       ProcessReferencedPackJobPackJobStatusEnumFilterEq = "OPEN"
	ProcessReferencedPackJobPackJobStatusEnumFilterEqPAUSED     ProcessReferencedPackJobPackJobStatusEnumFilterEq = "PAUSED"
)

Defines values for ProcessReferencedPackJobPackJobStatusEnumFilterEq.

func (ProcessReferencedPackJobPackJobStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedPackJobPackJobStatusEnumFilterEq enum.

type ProcessReferencedPackJobPackJobStatusEnumFilterIn

type ProcessReferencedPackJobPackJobStatusEnumFilterIn string

ProcessReferencedPackJobPackJobStatusEnumFilterIn defines model for ProcessReferencedPackJobPackJobStatusEnumFilter.In.

const (
	ProcessReferencedPackJobPackJobStatusEnumFilterInCANCELED   ProcessReferencedPackJobPackJobStatusEnumFilterIn = "CANCELED"
	ProcessReferencedPackJobPackJobStatusEnumFilterInCLOSED     ProcessReferencedPackJobPackJobStatusEnumFilterIn = "CLOSED"
	ProcessReferencedPackJobPackJobStatusEnumFilterInINPROGRESS ProcessReferencedPackJobPackJobStatusEnumFilterIn = "IN_PROGRESS"
	ProcessReferencedPackJobPackJobStatusEnumFilterInOBSOLETE   ProcessReferencedPackJobPackJobStatusEnumFilterIn = "OBSOLETE"
	ProcessReferencedPackJobPackJobStatusEnumFilterInOPEN       ProcessReferencedPackJobPackJobStatusEnumFilterIn = "OPEN"
	ProcessReferencedPackJobPackJobStatusEnumFilterInPAUSED     ProcessReferencedPackJobPackJobStatusEnumFilterIn = "PAUSED"
)

Defines values for ProcessReferencedPackJobPackJobStatusEnumFilterIn.

func (ProcessReferencedPackJobPackJobStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedPackJobPackJobStatusEnumFilterIn enum.

type ProcessReferencedPackJobPackJobStatusEnumFilterNotEq

type ProcessReferencedPackJobPackJobStatusEnumFilterNotEq string

ProcessReferencedPackJobPackJobStatusEnumFilterNotEq Search by status

const (
	ProcessReferencedPackJobPackJobStatusEnumFilterNotEqCANCELED   ProcessReferencedPackJobPackJobStatusEnumFilterNotEq = "CANCELED"
	ProcessReferencedPackJobPackJobStatusEnumFilterNotEqCLOSED     ProcessReferencedPackJobPackJobStatusEnumFilterNotEq = "CLOSED"
	ProcessReferencedPackJobPackJobStatusEnumFilterNotEqINPROGRESS ProcessReferencedPackJobPackJobStatusEnumFilterNotEq = "IN_PROGRESS"
	ProcessReferencedPackJobPackJobStatusEnumFilterNotEqOBSOLETE   ProcessReferencedPackJobPackJobStatusEnumFilterNotEq = "OBSOLETE"
	ProcessReferencedPackJobPackJobStatusEnumFilterNotEqOPEN       ProcessReferencedPackJobPackJobStatusEnumFilterNotEq = "OPEN"
	ProcessReferencedPackJobPackJobStatusEnumFilterNotEqPAUSED     ProcessReferencedPackJobPackJobStatusEnumFilterNotEq = "PAUSED"
)

Defines values for ProcessReferencedPackJobPackJobStatusEnumFilterNotEq.

func (ProcessReferencedPackJobPackJobStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedPackJobPackJobStatusEnumFilterNotEq enum.

type ProcessReferencedPackJobPackJobStatusEnumListFilter

type ProcessReferencedPackJobPackJobStatusEnumListFilter struct {
	// Contains Search by status
	Contains *ProcessReferencedPackJobPackJobStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedPackJobPackJobStatusEnumListFilter ProcessReferencedPackJobPackJobStatusEnumListFilter

type ProcessReferencedParcelFilter

type ProcessReferencedParcelFilter struct {
	// Status Search by status
	Status *ProcessReferencedParcelParcelStatusEnumListFilter `json:"status,omitempty"`
}

ProcessReferencedParcelFilter ProcessReferencedParcelFilter

type ProcessReferencedParcelParcelStatusEnumFilter

type ProcessReferencedParcelParcelStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessReferencedParcelParcelStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessReferencedParcelParcelStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessReferencedParcelParcelStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedParcelParcelStatusEnumFilter ProcessReferencedParcelParcelStatusEnumFilter

type ProcessReferencedParcelParcelStatusEnumFilterEq

type ProcessReferencedParcelParcelStatusEnumFilterEq string

ProcessReferencedParcelParcelStatusEnumFilterEq Search by status

const (
	ProcessReferencedParcelParcelStatusEnumFilterEqCANCELED        ProcessReferencedParcelParcelStatusEnumFilterEq = "CANCELED"
	ProcessReferencedParcelParcelStatusEnumFilterEqDONE            ProcessReferencedParcelParcelStatusEnumFilterEq = "DONE"
	ProcessReferencedParcelParcelStatusEnumFilterEqFAILED          ProcessReferencedParcelParcelStatusEnumFilterEq = "FAILED"
	ProcessReferencedParcelParcelStatusEnumFilterEqOBSOLETE        ProcessReferencedParcelParcelStatusEnumFilterEq = "OBSOLETE"
	ProcessReferencedParcelParcelStatusEnumFilterEqOPEN            ProcessReferencedParcelParcelStatusEnumFilterEq = "OPEN"
	ProcessReferencedParcelParcelStatusEnumFilterEqPROCESSING      ProcessReferencedParcelParcelStatusEnumFilterEq = "PROCESSING"
	ProcessReferencedParcelParcelStatusEnumFilterEqWAITINGFORINPUT ProcessReferencedParcelParcelStatusEnumFilterEq = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedParcelParcelStatusEnumFilterEq.

func (ProcessReferencedParcelParcelStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedParcelParcelStatusEnumFilterEq enum.

type ProcessReferencedParcelParcelStatusEnumFilterIn

type ProcessReferencedParcelParcelStatusEnumFilterIn string

ProcessReferencedParcelParcelStatusEnumFilterIn defines model for ProcessReferencedParcelParcelStatusEnumFilter.In.

const (
	ProcessReferencedParcelParcelStatusEnumFilterInCANCELED        ProcessReferencedParcelParcelStatusEnumFilterIn = "CANCELED"
	ProcessReferencedParcelParcelStatusEnumFilterInDONE            ProcessReferencedParcelParcelStatusEnumFilterIn = "DONE"
	ProcessReferencedParcelParcelStatusEnumFilterInFAILED          ProcessReferencedParcelParcelStatusEnumFilterIn = "FAILED"
	ProcessReferencedParcelParcelStatusEnumFilterInOBSOLETE        ProcessReferencedParcelParcelStatusEnumFilterIn = "OBSOLETE"
	ProcessReferencedParcelParcelStatusEnumFilterInOPEN            ProcessReferencedParcelParcelStatusEnumFilterIn = "OPEN"
	ProcessReferencedParcelParcelStatusEnumFilterInPROCESSING      ProcessReferencedParcelParcelStatusEnumFilterIn = "PROCESSING"
	ProcessReferencedParcelParcelStatusEnumFilterInWAITINGFORINPUT ProcessReferencedParcelParcelStatusEnumFilterIn = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedParcelParcelStatusEnumFilterIn.

func (ProcessReferencedParcelParcelStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedParcelParcelStatusEnumFilterIn enum.

type ProcessReferencedParcelParcelStatusEnumFilterNotEq

type ProcessReferencedParcelParcelStatusEnumFilterNotEq string

ProcessReferencedParcelParcelStatusEnumFilterNotEq Search by status

const (
	ProcessReferencedParcelParcelStatusEnumFilterNotEqCANCELED        ProcessReferencedParcelParcelStatusEnumFilterNotEq = "CANCELED"
	ProcessReferencedParcelParcelStatusEnumFilterNotEqDONE            ProcessReferencedParcelParcelStatusEnumFilterNotEq = "DONE"
	ProcessReferencedParcelParcelStatusEnumFilterNotEqFAILED          ProcessReferencedParcelParcelStatusEnumFilterNotEq = "FAILED"
	ProcessReferencedParcelParcelStatusEnumFilterNotEqOBSOLETE        ProcessReferencedParcelParcelStatusEnumFilterNotEq = "OBSOLETE"
	ProcessReferencedParcelParcelStatusEnumFilterNotEqOPEN            ProcessReferencedParcelParcelStatusEnumFilterNotEq = "OPEN"
	ProcessReferencedParcelParcelStatusEnumFilterNotEqPROCESSING      ProcessReferencedParcelParcelStatusEnumFilterNotEq = "PROCESSING"
	ProcessReferencedParcelParcelStatusEnumFilterNotEqWAITINGFORINPUT ProcessReferencedParcelParcelStatusEnumFilterNotEq = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedParcelParcelStatusEnumFilterNotEq.

func (ProcessReferencedParcelParcelStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedParcelParcelStatusEnumFilterNotEq enum.

type ProcessReferencedParcelParcelStatusEnumListFilter

type ProcessReferencedParcelParcelStatusEnumListFilter struct {
	// Contains Search by status
	Contains *ProcessReferencedParcelParcelStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedParcelParcelStatusEnumListFilter ProcessReferencedParcelParcelStatusEnumListFilter

type ProcessReferencedParcelTrackingStatusEnumFilter

type ProcessReferencedParcelTrackingStatusEnumFilter struct {
	// Eq Search by parcelTrackingStatus
	Eq *ProcessReferencedParcelTrackingStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by parcelTrackingStatus
	In *[]ProcessReferencedParcelTrackingStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by parcelTrackingStatus
	NotEq *ProcessReferencedParcelTrackingStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedParcelTrackingStatusEnumFilter ProcessReferencedParcelTrackingStatusEnumFilter

type ProcessReferencedParcelTrackingStatusEnumFilterEq

type ProcessReferencedParcelTrackingStatusEnumFilterEq string

ProcessReferencedParcelTrackingStatusEnumFilterEq Search by parcelTrackingStatus

const (
	ProcessReferencedParcelTrackingStatusEnumFilterEqAWAITSPICKUPBYRECEIVER ProcessReferencedParcelTrackingStatusEnumFilterEq = "AWAITS_PICKUP_BY_RECEIVER"
	ProcessReferencedParcelTrackingStatusEnumFilterEqCANCELED               ProcessReferencedParcelTrackingStatusEnumFilterEq = "CANCELED"
	ProcessReferencedParcelTrackingStatusEnumFilterEqDELAYED                ProcessReferencedParcelTrackingStatusEnumFilterEq = "DELAYED"
	ProcessReferencedParcelTrackingStatusEnumFilterEqDELIVERED              ProcessReferencedParcelTrackingStatusEnumFilterEq = "DELIVERED"
	ProcessReferencedParcelTrackingStatusEnumFilterEqDESTROYED              ProcessReferencedParcelTrackingStatusEnumFilterEq = "DESTROYED"
	ProcessReferencedParcelTrackingStatusEnumFilterEqEXCEPTION              ProcessReferencedParcelTrackingStatusEnumFilterEq = "EXCEPTION"
	ProcessReferencedParcelTrackingStatusEnumFilterEqNOTDELIVERED           ProcessReferencedParcelTrackingStatusEnumFilterEq = "NOT_DELIVERED"
	ProcessReferencedParcelTrackingStatusEnumFilterEqNOTIFICATION           ProcessReferencedParcelTrackingStatusEnumFilterEq = "NOTIFICATION"
	ProcessReferencedParcelTrackingStatusEnumFilterEqOUTFORDELIVERY         ProcessReferencedParcelTrackingStatusEnumFilterEq = "OUT_FOR_DELIVERY"
	ProcessReferencedParcelTrackingStatusEnumFilterEqPICKEDUP               ProcessReferencedParcelTrackingStatusEnumFilterEq = "PICKED_UP"
	ProcessReferencedParcelTrackingStatusEnumFilterEqREGISTERED             ProcessReferencedParcelTrackingStatusEnumFilterEq = "REGISTERED"
	ProcessReferencedParcelTrackingStatusEnumFilterEqTRANSIT                ProcessReferencedParcelTrackingStatusEnumFilterEq = "TRANSIT"
	ProcessReferencedParcelTrackingStatusEnumFilterEqUNKNOWN                ProcessReferencedParcelTrackingStatusEnumFilterEq = "UNKNOWN"
)

Defines values for ProcessReferencedParcelTrackingStatusEnumFilterEq.

func (ProcessReferencedParcelTrackingStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedParcelTrackingStatusEnumFilterEq enum.

type ProcessReferencedParcelTrackingStatusEnumFilterIn

type ProcessReferencedParcelTrackingStatusEnumFilterIn string

ProcessReferencedParcelTrackingStatusEnumFilterIn defines model for ProcessReferencedParcelTrackingStatusEnumFilter.In.

const (
	ProcessReferencedParcelTrackingStatusEnumFilterInAWAITSPICKUPBYRECEIVER ProcessReferencedParcelTrackingStatusEnumFilterIn = "AWAITS_PICKUP_BY_RECEIVER"
	ProcessReferencedParcelTrackingStatusEnumFilterInCANCELED               ProcessReferencedParcelTrackingStatusEnumFilterIn = "CANCELED"
	ProcessReferencedParcelTrackingStatusEnumFilterInDELAYED                ProcessReferencedParcelTrackingStatusEnumFilterIn = "DELAYED"
	ProcessReferencedParcelTrackingStatusEnumFilterInDELIVERED              ProcessReferencedParcelTrackingStatusEnumFilterIn = "DELIVERED"
	ProcessReferencedParcelTrackingStatusEnumFilterInDESTROYED              ProcessReferencedParcelTrackingStatusEnumFilterIn = "DESTROYED"
	ProcessReferencedParcelTrackingStatusEnumFilterInEXCEPTION              ProcessReferencedParcelTrackingStatusEnumFilterIn = "EXCEPTION"
	ProcessReferencedParcelTrackingStatusEnumFilterInNOTDELIVERED           ProcessReferencedParcelTrackingStatusEnumFilterIn = "NOT_DELIVERED"
	ProcessReferencedParcelTrackingStatusEnumFilterInNOTIFICATION           ProcessReferencedParcelTrackingStatusEnumFilterIn = "NOTIFICATION"
	ProcessReferencedParcelTrackingStatusEnumFilterInOUTFORDELIVERY         ProcessReferencedParcelTrackingStatusEnumFilterIn = "OUT_FOR_DELIVERY"
	ProcessReferencedParcelTrackingStatusEnumFilterInPICKEDUP               ProcessReferencedParcelTrackingStatusEnumFilterIn = "PICKED_UP"
	ProcessReferencedParcelTrackingStatusEnumFilterInREGISTERED             ProcessReferencedParcelTrackingStatusEnumFilterIn = "REGISTERED"
	ProcessReferencedParcelTrackingStatusEnumFilterInTRANSIT                ProcessReferencedParcelTrackingStatusEnumFilterIn = "TRANSIT"
	ProcessReferencedParcelTrackingStatusEnumFilterInUNKNOWN                ProcessReferencedParcelTrackingStatusEnumFilterIn = "UNKNOWN"
)

Defines values for ProcessReferencedParcelTrackingStatusEnumFilterIn.

func (ProcessReferencedParcelTrackingStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedParcelTrackingStatusEnumFilterIn enum.

type ProcessReferencedParcelTrackingStatusEnumFilterNotEq

type ProcessReferencedParcelTrackingStatusEnumFilterNotEq string

ProcessReferencedParcelTrackingStatusEnumFilterNotEq Search by parcelTrackingStatus

const (
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqAWAITSPICKUPBYRECEIVER ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "AWAITS_PICKUP_BY_RECEIVER"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqCANCELED               ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "CANCELED"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqDELAYED                ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "DELAYED"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqDELIVERED              ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "DELIVERED"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqDESTROYED              ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "DESTROYED"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqEXCEPTION              ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "EXCEPTION"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqNOTDELIVERED           ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "NOT_DELIVERED"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqNOTIFICATION           ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "NOTIFICATION"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqOUTFORDELIVERY         ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "OUT_FOR_DELIVERY"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqPICKEDUP               ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "PICKED_UP"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqREGISTERED             ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "REGISTERED"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqTRANSIT                ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "TRANSIT"
	ProcessReferencedParcelTrackingStatusEnumFilterNotEqUNKNOWN                ProcessReferencedParcelTrackingStatusEnumFilterNotEq = "UNKNOWN"
)

Defines values for ProcessReferencedParcelTrackingStatusEnumFilterNotEq.

func (ProcessReferencedParcelTrackingStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedParcelTrackingStatusEnumFilterNotEq enum.

type ProcessReferencedParcelTrackingStatusEnumListFilter

type ProcessReferencedParcelTrackingStatusEnumListFilter struct {
	// Contains Search by parcelTrackingStatus
	Contains *ProcessReferencedParcelTrackingStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedParcelTrackingStatusEnumListFilter ProcessReferencedParcelTrackingStatusEnumListFilter

type ProcessReferencedPickJobFilter

type ProcessReferencedPickJobFilter struct {
	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// GlobalActor Nested search by globalActor
	GlobalActor *ProcessReferencedPickJobGlobalActorFilter `json:"globalActor,omitempty"`

	// ShortId Search by shortId
	ShortId *StringSearchFilter `json:"shortId,omitempty"`

	// Status Search by status
	Status *ProcessReferencedPickJobPickJobStatusEnumListFilter `json:"status,omitempty"`
}

ProcessReferencedPickJobFilter ProcessReferencedPickJobFilter

type ProcessReferencedPickJobGlobalActorFilter added in v0.8.0

type ProcessReferencedPickJobGlobalActorFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringSearchFilter `json:"id,omitempty"`
}

ProcessReferencedPickJobGlobalActorFilter ProcessReferencedPickJobGlobalActorFilter

type ProcessReferencedPickJobPickJobStatusEnumFilter

type ProcessReferencedPickJobPickJobStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessReferencedPickJobPickJobStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessReferencedPickJobPickJobStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessReferencedPickJobPickJobStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedPickJobPickJobStatusEnumFilter ProcessReferencedPickJobPickJobStatusEnumFilter

type ProcessReferencedPickJobPickJobStatusEnumFilterEq

type ProcessReferencedPickJobPickJobStatusEnumFilterEq string

ProcessReferencedPickJobPickJobStatusEnumFilterEq Search by status

const (
	ProcessReferencedPickJobPickJobStatusEnumFilterEqABORTED         ProcessReferencedPickJobPickJobStatusEnumFilterEq = "ABORTED"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqCANCELED        ProcessReferencedPickJobPickJobStatusEnumFilterEq = "CANCELED"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqCLOSED          ProcessReferencedPickJobPickJobStatusEnumFilterEq = "CLOSED"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqEXPIRED         ProcessReferencedPickJobPickJobStatusEnumFilterEq = "EXPIRED"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqINPROGRESS      ProcessReferencedPickJobPickJobStatusEnumFilterEq = "IN_PROGRESS"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqOBSOLETE        ProcessReferencedPickJobPickJobStatusEnumFilterEq = "OBSOLETE"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqOPEN            ProcessReferencedPickJobPickJobStatusEnumFilterEq = "OPEN"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqPAUSED          ProcessReferencedPickJobPickJobStatusEnumFilterEq = "PAUSED"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqPICKED          ProcessReferencedPickJobPickJobStatusEnumFilterEq = "PICKED"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqREJECTED        ProcessReferencedPickJobPickJobStatusEnumFilterEq = "REJECTED"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqREROUTED        ProcessReferencedPickJobPickJobStatusEnumFilterEq = "REROUTED"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqRESTOWED        ProcessReferencedPickJobPickJobStatusEnumFilterEq = "RESTOWED"
	ProcessReferencedPickJobPickJobStatusEnumFilterEqWAITINGFORINPUT ProcessReferencedPickJobPickJobStatusEnumFilterEq = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedPickJobPickJobStatusEnumFilterEq.

func (ProcessReferencedPickJobPickJobStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedPickJobPickJobStatusEnumFilterEq enum.

type ProcessReferencedPickJobPickJobStatusEnumFilterIn

type ProcessReferencedPickJobPickJobStatusEnumFilterIn string

ProcessReferencedPickJobPickJobStatusEnumFilterIn defines model for ProcessReferencedPickJobPickJobStatusEnumFilter.In.

const (
	ProcessReferencedPickJobPickJobStatusEnumFilterInABORTED         ProcessReferencedPickJobPickJobStatusEnumFilterIn = "ABORTED"
	ProcessReferencedPickJobPickJobStatusEnumFilterInCANCELED        ProcessReferencedPickJobPickJobStatusEnumFilterIn = "CANCELED"
	ProcessReferencedPickJobPickJobStatusEnumFilterInCLOSED          ProcessReferencedPickJobPickJobStatusEnumFilterIn = "CLOSED"
	ProcessReferencedPickJobPickJobStatusEnumFilterInEXPIRED         ProcessReferencedPickJobPickJobStatusEnumFilterIn = "EXPIRED"
	ProcessReferencedPickJobPickJobStatusEnumFilterInINPROGRESS      ProcessReferencedPickJobPickJobStatusEnumFilterIn = "IN_PROGRESS"
	ProcessReferencedPickJobPickJobStatusEnumFilterInOBSOLETE        ProcessReferencedPickJobPickJobStatusEnumFilterIn = "OBSOLETE"
	ProcessReferencedPickJobPickJobStatusEnumFilterInOPEN            ProcessReferencedPickJobPickJobStatusEnumFilterIn = "OPEN"
	ProcessReferencedPickJobPickJobStatusEnumFilterInPAUSED          ProcessReferencedPickJobPickJobStatusEnumFilterIn = "PAUSED"
	ProcessReferencedPickJobPickJobStatusEnumFilterInPICKED          ProcessReferencedPickJobPickJobStatusEnumFilterIn = "PICKED"
	ProcessReferencedPickJobPickJobStatusEnumFilterInREJECTED        ProcessReferencedPickJobPickJobStatusEnumFilterIn = "REJECTED"
	ProcessReferencedPickJobPickJobStatusEnumFilterInREROUTED        ProcessReferencedPickJobPickJobStatusEnumFilterIn = "REROUTED"
	ProcessReferencedPickJobPickJobStatusEnumFilterInRESTOWED        ProcessReferencedPickJobPickJobStatusEnumFilterIn = "RESTOWED"
	ProcessReferencedPickJobPickJobStatusEnumFilterInWAITINGFORINPUT ProcessReferencedPickJobPickJobStatusEnumFilterIn = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedPickJobPickJobStatusEnumFilterIn.

func (ProcessReferencedPickJobPickJobStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedPickJobPickJobStatusEnumFilterIn enum.

type ProcessReferencedPickJobPickJobStatusEnumFilterNotEq

type ProcessReferencedPickJobPickJobStatusEnumFilterNotEq string

ProcessReferencedPickJobPickJobStatusEnumFilterNotEq Search by status

const (
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqABORTED         ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "ABORTED"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqCANCELED        ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "CANCELED"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqCLOSED          ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "CLOSED"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqEXPIRED         ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "EXPIRED"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqINPROGRESS      ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "IN_PROGRESS"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqOBSOLETE        ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "OBSOLETE"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqOPEN            ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "OPEN"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqPAUSED          ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "PAUSED"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqPICKED          ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "PICKED"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqREJECTED        ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "REJECTED"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqREROUTED        ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "REROUTED"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqRESTOWED        ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "RESTOWED"
	ProcessReferencedPickJobPickJobStatusEnumFilterNotEqWAITINGFORINPUT ProcessReferencedPickJobPickJobStatusEnumFilterNotEq = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedPickJobPickJobStatusEnumFilterNotEq.

func (ProcessReferencedPickJobPickJobStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedPickJobPickJobStatusEnumFilterNotEq enum.

type ProcessReferencedPickJobPickJobStatusEnumListFilter

type ProcessReferencedPickJobPickJobStatusEnumListFilter struct {
	// Contains Search by status
	Contains *ProcessReferencedPickJobPickJobStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedPickJobPickJobStatusEnumListFilter ProcessReferencedPickJobPickJobStatusEnumListFilter

type ProcessReferencedReturnJobFilter

type ProcessReferencedReturnJobFilter struct {
	// GlobalActor Nested search by globalActor
	GlobalActor *ProcessReferencedReturnJobGlobalActorFilter `json:"globalActor,omitempty"`

	// ReturnFacilityRefs Search by returnFacilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	ReturnFacilityRefs *StringListFilter `json:"returnFacilityRefs,omitempty"`

	// Status Search by status
	Status *ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter `json:"status,omitempty"`
}

ProcessReferencedReturnJobFilter ProcessReferencedReturnJobFilter

type ProcessReferencedReturnJobGlobalActorFilter added in v0.8.0

type ProcessReferencedReturnJobGlobalActorFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringSearchFilter `json:"id,omitempty"`
}

ProcessReferencedReturnJobGlobalActorFilter ProcessReferencedReturnJobGlobalActorFilter

type ProcessReferencedReturnJobItemReturnJobStatusEnumFilter

type ProcessReferencedReturnJobItemReturnJobStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedReturnJobItemReturnJobStatusEnumFilter ProcessReferencedReturnJobItemReturnJobStatusEnumFilter

type ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq

type ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq string

ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq Search by status

const (
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEqCANCELED   ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq = "CANCELED"
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEqFINISHED   ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq = "FINISHED"
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEqINPROGRESS ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq = "IN_PROGRESS"
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEqOPEN       ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq = "OPEN"
)

Defines values for ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq.

func (ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedReturnJobItemReturnJobStatusEnumFilterEq enum.

type ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn

type ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn string

ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn defines model for ProcessReferencedReturnJobItemReturnJobStatusEnumFilter.In.

const (
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterInCANCELED   ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn = "CANCELED"
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterInFINISHED   ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn = "FINISHED"
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterInINPROGRESS ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn = "IN_PROGRESS"
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterInOPEN       ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn = "OPEN"
)

Defines values for ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn.

func (ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedReturnJobItemReturnJobStatusEnumFilterIn enum.

type ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq

type ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq string

ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq Search by status

const (
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEqCANCELED   ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq = "CANCELED"
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEqFINISHED   ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq = "FINISHED"
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEqINPROGRESS ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq = "IN_PROGRESS"
	ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEqOPEN       ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq = "OPEN"
)

Defines values for ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq.

func (ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedReturnJobItemReturnJobStatusEnumFilterNotEq enum.

type ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter

type ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter struct {
	// Contains Search by status
	Contains *ProcessReferencedReturnJobItemReturnJobStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter

type ProcessReferencedRoutingPlanFilter added in v0.8.0

type ProcessReferencedRoutingPlanFilter struct {
	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// GlobalActor Nested search by globalActor
	GlobalActor *ProcessReferencedRoutingPlanGlobalActorFilter `json:"globalActor,omitempty"`

	// Status Search by status
	Status *ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter `json:"status,omitempty"`
}

ProcessReferencedRoutingPlanFilter ProcessReferencedRoutingPlanFilter

type ProcessReferencedRoutingPlanGlobalActorFilter added in v0.8.0

type ProcessReferencedRoutingPlanGlobalActorFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringSearchFilter `json:"id,omitempty"`
}

ProcessReferencedRoutingPlanGlobalActorFilter ProcessReferencedRoutingPlanGlobalActorFilter

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter added in v0.8.0

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq added in v0.8.0

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq string

ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq Search by status

const (
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqCANCELED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "CANCELED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqFAILED           ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "FAILED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqFAILEDREROUTE    ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "FAILED_REROUTE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqFALLBACKROUTING  ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "FALLBACK_ROUTING"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqINITIAL          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "INITIAL"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqINPREPARATION    ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "IN_PREPARATION"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqLOCKED           ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "LOCKED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqMANUALPLANNED    ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "MANUAL_PLANNED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqNOTROUTABLE      ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "NOT_ROUTABLE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqOBSOLETE         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "OBSOLETE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqPLANNED          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "PLANNED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqPRIORITIZED      ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "PRIORITIZED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqPROMISED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "PROMISED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqPROPOSED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "PROPOSED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqREDUNDANTREROUTE ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "REDUNDANT_REROUTE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqREROUTED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "REROUTED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqRETRYABLE        ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "RETRYABLE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqROUTED           ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "ROUTED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqROUTING          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "ROUTING"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEqWAITING          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq = "WAITING"
)

Defines values for ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq.

func (ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq) Valid added in v0.8.0

Valid indicates whether the value is a known member of the ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterEq enum.

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn added in v0.8.0

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn string

ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn defines model for ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter.In.

const (
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInCANCELED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "CANCELED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInFAILED           ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "FAILED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInFAILEDREROUTE    ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "FAILED_REROUTE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInFALLBACKROUTING  ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "FALLBACK_ROUTING"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInINITIAL          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "INITIAL"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInINPREPARATION    ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "IN_PREPARATION"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInLOCKED           ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "LOCKED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInMANUALPLANNED    ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "MANUAL_PLANNED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInNOTROUTABLE      ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "NOT_ROUTABLE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInOBSOLETE         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "OBSOLETE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInPLANNED          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "PLANNED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInPRIORITIZED      ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "PRIORITIZED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInPROMISED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "PROMISED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInPROPOSED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "PROPOSED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInREDUNDANTREROUTE ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "REDUNDANT_REROUTE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInREROUTED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "REROUTED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInRETRYABLE        ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "RETRYABLE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInROUTED           ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "ROUTED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInROUTING          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "ROUTING"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterInWAITING          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn = "WAITING"
)

Defines values for ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn.

func (ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn) Valid added in v0.8.0

Valid indicates whether the value is a known member of the ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterIn enum.

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq added in v0.8.0

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq string

ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq Search by status

const (
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqCANCELED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "CANCELED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqFAILED           ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "FAILED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqFAILEDREROUTE    ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "FAILED_REROUTE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqFALLBACKROUTING  ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "FALLBACK_ROUTING"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqINITIAL          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "INITIAL"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqINPREPARATION    ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "IN_PREPARATION"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqLOCKED           ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "LOCKED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqMANUALPLANNED    ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "MANUAL_PLANNED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqNOTROUTABLE      ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "NOT_ROUTABLE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqOBSOLETE         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "OBSOLETE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqPLANNED          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "PLANNED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqPRIORITIZED      ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "PRIORITIZED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqPROMISED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "PROMISED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqPROPOSED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "PROPOSED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqREDUNDANTREROUTE ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "REDUNDANT_REROUTE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqREROUTED         ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "REROUTED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqRETRYABLE        ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "RETRYABLE"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqROUTED           ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "ROUTED"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqROUTING          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "ROUTING"
	ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEqWAITING          ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq = "WAITING"
)

Defines values for ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq.

func (ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq) Valid added in v0.8.0

Valid indicates whether the value is a known member of the ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilterNotEq enum.

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter added in v0.8.0

type ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter struct {
	// Contains Search by status
	Contains *ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter

type ProcessReferencedServiceJobFilter

type ProcessReferencedServiceJobFilter struct {
	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// GlobalActor Nested search by globalActor
	GlobalActor *ProcessReferencedServiceJobGlobalActorFilter `json:"globalActor,omitempty"`

	// Status Search by status
	Status *ProcessReferencedServiceJobServiceJobStatusEnumListFilter `json:"status,omitempty"`
}

ProcessReferencedServiceJobFilter ProcessReferencedServiceJobFilter

type ProcessReferencedServiceJobGlobalActorFilter added in v0.8.0

type ProcessReferencedServiceJobGlobalActorFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringSearchFilter `json:"id,omitempty"`
}

ProcessReferencedServiceJobGlobalActorFilter ProcessReferencedServiceJobGlobalActorFilter

type ProcessReferencedServiceJobServiceJobStatusEnumFilter

type ProcessReferencedServiceJobServiceJobStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessReferencedServiceJobServiceJobStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessReferencedServiceJobServiceJobStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedServiceJobServiceJobStatusEnumFilter ProcessReferencedServiceJobServiceJobStatusEnumFilter

type ProcessReferencedServiceJobServiceJobStatusEnumFilterEq

type ProcessReferencedServiceJobServiceJobStatusEnumFilterEq string

ProcessReferencedServiceJobServiceJobStatusEnumFilterEq Search by status

const (
	ProcessReferencedServiceJobServiceJobStatusEnumFilterEqCANCELLED       ProcessReferencedServiceJobServiceJobStatusEnumFilterEq = "CANCELLED"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterEqFINISHED        ProcessReferencedServiceJobServiceJobStatusEnumFilterEq = "FINISHED"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterEqINPROGRESS      ProcessReferencedServiceJobServiceJobStatusEnumFilterEq = "IN_PROGRESS"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterEqNOTREADY        ProcessReferencedServiceJobServiceJobStatusEnumFilterEq = "NOT_READY"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterEqOBSOLETE        ProcessReferencedServiceJobServiceJobStatusEnumFilterEq = "OBSOLETE"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterEqOPEN            ProcessReferencedServiceJobServiceJobStatusEnumFilterEq = "OPEN"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterEqWAITINGFORINPUT ProcessReferencedServiceJobServiceJobStatusEnumFilterEq = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedServiceJobServiceJobStatusEnumFilterEq.

func (ProcessReferencedServiceJobServiceJobStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedServiceJobServiceJobStatusEnumFilterEq enum.

type ProcessReferencedServiceJobServiceJobStatusEnumFilterIn

type ProcessReferencedServiceJobServiceJobStatusEnumFilterIn string

ProcessReferencedServiceJobServiceJobStatusEnumFilterIn defines model for ProcessReferencedServiceJobServiceJobStatusEnumFilter.In.

const (
	ProcessReferencedServiceJobServiceJobStatusEnumFilterInCANCELLED       ProcessReferencedServiceJobServiceJobStatusEnumFilterIn = "CANCELLED"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterInFINISHED        ProcessReferencedServiceJobServiceJobStatusEnumFilterIn = "FINISHED"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterInINPROGRESS      ProcessReferencedServiceJobServiceJobStatusEnumFilterIn = "IN_PROGRESS"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterInNOTREADY        ProcessReferencedServiceJobServiceJobStatusEnumFilterIn = "NOT_READY"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterInOBSOLETE        ProcessReferencedServiceJobServiceJobStatusEnumFilterIn = "OBSOLETE"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterInOPEN            ProcessReferencedServiceJobServiceJobStatusEnumFilterIn = "OPEN"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterInWAITINGFORINPUT ProcessReferencedServiceJobServiceJobStatusEnumFilterIn = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedServiceJobServiceJobStatusEnumFilterIn.

func (ProcessReferencedServiceJobServiceJobStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedServiceJobServiceJobStatusEnumFilterIn enum.

type ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq

type ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq string

ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq Search by status

const (
	ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEqCANCELLED       ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq = "CANCELLED"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEqFINISHED        ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq = "FINISHED"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEqINPROGRESS      ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq = "IN_PROGRESS"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEqNOTREADY        ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq = "NOT_READY"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEqOBSOLETE        ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq = "OBSOLETE"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEqOPEN            ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq = "OPEN"
	ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEqWAITINGFORINPUT ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq = "WAITING_FOR_INPUT"
)

Defines values for ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq.

func (ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedServiceJobServiceJobStatusEnumFilterNotEq enum.

type ProcessReferencedServiceJobServiceJobStatusEnumListFilter

type ProcessReferencedServiceJobServiceJobStatusEnumListFilter struct {
	// Contains Search by status
	Contains *ProcessReferencedServiceJobServiceJobStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedServiceJobServiceJobStatusEnumListFilter ProcessReferencedServiceJobServiceJobStatusEnumListFilter

type ProcessReferencedServiceLevelEnumFilter

type ProcessReferencedServiceLevelEnumFilter struct {
	// Eq Search by serviceLevel
	Eq *ProcessReferencedServiceLevelEnumFilterEq `json:"eq,omitempty"`

	// In Search by serviceLevel
	In *[]ProcessReferencedServiceLevelEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by serviceLevel
	NotEq *ProcessReferencedServiceLevelEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedServiceLevelEnumFilter ProcessReferencedServiceLevelEnumFilter

type ProcessReferencedServiceLevelEnumFilterEq

type ProcessReferencedServiceLevelEnumFilterEq string

ProcessReferencedServiceLevelEnumFilterEq Search by serviceLevel

const (
	ProcessReferencedServiceLevelEnumFilterEqDELIVERY ProcessReferencedServiceLevelEnumFilterEq = "DELIVERY"
	ProcessReferencedServiceLevelEnumFilterEqSAMEDAY  ProcessReferencedServiceLevelEnumFilterEq = "SAMEDAY"
)

Defines values for ProcessReferencedServiceLevelEnumFilterEq.

func (ProcessReferencedServiceLevelEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedServiceLevelEnumFilterEq enum.

type ProcessReferencedServiceLevelEnumFilterIn

type ProcessReferencedServiceLevelEnumFilterIn string

ProcessReferencedServiceLevelEnumFilterIn defines model for ProcessReferencedServiceLevelEnumFilter.In.

const (
	ProcessReferencedServiceLevelEnumFilterInDELIVERY ProcessReferencedServiceLevelEnumFilterIn = "DELIVERY"
	ProcessReferencedServiceLevelEnumFilterInSAMEDAY  ProcessReferencedServiceLevelEnumFilterIn = "SAMEDAY"
)

Defines values for ProcessReferencedServiceLevelEnumFilterIn.

func (ProcessReferencedServiceLevelEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedServiceLevelEnumFilterIn enum.

type ProcessReferencedServiceLevelEnumFilterNotEq

type ProcessReferencedServiceLevelEnumFilterNotEq string

ProcessReferencedServiceLevelEnumFilterNotEq Search by serviceLevel

const (
	ProcessReferencedServiceLevelEnumFilterNotEqDELIVERY ProcessReferencedServiceLevelEnumFilterNotEq = "DELIVERY"
	ProcessReferencedServiceLevelEnumFilterNotEqSAMEDAY  ProcessReferencedServiceLevelEnumFilterNotEq = "SAMEDAY"
)

Defines values for ProcessReferencedServiceLevelEnumFilterNotEq.

func (ProcessReferencedServiceLevelEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedServiceLevelEnumFilterNotEq enum.

type ProcessReferencedServiceLevelEnumListFilter

type ProcessReferencedServiceLevelEnumListFilter struct {
	// Contains Search by serviceLevel
	Contains *ProcessReferencedServiceLevelEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedServiceLevelEnumListFilter ProcessReferencedServiceLevelEnumListFilter

type ProcessReferencedShipmentFilter

type ProcessReferencedShipmentFilter struct {
	// Status Search by status
	Status *ProcessReferencedShipmentShipmentStatusEnumListFilter `json:"status,omitempty"`
}

ProcessReferencedShipmentFilter ProcessReferencedShipmentFilter

type ProcessReferencedShipmentShipmentStatusEnumFilter

type ProcessReferencedShipmentShipmentStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessReferencedShipmentShipmentStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessReferencedShipmentShipmentStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessReferencedShipmentShipmentStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessReferencedShipmentShipmentStatusEnumFilter ProcessReferencedShipmentShipmentStatusEnumFilter

type ProcessReferencedShipmentShipmentStatusEnumFilterEq

type ProcessReferencedShipmentShipmentStatusEnumFilterEq string

ProcessReferencedShipmentShipmentStatusEnumFilterEq Search by status

const (
	ProcessReferencedShipmentShipmentStatusEnumFilterEqCANCELED  ProcessReferencedShipmentShipmentStatusEnumFilterEq = "CANCELED"
	ProcessReferencedShipmentShipmentStatusEnumFilterEqCOMPLETED ProcessReferencedShipmentShipmentStatusEnumFilterEq = "COMPLETED"
	ProcessReferencedShipmentShipmentStatusEnumFilterEqCONFIRMED ProcessReferencedShipmentShipmentStatusEnumFilterEq = "CONFIRMED"
	ProcessReferencedShipmentShipmentStatusEnumFilterEqINITIAL   ProcessReferencedShipmentShipmentStatusEnumFilterEq = "INITIAL"
	ProcessReferencedShipmentShipmentStatusEnumFilterEqOBSOLETE  ProcessReferencedShipmentShipmentStatusEnumFilterEq = "OBSOLETE"
	ProcessReferencedShipmentShipmentStatusEnumFilterEqREQUEST   ProcessReferencedShipmentShipmentStatusEnumFilterEq = "REQUEST"
	ProcessReferencedShipmentShipmentStatusEnumFilterEqRETRYABLE ProcessReferencedShipmentShipmentStatusEnumFilterEq = "RETRYABLE"
)

Defines values for ProcessReferencedShipmentShipmentStatusEnumFilterEq.

func (ProcessReferencedShipmentShipmentStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedShipmentShipmentStatusEnumFilterEq enum.

type ProcessReferencedShipmentShipmentStatusEnumFilterIn

type ProcessReferencedShipmentShipmentStatusEnumFilterIn string

ProcessReferencedShipmentShipmentStatusEnumFilterIn defines model for ProcessReferencedShipmentShipmentStatusEnumFilter.In.

const (
	ProcessReferencedShipmentShipmentStatusEnumFilterInCANCELED  ProcessReferencedShipmentShipmentStatusEnumFilterIn = "CANCELED"
	ProcessReferencedShipmentShipmentStatusEnumFilterInCOMPLETED ProcessReferencedShipmentShipmentStatusEnumFilterIn = "COMPLETED"
	ProcessReferencedShipmentShipmentStatusEnumFilterInCONFIRMED ProcessReferencedShipmentShipmentStatusEnumFilterIn = "CONFIRMED"
	ProcessReferencedShipmentShipmentStatusEnumFilterInINITIAL   ProcessReferencedShipmentShipmentStatusEnumFilterIn = "INITIAL"
	ProcessReferencedShipmentShipmentStatusEnumFilterInOBSOLETE  ProcessReferencedShipmentShipmentStatusEnumFilterIn = "OBSOLETE"
	ProcessReferencedShipmentShipmentStatusEnumFilterInREQUEST   ProcessReferencedShipmentShipmentStatusEnumFilterIn = "REQUEST"
	ProcessReferencedShipmentShipmentStatusEnumFilterInRETRYABLE ProcessReferencedShipmentShipmentStatusEnumFilterIn = "RETRYABLE"
)

Defines values for ProcessReferencedShipmentShipmentStatusEnumFilterIn.

func (ProcessReferencedShipmentShipmentStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ProcessReferencedShipmentShipmentStatusEnumFilterIn enum.

type ProcessReferencedShipmentShipmentStatusEnumFilterNotEq

type ProcessReferencedShipmentShipmentStatusEnumFilterNotEq string

ProcessReferencedShipmentShipmentStatusEnumFilterNotEq Search by status

const (
	ProcessReferencedShipmentShipmentStatusEnumFilterNotEqCANCELED  ProcessReferencedShipmentShipmentStatusEnumFilterNotEq = "CANCELED"
	ProcessReferencedShipmentShipmentStatusEnumFilterNotEqCOMPLETED ProcessReferencedShipmentShipmentStatusEnumFilterNotEq = "COMPLETED"
	ProcessReferencedShipmentShipmentStatusEnumFilterNotEqCONFIRMED ProcessReferencedShipmentShipmentStatusEnumFilterNotEq = "CONFIRMED"
	ProcessReferencedShipmentShipmentStatusEnumFilterNotEqINITIAL   ProcessReferencedShipmentShipmentStatusEnumFilterNotEq = "INITIAL"
	ProcessReferencedShipmentShipmentStatusEnumFilterNotEqOBSOLETE  ProcessReferencedShipmentShipmentStatusEnumFilterNotEq = "OBSOLETE"
	ProcessReferencedShipmentShipmentStatusEnumFilterNotEqREQUEST   ProcessReferencedShipmentShipmentStatusEnumFilterNotEq = "REQUEST"
	ProcessReferencedShipmentShipmentStatusEnumFilterNotEqRETRYABLE ProcessReferencedShipmentShipmentStatusEnumFilterNotEq = "RETRYABLE"
)

Defines values for ProcessReferencedShipmentShipmentStatusEnumFilterNotEq.

func (ProcessReferencedShipmentShipmentStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessReferencedShipmentShipmentStatusEnumFilterNotEq enum.

type ProcessReferencedShipmentShipmentStatusEnumListFilter

type ProcessReferencedShipmentShipmentStatusEnumListFilter struct {
	// Contains Search by status
	Contains *ProcessReferencedShipmentShipmentStatusEnumFilter `json:"contains,omitempty"`
}

ProcessReferencedShipmentShipmentStatusEnumListFilter ProcessReferencedShipmentShipmentStatusEnumListFilter

type ProcessReferencedStickerFilter

type ProcessReferencedStickerFilter struct {
	// Name Search by name
	Name *StringSearchFilter `json:"name,omitempty"`
}

ProcessReferencedStickerFilter ProcessReferencedStickerFilter

type ProcessSearchQuery

type ProcessSearchQuery struct {
	And *[]ProcessSearchQuery `json:"and,omitempty"`

	// CarrierManagementStatuses Search by carrierManagementStatuses
	CarrierManagementStatuses *ProcessStatusEnumFilter `json:"carrierManagementStatuses,omitempty"`

	// Created Search by created
	Created *DateFilter `json:"created,omitempty"`

	// DocumentRefs Search by documentRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	DocumentRefs *StringListFilter `json:"documentRefs,omitempty"`

	// DomainStatuses Nested search by domainStatuses
	DomainStatuses *ProcessDomainStatusesFilter `json:"domainStatuses,omitempty"`

	// DomsStatus Search by domsStatus
	DomsStatus *ProcessStatusEnumFilter `json:"domsStatus,omitempty"`

	// ExternalActionRefs Search by externalActionRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	ExternalActionRefs *StringListFilter `json:"externalActionRefs,omitempty"`

	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// FacilityRefsWithActiveOperations Search by facilityRefsWithActiveOperations
	FacilityRefsWithActiveOperations *StringFilter `json:"facilityRefsWithActiveOperations,omitempty"`

	// FlatRefs Search by flatRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FlatRefs *StringListFilter `json:"flatRefs,omitempty"`

	// HandoverJobRefs Search by handoverJobRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	HandoverJobRefs *StringListFilter `json:"handoverJobRefs,omitempty"`

	// InventoryStatus Search by inventoryStatus
	InventoryStatus *ProcessStatusEnumFilter `json:"inventoryStatus,omitempty"`

	// ItemReturnJobsRef Search by itemReturnJobsRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	ItemReturnJobsRef *StringListFilter `json:"itemReturnJobsRef,omitempty"`

	// OperativeStatus Search by operativeStatus
	OperativeStatus *ProcessStatusEnumFilter `json:"operativeStatus,omitempty"`
	Or              *[]ProcessSearchQuery    `json:"or,omitempty"`

	// OrderRef Search by orderRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	OrderRef *StringFilter `json:"orderRef,omitempty"`

	// PackJobRefs Search by packJobRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	PackJobRefs *StringListFilter `json:"packJobRefs,omitempty"`

	// PickJobRefs Search by pickJobRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	PickJobRefs *StringListFilter `json:"pickJobRefs,omitempty"`

	// ProcessId Search by processId
	ProcessId *StringSearchFilter `json:"processId,omitempty"`

	// Referenced Nested search by referenced
	Referenced *ProcessReferencedFilter `json:"referenced,omitempty"`

	// ReturnRefs Search by returnRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	ReturnRefs *StringListFilter `json:"returnRefs,omitempty"`

	// ReturnStatus Search by returnStatus
	ReturnStatus *ProcessStatusEnumFilter `json:"returnStatus,omitempty"`

	// RoutingPlanRefs Search by routingPlanRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	RoutingPlanRefs *StringListFilter `json:"routingPlanRefs,omitempty"`

	// SearchTerm Full-text search for this entity
	SearchTerm *SearchFilter `json:"searchTerm,omitempty"`

	// ServiceJobRefs Search by serviceJobRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	ServiceJobRefs *StringListFilter `json:"serviceJobRefs,omitempty"`

	// ShipmentRefs Search by shipmentRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	ShipmentRefs *StringListFilter `json:"shipmentRefs,omitempty"`

	// Status Search by status
	Status *ProcessStatusEnumFilter `json:"status,omitempty"`

	// Tags Nested list search by tags
	Tags *ProcessTagsListFilter `json:"tags,omitempty"`
}

ProcessSearchQuery ProcessSearchQuery

type ProcessStatusEnumFilter

type ProcessStatusEnumFilter struct {
	// Eq Search by status
	Eq *ProcessStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ProcessStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ProcessStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ProcessStatusEnumFilter ProcessStatusEnumFilter

type ProcessStatusEnumFilterEq

type ProcessStatusEnumFilterEq string

ProcessStatusEnumFilterEq Search by status

const (
	ProcessStatusEnumFilterEqCANCELED     ProcessStatusEnumFilterEq = "CANCELED"
	ProcessStatusEnumFilterEqCREATED      ProcessStatusEnumFilterEq = "CREATED"
	ProcessStatusEnumFilterEqERROR        ProcessStatusEnumFilterEq = "ERROR"
	ProcessStatusEnumFilterEqFINISHED     ProcessStatusEnumFilterEq = "FINISHED"
	ProcessStatusEnumFilterEqINPROGRESS   ProcessStatusEnumFilterEq = "IN_PROGRESS"
	ProcessStatusEnumFilterEqNOTAVAILABLE ProcessStatusEnumFilterEq = "NOT_AVAILABLE"
)

Defines values for ProcessStatusEnumFilterEq.

func (ProcessStatusEnumFilterEq) Valid

func (e ProcessStatusEnumFilterEq) Valid() bool

Valid indicates whether the value is a known member of the ProcessStatusEnumFilterEq enum.

type ProcessStatusEnumFilterIn

type ProcessStatusEnumFilterIn string

ProcessStatusEnumFilterIn defines model for ProcessStatusEnumFilter.In.

const (
	ProcessStatusEnumFilterInCANCELED     ProcessStatusEnumFilterIn = "CANCELED"
	ProcessStatusEnumFilterInCREATED      ProcessStatusEnumFilterIn = "CREATED"
	ProcessStatusEnumFilterInERROR        ProcessStatusEnumFilterIn = "ERROR"
	ProcessStatusEnumFilterInFINISHED     ProcessStatusEnumFilterIn = "FINISHED"
	ProcessStatusEnumFilterInINPROGRESS   ProcessStatusEnumFilterIn = "IN_PROGRESS"
	ProcessStatusEnumFilterInNOTAVAILABLE ProcessStatusEnumFilterIn = "NOT_AVAILABLE"
)

Defines values for ProcessStatusEnumFilterIn.

func (ProcessStatusEnumFilterIn) Valid

func (e ProcessStatusEnumFilterIn) Valid() bool

Valid indicates whether the value is a known member of the ProcessStatusEnumFilterIn enum.

type ProcessStatusEnumFilterNotEq

type ProcessStatusEnumFilterNotEq string

ProcessStatusEnumFilterNotEq Search by status

const (
	ProcessStatusEnumFilterNotEqCANCELED     ProcessStatusEnumFilterNotEq = "CANCELED"
	ProcessStatusEnumFilterNotEqCREATED      ProcessStatusEnumFilterNotEq = "CREATED"
	ProcessStatusEnumFilterNotEqERROR        ProcessStatusEnumFilterNotEq = "ERROR"
	ProcessStatusEnumFilterNotEqFINISHED     ProcessStatusEnumFilterNotEq = "FINISHED"
	ProcessStatusEnumFilterNotEqINPROGRESS   ProcessStatusEnumFilterNotEq = "IN_PROGRESS"
	ProcessStatusEnumFilterNotEqNOTAVAILABLE ProcessStatusEnumFilterNotEq = "NOT_AVAILABLE"
)

Defines values for ProcessStatusEnumFilterNotEq.

func (ProcessStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ProcessStatusEnumFilterNotEq enum.

type ProcessTagsFilter

type ProcessTagsFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Value Search by value
	Value *StringFilter `json:"value,omitempty"`
}

ProcessTagsFilter ProcessTagsFilter

type ProcessTagsListFilter

type ProcessTagsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *ProcessTagsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

ProcessTagsListFilter ProcessTagsListFilter

type PromiseCarrier added in v0.3.0

type PromiseCarrier struct {
	CarrierKey                string                   `json:"carrierKey"`
	CarrierName               string                   `json:"carrierName"`
	CarrierRef                string                   `json:"carrierRef"`
	DeliveryPromiseValidUntil *time.Time               `json:"deliveryPromiseValidUntil,omitempty"`
	Products                  []PromiseDeliveryOptions `json:"products"`
}

PromiseCarrier PromiseCarrier

type PromiseConfirmActionParameter added in v0.3.0

type PromiseConfirmActionParameter struct {
	Name PromiseConfirmActionParameterName `json:"name"`

	// TenantOrderId The tenantOrderId to be used for the resulting order
	TenantOrderId *string `json:"tenantOrderId,omitempty"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

PromiseConfirmActionParameter Action to confirm a promise.

type PromiseConfirmActionParameterName added in v0.8.0

type PromiseConfirmActionParameterName string

PromiseConfirmActionParameterName defines model for PromiseConfirmActionParameter.Name.

const (
	CONFIRMPROMISE PromiseConfirmActionParameterName = "CONFIRM_PROMISE"
)

Defines values for PromiseConfirmActionParameterName.

func (PromiseConfirmActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the PromiseConfirmActionParameterName enum.

type PromiseDeliveryOptions added in v0.3.0

type PromiseDeliveryOptions struct {
	// CarrierProductCategory CarrierProductCategory
	CarrierProductCategory CarrierProductCategory `json:"carrierProductCategory"`
	DeliveryCosts          []DeliveryCost         `json:"deliveryCosts"`

	// EstimatedDeliveryTime EstimatedDeliveryTime
	EstimatedDeliveryTime *EstimatedDeliveryTime `json:"estimatedDeliveryTime,omitempty"`

	// TransitTime CarrierTransitTime
	TransitTime *CarrierTransitTime `json:"transitTime,omitempty"`
}

PromiseDeliveryOptions PromiseDeliveryOptions

type PromiseExtendActionParameter added in v0.3.0

type PromiseExtendActionParameter struct {
	Name PromiseExtendActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

PromiseExtendActionParameter Action to extend a promise.

type PromiseExtendActionParameterName added in v0.8.0

type PromiseExtendActionParameterName string

PromiseExtendActionParameterName defines model for PromiseExtendActionParameter.Name.

const (
	EXTENDPROMISE PromiseExtendActionParameterName = "EXTEND_PROMISE"
)

Defines values for PromiseExtendActionParameterName.

func (PromiseExtendActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the PromiseExtendActionParameterName enum.

type PromiseRequest added in v0.3.0

type PromiseRequest struct {
	// AdditionalInfo PromiseRequestAdditionalInfo
	AdditionalInfo *PromiseRequestAdditionalInfo `json:"additionalInfo,omitempty"`

	// Consumer OrderForCreationConsumer
	Consumer OrderForCreationConsumer `json:"consumer"`

	// CustomAttributes Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{}              `json:"customAttributes,omitempty"`
	CustomServices   *[]CustomServiceReferenceForCreation `json:"customServices,omitempty"`

	// DeliveryPreferences DeliveryPreferences
	DeliveryPreferences *DeliveryPreferences `json:"deliveryPreferences,omitempty"`

	// OrderDate The date this order was created at the supplying system.
	//
	// Example: 2020-02-03T08:45:50.525Z
	OrderDate      time.Time                  `json:"orderDate"`
	OrderLineItems []OrderLineItemForCreation `json:"orderLineItems"`

	// PaymentInfo OrderPaymentInfoForCreation
	PaymentInfo *OrderPaymentInfoForCreation `json:"paymentInfo,omitempty"`

	// Pricing This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.
	Pricing *OrderPricingForCreation `json:"pricing,omitempty"`

	// PromisesOptions OrderPromisesOptions
	PromisesOptions *OrderPromisesOptions `json:"promisesOptions,omitempty"`

	// Status The state of the order. Initially it is OPEN.
	Status        *OrderStatus         `json:"status,omitempty"`
	StatusReasons *[]OrderStatusReason `json:"statusReasons,omitempty"`
	Stickers      *[]Sticker           `json:"stickers,omitempty"`
	Tags          *[]TagReference      `json:"tags,omitempty"`

	// TenantOrderId Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
	//
	// Example: R456728546
	TenantOrderId *string `json:"tenantOrderId,omitempty"`
}

PromiseRequest PromiseRequest

type PromiseRequestAdditionalInfo added in v0.3.0

type PromiseRequestAdditionalInfo struct {
	// IncludeListingCustomAttributes If true, the listing custom attributes are included in the response. This is useful for debugging purposes.
	IncludeListingCustomAttributes *bool `json:"includeListingCustomAttributes,omitempty"`

	// ResourceInvestment How much resources should be invested during the optimization?
	ResourceInvestment *ResourceInvestment `json:"resourceInvestment,omitempty"`
}

PromiseRequestAdditionalInfo PromiseRequestAdditionalInfo

type PutFacilityListingJSONRequestBody

type PutFacilityListingJSONRequestBody = ListingsForReplacement

PutFacilityListingJSONRequestBody defines body for PutFacilityListing for application/json ContentType.

type PutFacilityListingPartialStockJSONRequestBody deprecated

type PutFacilityListingPartialStockJSONRequestBody = PartialStocksForReplacement

PutFacilityListingPartialStockJSONRequestBody defines body for PutFacilityListingPartialStock for application/json ContentType.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type PutFacilityListingPartialStockResponse

type PutFacilityListingPartialStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParsePutFacilityListingPartialStockResponse

func ParsePutFacilityListingPartialStockResponse(rsp *http.Response) (*PutFacilityListingPartialStockResponse, error)

ParsePutFacilityListingPartialStockResponse parses an HTTP response from a PutFacilityListingPartialStockWithResponse call

func (PutFacilityListingPartialStockResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutFacilityListingPartialStockResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (PutFacilityListingPartialStockResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutFacilityListingPartialStockResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutFacilityListingPartialStockResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PutFacilityListingPartialStockResponse) Status

Status returns HTTPResponse.Status

func (PutFacilityListingPartialStockResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PutFacilityListingResponse

type PutFacilityListingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ListingBulkOperationResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParsePutFacilityListingResponse

func ParsePutFacilityListingResponse(rsp *http.Response) (*PutFacilityListingResponse, error)

ParsePutFacilityListingResponse parses an HTTP response from a PutFacilityListingWithResponse call

func (PutFacilityListingResponse) ContentType

func (r PutFacilityListingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutFacilityListingResponse) GetBody added in v0.8.0

func (r PutFacilityListingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutFacilityListingResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PutFacilityListingResponse) GetJSON401 added in v0.8.0

func (r PutFacilityListingResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutFacilityListingResponse) GetJSON403 added in v0.8.0

func (r PutFacilityListingResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutFacilityListingResponse) GetJSON404 added in v0.8.0

func (r PutFacilityListingResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PutFacilityListingResponse) Status

Status returns HTTPResponse.Status

func (PutFacilityListingResponse) StatusCode

func (r PutFacilityListingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutRoutingStrategyJSONRequestBody added in v0.6.0

type PutRoutingStrategyJSONRequestBody = RoutingStrategyForModification

PutRoutingStrategyJSONRequestBody defines body for PutRoutingStrategy for application/json ContentType.

type PutRoutingStrategyNodeConfigCategoryJSONRequestBody added in v0.6.0

type PutRoutingStrategyNodeConfigCategoryJSONRequestBody = RoutingStrategyNodeConfigCategoryForModification

PutRoutingStrategyNodeConfigCategoryJSONRequestBody defines body for PutRoutingStrategyNodeConfigCategory for application/json ContentType.

type PutRoutingStrategyNodeConfigCategoryResponse added in v0.6.0

type PutRoutingStrategyNodeConfigCategoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingStrategyNodeConfigCategoryForResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParsePutRoutingStrategyNodeConfigCategoryResponse added in v0.6.0

func ParsePutRoutingStrategyNodeConfigCategoryResponse(rsp *http.Response) (*PutRoutingStrategyNodeConfigCategoryResponse, error)

ParsePutRoutingStrategyNodeConfigCategoryResponse parses an HTTP response from a PutRoutingStrategyNodeConfigCategoryWithResponse call

func (PutRoutingStrategyNodeConfigCategoryResponse) ContentType added in v0.6.0

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutRoutingStrategyNodeConfigCategoryResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (PutRoutingStrategyNodeConfigCategoryResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PutRoutingStrategyNodeConfigCategoryResponse) GetJSON400 added in v0.8.0

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PutRoutingStrategyNodeConfigCategoryResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutRoutingStrategyNodeConfigCategoryResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutRoutingStrategyNodeConfigCategoryResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (PutRoutingStrategyNodeConfigCategoryResponse) StatusCode added in v0.6.0

StatusCode returns HTTPResponse.StatusCode

type PutRoutingStrategyResponse added in v0.6.0

type PutRoutingStrategyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RoutingStrategy
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParsePutRoutingStrategyResponse added in v0.6.0

func ParsePutRoutingStrategyResponse(rsp *http.Response) (*PutRoutingStrategyResponse, error)

ParsePutRoutingStrategyResponse parses an HTTP response from a PutRoutingStrategyWithResponse call

func (PutRoutingStrategyResponse) ContentType added in v0.6.0

func (r PutRoutingStrategyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutRoutingStrategyResponse) GetBody added in v0.8.0

func (r PutRoutingStrategyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutRoutingStrategyResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PutRoutingStrategyResponse) GetJSON400 added in v0.8.0

func (r PutRoutingStrategyResponse) GetJSON400() *ApiError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PutRoutingStrategyResponse) GetJSON401 added in v0.8.0

func (r PutRoutingStrategyResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutRoutingStrategyResponse) GetJSON403 added in v0.8.0

func (r PutRoutingStrategyResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutRoutingStrategyResponse) Status added in v0.6.0

Status returns HTTPResponse.Status

func (PutRoutingStrategyResponse) StatusCode added in v0.6.0

func (r PutRoutingStrategyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RatingConfigurationType

type RatingConfigurationType string

RatingConfigurationType This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.

const (
	RatingConfigurationTypeCOSTCOMPONENTS RatingConfigurationType = "COST_COMPONENTS"
)

Defines values for RatingConfigurationType.

func (RatingConfigurationType) Valid

func (e RatingConfigurationType) Valid() bool

Valid indicates whether the value is a known member of the RatingConfigurationType enum.

type RatingImplementation

type RatingImplementation string

RatingImplementation This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.

const (
	RatingImplementationCAPACITY             RatingImplementation = "CAPACITY"
	RatingImplementationCOSTCOMPONENTS       RatingImplementation = "COST-COMPONENTS"
	RatingImplementationDELIVERYCOSTS        RatingImplementation = "DELIVERY-COSTS"
	RatingImplementationDELIVERYTIME         RatingImplementation = "DELIVERY-TIME"
	RatingImplementationEXPIRYDATE           RatingImplementation = "EXPIRY-DATE"
	RatingImplementationGEODISTANCE          RatingImplementation = "GEO-DISTANCE"
	RatingImplementationMATCHINGBUSINESSTYPE RatingImplementation = "MATCHING-BUSINESSTYPE"
	RatingImplementationNUMBEROFDELIVERIES   RatingImplementation = "NUMBER-OF-DELIVERIES"
	RatingImplementationPREFERSTORE          RatingImplementation = "PREFER-STORE"
	RatingImplementationPREFERWAREHOUSE      RatingImplementation = "PREFER-WAREHOUSE"
	RatingImplementationSTOCKAVAILABILITY    RatingImplementation = "STOCK-AVAILABILITY"
	RatingImplementationSTOCKBALANCING       RatingImplementation = "STOCK-BALANCING"
	RatingImplementationTURNOVER             RatingImplementation = "TURNOVER"
	RatingImplementationWORKLOADBALANCING    RatingImplementation = "WORKLOAD-BALANCING"
	RatingImplementationZONE                 RatingImplementation = "ZONE"
)

Defines values for RatingImplementation.

func (RatingImplementation) Valid

func (e RatingImplementation) Valid() bool

Valid indicates whether the value is a known member of the RatingImplementation enum.

type RatingResult added in v0.2.0

type RatingResult struct {
	Id                    string  `json:"id"`
	Name                  string  `json:"name"`
	Penalty               float32 `json:"penalty"`
	RoutingStrategyNodeId string  `json:"routingStrategyNodeId"`

	// Type The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'
	Type string `json:"type"`
}

RatingResult RatingResult

type RatingResultType added in v0.7.0

type RatingResultType string

RatingResultType RatingResultType

const (
	RatingResultTypeSTANDARD RatingResultType = "STANDARD"
	RatingResultTypeTOOLKIT  RatingResultType = "TOOLKIT"
)

Defines values for RatingResultType.

func (RatingResultType) Valid added in v0.7.0

func (e RatingResultType) Valid() bool

Valid indicates whether the value is a known member of the RatingResultType enum.

type RecordableAttributeValidation added in v0.8.0

type RecordableAttributeValidation struct {
	AllowedValues []RecordableAttributeValidationsAllowedValue `json:"allowedValues"`
	Type          RecordableAttributeValidationType            `json:"type"`
}

RecordableAttributeValidation RecordableAttributeValidation

type RecordableAttributeValidationType added in v0.8.0

type RecordableAttributeValidationType string

RecordableAttributeValidationType defines model for RecordableAttributeValidation.Type.

const (
	EXACTMATCH RecordableAttributeValidationType = "EXACT_MATCH"
)

Defines values for RecordableAttributeValidationType.

func (RecordableAttributeValidationType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the RecordableAttributeValidationType enum.

type RecordableAttributeValidationsAllowedValue added in v0.8.0

type RecordableAttributeValidationsAllowedValue struct {
	Type RecordableAttributeValidationsAllowedValueType `json:"type"`
}

RecordableAttributeValidationsAllowedValue RecordableAttributeValidationsAllowedValue

type RecordableAttributeValidationsAllowedValueType added in v0.8.0

type RecordableAttributeValidationsAllowedValueType string

RecordableAttributeValidationsAllowedValueType defines model for RecordableAttributeValidationsAllowedValue.Type.

const (
	RecordableAttributeValidationsAllowedValueTypeSTRING RecordableAttributeValidationsAllowedValueType = "STRING"
)

Defines values for RecordableAttributeValidationsAllowedValueType.

func (RecordableAttributeValidationsAllowedValueType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the RecordableAttributeValidationsAllowedValueType enum.

type RelativeSurchargeCostDetail added in v0.8.0

type RelativeSurchargeCostDetail struct {
	// Amount Money
	Amount Money `json:"amount"`

	// AppliedToCostDetailIds The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.
	AppliedToCostDetailIds *[]string `json:"appliedToCostDetailIds,omitempty"`

	// CalculationBaseAmount Money
	CalculationBaseAmount Money `json:"calculationBaseAmount"`

	// Id Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds
	//
	// Example: 0
	Id string `json:"id"`

	// Percentage The configured percentage
	//
	// Example: 12.5
	Percentage float32 `json:"percentage"`

	// TenantSurchargeType The tenant surcharge id
	//
	// Example: diesel
	TenantSurchargeType string                          `json:"tenantSurchargeType"`
	Type                RelativeSurchargeCostDetailType `json:"type"`
}

RelativeSurchargeCostDetail A surcharge of the configured percentage of calculationBaseAmount.

type RelativeSurchargeCostDetailType added in v0.8.0

type RelativeSurchargeCostDetailType string

RelativeSurchargeCostDetailType defines model for RelativeSurchargeCostDetail.Type.

const (
	RELATIVESURCHARGE RelativeSurchargeCostDetailType = "RELATIVE_SURCHARGE"
)

Defines values for RelativeSurchargeCostDetailType.

func (RelativeSurchargeCostDetailType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the RelativeSurchargeCostDetailType enum.

type RemoteConfigurationScopesFilter

type RemoteConfigurationScopesFilter struct {
	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// UserRefs Search by userRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	UserRefs *StringListFilter `json:"userRefs,omitempty"`
}

RemoteConfigurationScopesFilter RemoteConfigurationScopesFilter

type RemoteConfigurationScopesListFilter

type RemoteConfigurationScopesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RemoteConfigurationScopesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RemoteConfigurationScopesListFilter RemoteConfigurationScopesListFilter

type RemoteConfigurationSearchQuery

type RemoteConfigurationSearchQuery struct {
	And *[]RemoteConfigurationSearchQuery `json:"and,omitempty"`

	// Groups Search by groups
	Groups *StringListFilter `json:"groups,omitempty"`

	// Key Search by key
	Key *StringFilter                     `json:"key,omitempty"`
	Or  *[]RemoteConfigurationSearchQuery `json:"or,omitempty"`

	// Scopes Nested list search by scopes
	Scopes *RemoteConfigurationScopesListFilter `json:"scopes,omitempty"`
}

RemoteConfigurationSearchQuery RemoteConfigurationSearchQuery

type RemoveFacilityCoordinatesActionParameter

type RemoveFacilityCoordinatesActionParameter struct {
	Name RemoveFacilityCoordinatesActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

RemoveFacilityCoordinatesActionParameter Remove facility Coordinates.

type RemoveFacilityCoordinatesActionParameterName added in v0.8.0

type RemoveFacilityCoordinatesActionParameterName string

RemoveFacilityCoordinatesActionParameterName defines model for RemoveFacilityCoordinatesActionParameter.Name.

const (
	REMOVEFACILITYCOORDINATES RemoveFacilityCoordinatesActionParameterName = "REMOVE_FACILITY_COORDINATES"
)

Defines values for RemoveFacilityCoordinatesActionParameterName.

func (RemoveFacilityCoordinatesActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the RemoveFacilityCoordinatesActionParameterName enum.

type ReplaceFacility200JSONResponseBody

type ReplaceFacility200JSONResponseBody struct {
	// contains filtered or unexported fields
}

ReplaceFacility200JSONResponseBody defines parameters for ReplaceFacility.

func (ReplaceFacility200JSONResponseBody) AsManagedFacility

func (t ReplaceFacility200JSONResponseBody) AsManagedFacility() (ManagedFacility, error)

AsManagedFacility returns the union data inside the ReplaceFacility200JSONResponseBody as a ManagedFacility

func (ReplaceFacility200JSONResponseBody) AsSupplier

AsSupplier returns the union data inside the ReplaceFacility200JSONResponseBody as a Supplier

func (*ReplaceFacility200JSONResponseBody) FromManagedFacility

func (t *ReplaceFacility200JSONResponseBody) FromManagedFacility(v ManagedFacility) error

FromManagedFacility overwrites any union data inside the ReplaceFacility200JSONResponseBody as the provided ManagedFacility

func (*ReplaceFacility200JSONResponseBody) FromSupplier

FromSupplier overwrites any union data inside the ReplaceFacility200JSONResponseBody as the provided Supplier

func (ReplaceFacility200JSONResponseBody) MarshalJSON

func (t ReplaceFacility200JSONResponseBody) MarshalJSON() ([]byte, error)

func (*ReplaceFacility200JSONResponseBody) MergeManagedFacility

func (t *ReplaceFacility200JSONResponseBody) MergeManagedFacility(v ManagedFacility) error

MergeManagedFacility performs a merge with any union data inside the ReplaceFacility200JSONResponseBody, using the provided ManagedFacility

func (*ReplaceFacility200JSONResponseBody) MergeSupplier

MergeSupplier performs a merge with any union data inside the ReplaceFacility200JSONResponseBody, using the provided Supplier

func (*ReplaceFacility200JSONResponseBody) UnmarshalJSON

func (t *ReplaceFacility200JSONResponseBody) UnmarshalJSON(b []byte) error

type ReplaceFacilityJSONBody

type ReplaceFacilityJSONBody struct {
	// contains filtered or unexported fields
}

ReplaceFacilityJSONBody defines parameters for ReplaceFacility.

func (ReplaceFacilityJSONBody) AsManagedFacilityForReplacement

func (t ReplaceFacilityJSONBody) AsManagedFacilityForReplacement() (ManagedFacilityForReplacement, error)

AsManagedFacilityForReplacement returns the union data inside the ReplaceFacilityJSONBody as a ManagedFacilityForReplacement

func (ReplaceFacilityJSONBody) AsSupplierForReplacement

func (t ReplaceFacilityJSONBody) AsSupplierForReplacement() (SupplierForReplacement, error)

AsSupplierForReplacement returns the union data inside the ReplaceFacilityJSONBody as a SupplierForReplacement

func (ReplaceFacilityJSONBody) Discriminator

func (t ReplaceFacilityJSONBody) Discriminator() (string, error)

func (*ReplaceFacilityJSONBody) FromManagedFacilityForReplacement

func (t *ReplaceFacilityJSONBody) FromManagedFacilityForReplacement(v ManagedFacilityForReplacement) error

FromManagedFacilityForReplacement overwrites any union data inside the ReplaceFacilityJSONBody as the provided ManagedFacilityForReplacement

func (*ReplaceFacilityJSONBody) FromSupplierForReplacement

func (t *ReplaceFacilityJSONBody) FromSupplierForReplacement(v SupplierForReplacement) error

FromSupplierForReplacement overwrites any union data inside the ReplaceFacilityJSONBody as the provided SupplierForReplacement

func (ReplaceFacilityJSONBody) MarshalJSON

func (t ReplaceFacilityJSONBody) MarshalJSON() ([]byte, error)

func (*ReplaceFacilityJSONBody) MergeManagedFacilityForReplacement

func (t *ReplaceFacilityJSONBody) MergeManagedFacilityForReplacement(v ManagedFacilityForReplacement) error

MergeManagedFacilityForReplacement performs a merge with any union data inside the ReplaceFacilityJSONBody, using the provided ManagedFacilityForReplacement

func (*ReplaceFacilityJSONBody) MergeSupplierForReplacement

func (t *ReplaceFacilityJSONBody) MergeSupplierForReplacement(v SupplierForReplacement) error

MergeSupplierForReplacement performs a merge with any union data inside the ReplaceFacilityJSONBody, using the provided SupplierForReplacement

func (*ReplaceFacilityJSONBody) UnmarshalJSON

func (t *ReplaceFacilityJSONBody) UnmarshalJSON(b []byte) error

func (ReplaceFacilityJSONBody) ValueByDiscriminator

func (t ReplaceFacilityJSONBody) ValueByDiscriminator() (interface{}, error)

type ReplaceFacilityJSONRequestBody

type ReplaceFacilityJSONRequestBody ReplaceFacilityJSONBody

ReplaceFacilityJSONRequestBody defines body for ReplaceFacility for application/json ContentType.

type ReplaceFacilityResponse

type ReplaceFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ReplaceFacility200JSONResponseBody
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ApiError
}

func ParseReplaceFacilityResponse

func ParseReplaceFacilityResponse(rsp *http.Response) (*ReplaceFacilityResponse, error)

ParseReplaceFacilityResponse parses an HTTP response from a ReplaceFacilityWithResponse call

func (ReplaceFacilityResponse) ContentType

func (r ReplaceFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ReplaceFacilityResponse) GetBody added in v0.8.0

func (r ReplaceFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ReplaceFacilityResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ReplaceFacilityResponse) GetJSON401 added in v0.8.0

func (r ReplaceFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ReplaceFacilityResponse) GetJSON403 added in v0.8.0

func (r ReplaceFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ReplaceFacilityResponse) GetJSON404 added in v0.8.0

func (r ReplaceFacilityResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ReplaceFacilityResponse) GetJSON409 added in v0.8.0

func (r ReplaceFacilityResponse) GetJSON409() *ApiError

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ReplaceFacilityResponse) Status

func (r ReplaceFacilityResponse) Status() string

Status returns HTTPResponse.Status

func (ReplaceFacilityResponse) StatusCode

func (r ReplaceFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RerouteConfiguration added in v0.6.0

type RerouteConfiguration struct {
	Active bool `json:"active"`

	// LeadTimeBeforeTimeTriggeredReroute This setting is not supported anymore
	//
	// Example: 480
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	LeadTimeBeforeTimeTriggeredReroute *float32 `json:"leadTimeBeforeTimeTriggeredReroute,omitempty"`

	// RerouteAfterMinutes The amount of minutes after which an automated reroute is executed
	//
	// Example: 60
	RerouteAfterMinutes float32 `json:"rerouteAfterMinutes"`

	// RerouteStartedJobs RerouteStartedJobsConfiguration
	RerouteStartedJobs *RerouteStartedJobsConfiguration `json:"rerouteStartedJobs,omitempty"`

	// RerouteTargetTimeHours Only pickjobs within the target time window are considered for reroute.
	//
	// Example: 48
	RerouteTargetTimeHours float32 `json:"rerouteTargetTimeHours"`
}

RerouteConfiguration RerouteConfiguration

type RerouteStartedJobsConfiguration added in v0.6.0

type RerouteStartedJobsConfiguration struct {
	// Active If true, the reroute will be executed for jobs that are already started.
	//
	// Example: true
	Active bool `json:"active"`

	// MinimumStartedTimeInMinutes The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.
	//
	// Example: 60
	MinimumStartedTimeInMinutes *float32 `json:"minimumStartedTimeInMinutes,omitempty"`
}

RerouteStartedJobsConfiguration RerouteStartedJobsConfiguration

type ReservationRelatedRefsFilter

type ReservationRelatedRefsFilter struct {
	// OrderRefs Search by orderRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	OrderRefs *StringListFilter `json:"orderRefs,omitempty"`

	// PickJobRefs Search by pickJobRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	PickJobRefs *StringListFilter `json:"pickJobRefs,omitempty"`

	// RoutingPlanRefs Search by routingPlanRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	RoutingPlanRefs *StringListFilter `json:"routingPlanRefs,omitempty"`

	// TransferRefs Search by transferRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	TransferRefs *StringListFilter `json:"transferRefs,omitempty"`
}

ReservationRelatedRefsFilter ReservationRelatedRefsFilter

type ReservationSearchQuery

type ReservationSearchQuery struct {
	And *[]ReservationSearchQuery `json:"and,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter             `json:"id,omitempty"`
	Or *[]ReservationSearchQuery `json:"or,omitempty"`

	// RelatedRefs Nested search by relatedRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	RelatedRefs *ReservationRelatedRefsFilter `json:"relatedRefs,omitempty"`

	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`
}

ReservationSearchQuery ReservationSearchQuery

type ResourceInvestment added in v0.2.0

type ResourceInvestment struct {
	// Level [abstract values]: how many resources should we invest in optimization. With a higher level the results will be better, nevertheless we need to invest more time for the optimization.
	//
	// Example: 0.2
	Level float32 `json:"level"`
}

ResourceInvestment How much resources should be invested during the optimization?

type ResponseForDeliveryPromise added in v0.3.0

type ResponseForDeliveryPromise struct {
	// BackOrdered Backordered
	BackOrdered *Backordered `json:"backOrdered,omitempty"`

	// Collect DeliveryPromiseCollect
	Collect      *DeliveryPromiseCollect `json:"collect,omitempty"`
	OrderRef     string                  `json:"orderRef"`
	OrderVersion float32                 `json:"orderVersion"`

	// Pricing This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.
	Pricing *OrderPricing `json:"pricing,omitempty"`

	// PromisesOptions OrderPromisesOptions
	PromisesOptions *OrderPromisesOptions      `json:"promisesOptions,omitempty"`
	ShipToCustomer  *[]DeliveryPromiseShipment `json:"shipToCustomer,omitempty"`
	ShipToStore     *[]DeliveryPromiseShipment `json:"shipToStore,omitempty"`

	// SourcingOption SourcingOption
	SourcingOption *SourcingOption `json:"sourcingOption,omitempty"`
}

ResponseForDeliveryPromise ResponseForDeliveryPromise

type Role

type Role struct {
	// Context An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.
	Context *[]ContextLimitation `json:"context,omitempty"`

	// ContextLimitations Deprecated: Use context instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ContextLimitations *[]ContextLimitation `json:"contextLimitations,omitempty"`

	// Contexts Deprecated: Use context instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Contexts *[]ContextLimitation `json:"contexts,omitempty"`

	// Created The date when the role was created.
	Created time.Time `json:"created"`

	// CustomAttributes The custom attributes of the role, which can be used to store additional information.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Description The description of the role, which provides more details about its purpose.
	Description *string `json:"description,omitempty"`

	// DisplayName The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
	DisplayName *string `json:"displayName,omitempty"`

	// LastModified The date when the role was last modified.
	LastModified time.Time `json:"lastModified"`

	// Name The name of the role, which must be unique and is used to identify the role.
	Name string `json:"name"`

	// Permissions The permissions associated with the role, which define what actions the role can perform.
	Permissions []RolePermissions `json:"permissions"`

	// Version The version of the role.
	//
	// Example: 1
	Version float32 `json:"version"`
}

Role Role

type RoleForCreation

type RoleForCreation struct {
	// Context An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.
	Context *[]ContextLimitation `json:"context,omitempty"`

	// ContextLimitations Deprecated: Use context instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ContextLimitations *[]ContextLimitation `json:"contextLimitations,omitempty"`

	// Contexts Deprecated: Use context instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Contexts *[]ContextLimitation `json:"contexts,omitempty"`

	// CustomAttributes The custom attributes of the role, which can be used to store additional information.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Description The description of the role, which provides more details about its purpose.
	Description *string `json:"description,omitempty"`

	// DisplayName The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
	DisplayName *string `json:"displayName,omitempty"`

	// Name The name of the role, which must be unique and is used to identify the role.
	Name string `json:"name"`

	// Permissions The permissions associated with the role, which define what actions the role can perform.
	Permissions []RoleForCreationPermissions `json:"permissions"`
}

RoleForCreation RoleForCreation

type RoleForCreationPermissions

type RoleForCreationPermissions string

RoleForCreationPermissions defines model for RoleForCreation.Permissions.

const (
	RoleForCreationPermissionsADMINDATARESET                        RoleForCreationPermissions = "ADMIN_DATA_RESET"
	RoleForCreationPermissionsADMININTERFACILITYCONNECTIONMIGRATION RoleForCreationPermissions = "ADMIN_INTER_FACILITY_CONNECTION_MIGRATION"
	RoleForCreationPermissionsADMINMODULESREAD                      RoleForCreationPermissions = "ADMIN_MODULES_READ"
	RoleForCreationPermissionsADMINMODULESWRITE                     RoleForCreationPermissions = "ADMIN_MODULES_WRITE"
	RoleForCreationPermissionsADMINROUTINGPLANANALYSIS              RoleForCreationPermissions = "ADMIN_ROUTING_PLAN_ANALYSIS"
	RoleForCreationPermissionsAIASSISTANTACCESS                     RoleForCreationPermissions = "AI_ASSISTANT_ACCESS"
	RoleForCreationPermissionsANALYTICSDASHBOARDREAD                RoleForCreationPermissions = "ANALYTICS_DASHBOARD_READ"
	RoleForCreationPermissionsAUDITREAD                             RoleForCreationPermissions = "AUDIT_READ"
	RoleForCreationPermissionsAVAILABILITYCHANNELREAD               RoleForCreationPermissions = "AVAILABILITY_CHANNEL_READ"
	RoleForCreationPermissionsAVAILABILITYCHANNELWRITE              RoleForCreationPermissions = "AVAILABILITY_CHANNEL_WRITE"
	RoleForCreationPermissionsAVAILABILITYTHRESHOLDSREAD            RoleForCreationPermissions = "AVAILABILITY_THRESHOLDS_READ"
	RoleForCreationPermissionsAVAILABILITYTHRESHOLDSWRITE           RoleForCreationPermissions = "AVAILABILITY_THRESHOLDS_WRITE"
	RoleForCreationPermissionsBRANDREAD                             RoleForCreationPermissions = "BRAND_READ"
	RoleForCreationPermissionsCARRIERREAD                           RoleForCreationPermissions = "CARRIER_READ"
	RoleForCreationPermissionsCARRIERWRITE                          RoleForCreationPermissions = "CARRIER_WRITE"
	RoleForCreationPermissionsCATEGORYREAD                          RoleForCreationPermissions = "CATEGORY_READ"
	RoleForCreationPermissionsCATEGORYWRITE                         RoleForCreationPermissions = "CATEGORY_WRITE"
	RoleForCreationPermissionsCONFIGREAD                            RoleForCreationPermissions = "CONFIG_READ"
	RoleForCreationPermissionsCONFIGWRITE                           RoleForCreationPermissions = "CONFIG_WRITE"
	RoleForCreationPermissionsCURRENTUSERMODIFY                     RoleForCreationPermissions = "CURRENT_USER_MODIFY"
	RoleForCreationPermissionsCURRENTUSERREAD                       RoleForCreationPermissions = "CURRENT_USER_READ"
	RoleForCreationPermissionsCUSTOMSERVICEREAD                     RoleForCreationPermissions = "CUSTOM_SERVICE_READ"
	RoleForCreationPermissionsCUSTOMSERVICEWRITE                    RoleForCreationPermissions = "CUSTOM_SERVICE_WRITE"
	RoleForCreationPermissionsDELIVERYNOTEWRITE                     RoleForCreationPermissions = "DELIVERYNOTE_WRITE"
	RoleForCreationPermissionsDOCUMENTSETREAD                       RoleForCreationPermissions = "DOCUMENT_SET_READ"
	RoleForCreationPermissionsDOCUMENTSETWRITE                      RoleForCreationPermissions = "DOCUMENT_SET_WRITE"
	RoleForCreationPermissionsDOMSSTATISTICSREAD                    RoleForCreationPermissions = "DOMS_STATISTICS_READ"
	RoleForCreationPermissionsDOMSTOOLKITREAD                       RoleForCreationPermissions = "DOMS_TOOLKIT_READ"
	RoleForCreationPermissionsDOMSTOOLKITWRITE                      RoleForCreationPermissions = "DOMS_TOOLKIT_WRITE"
	RoleForCreationPermissionsEVENTREAD                             RoleForCreationPermissions = "EVENT_READ"
	RoleForCreationPermissionsEXPIRIESREAD                          RoleForCreationPermissions = "EXPIRIES_READ"
	RoleForCreationPermissionsEXPIRIESWRITE                         RoleForCreationPermissions = "EXPIRIES_WRITE"
	RoleForCreationPermissionsEXPORTREAD                            RoleForCreationPermissions = "EXPORT_READ"
	RoleForCreationPermissionsEXPORTWRITE                           RoleForCreationPermissions = "EXPORT_WRITE"
	RoleForCreationPermissionsEXTERNALACTIONSREAD                   RoleForCreationPermissions = "EXTERNAL_ACTIONS_READ"
	RoleForCreationPermissionsEXTERNALACTIONSWRITE                  RoleForCreationPermissions = "EXTERNAL_ACTIONS_WRITE"
	RoleForCreationPermissionsEXTERNALSTOCKCHANGEREASONSREAD        RoleForCreationPermissions = "EXTERNAL_STOCK_CHANGE_REASONS_READ"
	RoleForCreationPermissionsEXTERNALSTOCKCHANGEREASONSWRITE       RoleForCreationPermissions = "EXTERNAL_STOCK_CHANGE_REASONS_WRITE"
	RoleForCreationPermissionsFACILITYCREATE                        RoleForCreationPermissions = "FACILITY_CREATE"
	RoleForCreationPermissionsFACILITYDELETE                        RoleForCreationPermissions = "FACILITY_DELETE"
	RoleForCreationPermissionsFACILITYGROUPREAD                     RoleForCreationPermissions = "FACILITY_GROUP_READ"
	RoleForCreationPermissionsFACILITYGROUPWRITE                    RoleForCreationPermissions = "FACILITY_GROUP_WRITE"
	RoleForCreationPermissionsFACILITYREAD                          RoleForCreationPermissions = "FACILITY_READ"
	RoleForCreationPermissionsFACILITYWRITE                         RoleForCreationPermissions = "FACILITY_WRITE"
	RoleForCreationPermissionsFILTERENTITYREAD                      RoleForCreationPermissions = "FILTER_ENTITY_READ"
	RoleForCreationPermissionsHANDOVERCONTAINERREAD                 RoleForCreationPermissions = "HANDOVER_CONTAINER_READ"
	RoleForCreationPermissionsHANDOVERCONTAINERWRITE                RoleForCreationPermissions = "HANDOVER_CONTAINER_WRITE"
	RoleForCreationPermissionsHANDOVERJOBREAD                       RoleForCreationPermissions = "HANDOVERJOB_READ"
	RoleForCreationPermissionsHANDOVERJOBWRITE                      RoleForCreationPermissions = "HANDOVERJOB_WRITE"
	RoleForCreationPermissionsINBOUNDPROCESSREAD                    RoleForCreationPermissions = "INBOUND_PROCESS_READ"
	RoleForCreationPermissionsINBOUNDPROCESSWRITE                   RoleForCreationPermissions = "INBOUND_PROCESS_WRITE"
	RoleForCreationPermissionsKPIREAD                               RoleForCreationPermissions = "KPI_READ"
	RoleForCreationPermissionsLINEITEMADD                           RoleForCreationPermissions = "LINE_ITEM_ADD"
	RoleForCreationPermissionsLINEITEMDELETE                        RoleForCreationPermissions = "LINE_ITEM_DELETE"
	RoleForCreationPermissionsLINEITEMPRICINGREAD                   RoleForCreationPermissions = "LINE_ITEM_PRICING_READ"
	RoleForCreationPermissionsLINEITEMQUANTITYDECREASE              RoleForCreationPermissions = "LINE_ITEM_QUANTITY_DECREASE"
	RoleForCreationPermissionsLINEITEMQUANTITYINCREASE              RoleForCreationPermissions = "LINE_ITEM_QUANTITY_INCREASE"
	RoleForCreationPermissionsLINKEDSERVICEJOBSREAD                 RoleForCreationPermissions = "LINKED_SERVICE_JOBS_READ"
	RoleForCreationPermissionsLINKEDSERVICEJOBSWRITE                RoleForCreationPermissions = "LINKED_SERVICE_JOBS_WRITE"
	RoleForCreationPermissionsLISTINGDELETE                         RoleForCreationPermissions = "LISTING_DELETE"
	RoleForCreationPermissionsLISTINGREAD                           RoleForCreationPermissions = "LISTING_READ"
	RoleForCreationPermissionsLISTINGWRITE                          RoleForCreationPermissions = "LISTING_WRITE"
	RoleForCreationPermissionsLOADUNITREAD                          RoleForCreationPermissions = "LOADUNIT_READ"
	RoleForCreationPermissionsLOADUNITTYPEREAD                      RoleForCreationPermissions = "LOADUNITTYPE_READ"
	RoleForCreationPermissionsLOADUNITTYPEWRITE                     RoleForCreationPermissions = "LOADUNITTYPE_WRITE"
	RoleForCreationPermissionsLOADUNITWRITE                         RoleForCreationPermissions = "LOADUNIT_WRITE"
	RoleForCreationPermissionsLOCALEWRITE                           RoleForCreationPermissions = "LOCALE_WRITE"
	RoleForCreationPermissionsLOOKUPRECORDREAD                      RoleForCreationPermissions = "LOOKUP_RECORD_READ"
	RoleForCreationPermissionsLOOKUPRECORDWRITE                     RoleForCreationPermissions = "LOOKUP_RECORD_WRITE"
	RoleForCreationPermissionsMEASUREMENTUNITREAD                   RoleForCreationPermissions = "MEASUREMENTUNIT_READ"
	RoleForCreationPermissionsMEASUREMENTUNITWRITE                  RoleForCreationPermissions = "MEASUREMENTUNIT_WRITE"
	RoleForCreationPermissionsNOTIFICATIONCENTERCONFIGREAD          RoleForCreationPermissions = "NOTIFICATION_CENTER_CONFIG_READ"
	RoleForCreationPermissionsNOTIFICATIONCENTERCONFIGWRITE         RoleForCreationPermissions = "NOTIFICATION_CENTER_CONFIG_WRITE"
	RoleForCreationPermissionsNOTIFICATIONREAD                      RoleForCreationPermissions = "NOTIFICATION_READ"
	RoleForCreationPermissionsNOTIFICATIONWRITE                     RoleForCreationPermissions = "NOTIFICATION_WRITE"
	RoleForCreationPermissionsOIDCPROVIDERSCONFIGREAD               RoleForCreationPermissions = "OIDC_PROVIDERS_CONFIG_READ"
	RoleForCreationPermissionsOIDCPROVIDERSCONFIGWRITE              RoleForCreationPermissions = "OIDC_PROVIDERS_CONFIG_WRITE"
	RoleForCreationPermissionsOPERATIONSTATISTICSREAD               RoleForCreationPermissions = "OPERATION_STATISTICS_READ"
	RoleForCreationPermissionsOPERATIVEPROCESSREAD                  RoleForCreationPermissions = "OPERATIVE_PROCESS_READ"
	RoleForCreationPermissionsOPERATIVEPROCESSWRITE                 RoleForCreationPermissions = "OPERATIVE_PROCESS_WRITE"
	RoleForCreationPermissionsORDERCANCEL                           RoleForCreationPermissions = "ORDER_CANCEL"
	RoleForCreationPermissionsORDERCONSUMERWRITE                    RoleForCreationPermissions = "ORDER_CONSUMER_WRITE"
	RoleForCreationPermissionsORDERCUSTOMATTRIBUTESWRITE            RoleForCreationPermissions = "ORDER_CUSTOM_ATTRIBUTES_WRITE"
	RoleForCreationPermissionsORDERDELIVERYPROMISEWRITE             RoleForCreationPermissions = "ORDER_DELIVERY_PROMISE_WRITE"
	RoleForCreationPermissionsORDERFORCECANCEL                      RoleForCreationPermissions = "ORDER_FORCE_CANCEL"
	RoleForCreationPermissionsORDERLINEITEMWRITE                    RoleForCreationPermissions = "ORDER_LINEITEM_WRITE"
	RoleForCreationPermissionsORDERREAD                             RoleForCreationPermissions = "ORDER_READ"
	RoleForCreationPermissionsORDERRECORDREAD                       RoleForCreationPermissions = "ORDER_RECORD_READ"
	RoleForCreationPermissionsORDERRECORDWRITE                      RoleForCreationPermissions = "ORDER_RECORD_WRITE"
	RoleForCreationPermissionsORDERTOTALREAD                        RoleForCreationPermissions = "ORDER_TOTAL_READ"
	RoleForCreationPermissionsORDERUNLOCK                           RoleForCreationPermissions = "ORDER_UNLOCK"
	RoleForCreationPermissionsORDERWRITE                            RoleForCreationPermissions = "ORDER_WRITE"
	RoleForCreationPermissionsPACKAGINGUNITSREAD                    RoleForCreationPermissions = "PACKAGING_UNITS_READ"
	RoleForCreationPermissionsPACKAGINGUNITSWRITE                   RoleForCreationPermissions = "PACKAGING_UNITS_WRITE"
	RoleForCreationPermissionsPACKINGCONTAINERTYPEWRITE             RoleForCreationPermissions = "PACKINGCONTAINER_TYPE_WRITE"
	RoleForCreationPermissionsPACKINGSOURCECONTAINERREAD            RoleForCreationPermissions = "PACKING_SOURCE_CONTAINER_READ"
	RoleForCreationPermissionsPACKINGSOURCECONTAINERWRITE           RoleForCreationPermissions = "PACKING_SOURCE_CONTAINER_WRITE"
	RoleForCreationPermissionsPACKJOBREAD                           RoleForCreationPermissions = "PACKJOB_READ"
	RoleForCreationPermissionsPACKJOBWRITE                          RoleForCreationPermissions = "PACKJOB_WRITE"
	RoleForCreationPermissionsPARCELREAD                            RoleForCreationPermissions = "PARCEL_READ"
	RoleForCreationPermissionsPARCELWRITE                           RoleForCreationPermissions = "PARCEL_WRITE"
	RoleForCreationPermissionsPERMISSIONREAD                        RoleForCreationPermissions = "PERMISSION_READ"
	RoleForCreationPermissionsPICKJOBREAD                           RoleForCreationPermissions = "PICKJOB_READ"
	RoleForCreationPermissionsPICKJOBREROUTE                        RoleForCreationPermissions = "PICKJOB_REROUTE"
	RoleForCreationPermissionsPICKJOBWRITE                          RoleForCreationPermissions = "PICKJOB_WRITE"
	RoleForCreationPermissionsPICKRUNREAD                           RoleForCreationPermissions = "PICKRUN_READ"
	RoleForCreationPermissionsPICKRUNWRITE                          RoleForCreationPermissions = "PICKRUN_WRITE"
	RoleForCreationPermissionsPICKUPSERVICEREAD                     RoleForCreationPermissions = "PICKUP_SERVICE_READ"
	RoleForCreationPermissionsPICKUPSERVICEWRITE                    RoleForCreationPermissions = "PICKUP_SERVICE_WRITE"
	RoleForCreationPermissionsPROCESSLOGREAD                        RoleForCreationPermissions = "PROCESS_LOG_READ"
	RoleForCreationPermissionsPROCESSREAD                           RoleForCreationPermissions = "PROCESS_READ"
	RoleForCreationPermissionsPROCESSREROUTE                        RoleForCreationPermissions = "PROCESS_REROUTE"
	RoleForCreationPermissionsPROCESSWRITE                          RoleForCreationPermissions = "PROCESS_WRITE"
	RoleForCreationPermissionsPROMISESCONFIGREAD                    RoleForCreationPermissions = "PROMISES_CONFIG_READ"
	RoleForCreationPermissionsPROMISESCONFIGWRITE                   RoleForCreationPermissions = "PROMISES_CONFIG_WRITE"
	RoleForCreationPermissionsPURCHASEPRICEREAD                     RoleForCreationPermissions = "PURCHASE_PRICE_READ"
	RoleForCreationPermissionsREMOTECONFIGREAD                      RoleForCreationPermissions = "REMOTE_CONFIG_READ"
	RoleForCreationPermissionsREMOTECONFIGWRITE                     RoleForCreationPermissions = "REMOTE_CONFIG_WRITE"
	RoleForCreationPermissionsRESERVATIONREAD                       RoleForCreationPermissions = "RESERVATION_READ"
	RoleForCreationPermissionsRESERVATIONWRITE                      RoleForCreationPermissions = "RESERVATION_WRITE"
	RoleForCreationPermissionsRESTOWITEMREAD                        RoleForCreationPermissions = "RESTOW_ITEM_READ"
	RoleForCreationPermissionsRESTOWITEMWRITE                       RoleForCreationPermissions = "RESTOW_ITEM_WRITE"
	RoleForCreationPermissionsRETURNREAD                            RoleForCreationPermissions = "RETURN_READ"
	RoleForCreationPermissionsRETURNWRITE                           RoleForCreationPermissions = "RETURN_WRITE"
	RoleForCreationPermissionsROLEREAD                              RoleForCreationPermissions = "ROLE_READ"
	RoleForCreationPermissionsROLEWRITE                             RoleForCreationPermissions = "ROLE_WRITE"
	RoleForCreationPermissionsROUTINGCONFIGREAD                     RoleForCreationPermissions = "ROUTING_CONFIG_READ"
	RoleForCreationPermissionsROUTINGCONFIGWRITE                    RoleForCreationPermissions = "ROUTING_CONFIG_WRITE"
	RoleForCreationPermissionsROUTINGREAD                           RoleForCreationPermissions = "ROUTING_READ"
	RoleForCreationPermissionsROUTINGWRITE                          RoleForCreationPermissions = "ROUTING_WRITE"
	RoleForCreationPermissionsSAFETYSTOCKREAD                       RoleForCreationPermissions = "SAFETY_STOCK_READ"
	RoleForCreationPermissionsSAFETYSTOCKWRITE                      RoleForCreationPermissions = "SAFETY_STOCK_WRITE"
	RoleForCreationPermissionsSERVICEJOBREAD                        RoleForCreationPermissions = "SERVICE_JOB_READ"
	RoleForCreationPermissionsSERVICEJOBWRITE                       RoleForCreationPermissions = "SERVICE_JOB_WRITE"
	RoleForCreationPermissionsSHIPMENTREAD                          RoleForCreationPermissions = "SHIPMENT_READ"
	RoleForCreationPermissionsSHIPMENTWRITE                         RoleForCreationPermissions = "SHIPMENT_WRITE"
	RoleForCreationPermissionsSIMULATIONORDERREAD                   RoleForCreationPermissions = "SIMULATION_ORDER_READ"
	RoleForCreationPermissionsSIMULATIONORDERWRITE                  RoleForCreationPermissions = "SIMULATION_ORDER_WRITE"
	RoleForCreationPermissionsSTACKSREAD                            RoleForCreationPermissions = "STACKS_READ"
	RoleForCreationPermissionsSTACKSWRITE                           RoleForCreationPermissions = "STACKS_WRITE"
	RoleForCreationPermissionsSTOCKAVAILABILITIESREAD               RoleForCreationPermissions = "STOCK_AVAILABILITIES_READ"
	RoleForCreationPermissionsSTOCKREAD                             RoleForCreationPermissions = "STOCK_READ"
	RoleForCreationPermissionsSTOCKWRITE                            RoleForCreationPermissions = "STOCK_WRITE"
	RoleForCreationPermissionsSTORAGELOCATIONREAD                   RoleForCreationPermissions = "STORAGE_LOCATION_READ"
	RoleForCreationPermissionsSTORAGELOCATIONWRITE                  RoleForCreationPermissions = "STORAGE_LOCATION_WRITE"
	RoleForCreationPermissionsSTOWJOBFULLWRITE                      RoleForCreationPermissions = "STOW_JOB_FULL_WRITE"
	RoleForCreationPermissionsSTOWJOBOPERATIVEWRITE                 RoleForCreationPermissions = "STOW_JOB_OPERATIVE_WRITE"
	RoleForCreationPermissionsSTOWJOBREAD                           RoleForCreationPermissions = "STOW_JOB_READ"
	RoleForCreationPermissionsSUBSCRIPTIONREAD                      RoleForCreationPermissions = "SUBSCRIPTION_READ"
	RoleForCreationPermissionsSUBSCRIPTIONWRITE                     RoleForCreationPermissions = "SUBSCRIPTION_WRITE"
	RoleForCreationPermissionsSUBSTITUTEREAD                        RoleForCreationPermissions = "SUBSTITUTE_READ"
	RoleForCreationPermissionsSUBSTITUTEWRITE                       RoleForCreationPermissions = "SUBSTITUTE_WRITE"
	RoleForCreationPermissionsTAGREAD                               RoleForCreationPermissions = "TAG_READ"
	RoleForCreationPermissionsTAGWRITE                              RoleForCreationPermissions = "TAG_WRITE"
	RoleForCreationPermissionsTENANTCONNECTORCONFIGREAD             RoleForCreationPermissions = "TENANT_CONNECTOR_CONFIG_READ"
	RoleForCreationPermissionsUSERMODIFY                            RoleForCreationPermissions = "USER_MODIFY"
	RoleForCreationPermissionsUSERREAD                              RoleForCreationPermissions = "USER_READ"
	RoleForCreationPermissionsUSERSREAD                             RoleForCreationPermissions = "USERS_READ"
	RoleForCreationPermissionsUSERWRITE                             RoleForCreationPermissions = "USER_WRITE"
	RoleForCreationPermissionsVALIDATIONSREAD                       RoleForCreationPermissions = "VALIDATIONS_READ"
	RoleForCreationPermissionsWORKFLOWDEFINITIONREAD                RoleForCreationPermissions = "WORKFLOW_DEFINITION_READ"
	RoleForCreationPermissionsWORKFLOWDEFINITIONWRITE               RoleForCreationPermissions = "WORKFLOW_DEFINITION_WRITE"
	RoleForCreationPermissionsZONEREAD                              RoleForCreationPermissions = "ZONE_READ"
	RoleForCreationPermissionsZONEWRITE                             RoleForCreationPermissions = "ZONE_WRITE"
)

Defines values for RoleForCreationPermissions.

func (RoleForCreationPermissions) Valid

func (e RoleForCreationPermissions) Valid() bool

Valid indicates whether the value is a known member of the RoleForCreationPermissions enum.

type RoleForPatch

type RoleForPatch struct {
	// Context An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.
	Context *[]ContextLimitation `json:"context,omitempty"`

	// ContextLimitations Deprecated: Use context instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ContextLimitations *[]ContextLimitation `json:"contextLimitations,omitempty"`

	// Contexts Deprecated: Use context instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Contexts *[]ContextLimitation `json:"contexts,omitempty"`

	// CustomAttributes The custom attributes of the role, which can be used to store additional information.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Description The description of the role, which provides more details about its purpose.
	Description *string `json:"description,omitempty"`

	// DisplayName The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
	DisplayName *string `json:"displayName,omitempty"`

	// Name The name of the role, which must be unique and is used to identify the role.
	Name string `json:"name"`

	// Permissions The permissions associated with the role, which define what actions the role can perform.
	Permissions *[]RoleForPatchPermissions `json:"permissions,omitempty"`

	// Version The version of the role.
	//
	// Example: 1
	Version float32 `json:"version"`
}

RoleForPatch RoleForPatch

type RoleForPatchPermissions

type RoleForPatchPermissions string

RoleForPatchPermissions defines model for RoleForPatch.Permissions.

const (
	RoleForPatchPermissionsADMINDATARESET                        RoleForPatchPermissions = "ADMIN_DATA_RESET"
	RoleForPatchPermissionsADMININTERFACILITYCONNECTIONMIGRATION RoleForPatchPermissions = "ADMIN_INTER_FACILITY_CONNECTION_MIGRATION"
	RoleForPatchPermissionsADMINMODULESREAD                      RoleForPatchPermissions = "ADMIN_MODULES_READ"
	RoleForPatchPermissionsADMINMODULESWRITE                     RoleForPatchPermissions = "ADMIN_MODULES_WRITE"
	RoleForPatchPermissionsADMINROUTINGPLANANALYSIS              RoleForPatchPermissions = "ADMIN_ROUTING_PLAN_ANALYSIS"
	RoleForPatchPermissionsAIASSISTANTACCESS                     RoleForPatchPermissions = "AI_ASSISTANT_ACCESS"
	RoleForPatchPermissionsANALYTICSDASHBOARDREAD                RoleForPatchPermissions = "ANALYTICS_DASHBOARD_READ"
	RoleForPatchPermissionsAUDITREAD                             RoleForPatchPermissions = "AUDIT_READ"
	RoleForPatchPermissionsAVAILABILITYCHANNELREAD               RoleForPatchPermissions = "AVAILABILITY_CHANNEL_READ"
	RoleForPatchPermissionsAVAILABILITYCHANNELWRITE              RoleForPatchPermissions = "AVAILABILITY_CHANNEL_WRITE"
	RoleForPatchPermissionsAVAILABILITYTHRESHOLDSREAD            RoleForPatchPermissions = "AVAILABILITY_THRESHOLDS_READ"
	RoleForPatchPermissionsAVAILABILITYTHRESHOLDSWRITE           RoleForPatchPermissions = "AVAILABILITY_THRESHOLDS_WRITE"
	RoleForPatchPermissionsBRANDREAD                             RoleForPatchPermissions = "BRAND_READ"
	RoleForPatchPermissionsCARRIERREAD                           RoleForPatchPermissions = "CARRIER_READ"
	RoleForPatchPermissionsCARRIERWRITE                          RoleForPatchPermissions = "CARRIER_WRITE"
	RoleForPatchPermissionsCATEGORYREAD                          RoleForPatchPermissions = "CATEGORY_READ"
	RoleForPatchPermissionsCATEGORYWRITE                         RoleForPatchPermissions = "CATEGORY_WRITE"
	RoleForPatchPermissionsCONFIGREAD                            RoleForPatchPermissions = "CONFIG_READ"
	RoleForPatchPermissionsCONFIGWRITE                           RoleForPatchPermissions = "CONFIG_WRITE"
	RoleForPatchPermissionsCURRENTUSERMODIFY                     RoleForPatchPermissions = "CURRENT_USER_MODIFY"
	RoleForPatchPermissionsCURRENTUSERREAD                       RoleForPatchPermissions = "CURRENT_USER_READ"
	RoleForPatchPermissionsCUSTOMSERVICEREAD                     RoleForPatchPermissions = "CUSTOM_SERVICE_READ"
	RoleForPatchPermissionsCUSTOMSERVICEWRITE                    RoleForPatchPermissions = "CUSTOM_SERVICE_WRITE"
	RoleForPatchPermissionsDELIVERYNOTEWRITE                     RoleForPatchPermissions = "DELIVERYNOTE_WRITE"
	RoleForPatchPermissionsDOCUMENTSETREAD                       RoleForPatchPermissions = "DOCUMENT_SET_READ"
	RoleForPatchPermissionsDOCUMENTSETWRITE                      RoleForPatchPermissions = "DOCUMENT_SET_WRITE"
	RoleForPatchPermissionsDOMSSTATISTICSREAD                    RoleForPatchPermissions = "DOMS_STATISTICS_READ"
	RoleForPatchPermissionsDOMSTOOLKITREAD                       RoleForPatchPermissions = "DOMS_TOOLKIT_READ"
	RoleForPatchPermissionsDOMSTOOLKITWRITE                      RoleForPatchPermissions = "DOMS_TOOLKIT_WRITE"
	RoleForPatchPermissionsEVENTREAD                             RoleForPatchPermissions = "EVENT_READ"
	RoleForPatchPermissionsEXPIRIESREAD                          RoleForPatchPermissions = "EXPIRIES_READ"
	RoleForPatchPermissionsEXPIRIESWRITE                         RoleForPatchPermissions = "EXPIRIES_WRITE"
	RoleForPatchPermissionsEXPORTREAD                            RoleForPatchPermissions = "EXPORT_READ"
	RoleForPatchPermissionsEXPORTWRITE                           RoleForPatchPermissions = "EXPORT_WRITE"
	RoleForPatchPermissionsEXTERNALACTIONSREAD                   RoleForPatchPermissions = "EXTERNAL_ACTIONS_READ"
	RoleForPatchPermissionsEXTERNALACTIONSWRITE                  RoleForPatchPermissions = "EXTERNAL_ACTIONS_WRITE"
	RoleForPatchPermissionsEXTERNALSTOCKCHANGEREASONSREAD        RoleForPatchPermissions = "EXTERNAL_STOCK_CHANGE_REASONS_READ"
	RoleForPatchPermissionsEXTERNALSTOCKCHANGEREASONSWRITE       RoleForPatchPermissions = "EXTERNAL_STOCK_CHANGE_REASONS_WRITE"
	RoleForPatchPermissionsFACILITYCREATE                        RoleForPatchPermissions = "FACILITY_CREATE"
	RoleForPatchPermissionsFACILITYDELETE                        RoleForPatchPermissions = "FACILITY_DELETE"
	RoleForPatchPermissionsFACILITYGROUPREAD                     RoleForPatchPermissions = "FACILITY_GROUP_READ"
	RoleForPatchPermissionsFACILITYGROUPWRITE                    RoleForPatchPermissions = "FACILITY_GROUP_WRITE"
	RoleForPatchPermissionsFACILITYREAD                          RoleForPatchPermissions = "FACILITY_READ"
	RoleForPatchPermissionsFACILITYWRITE                         RoleForPatchPermissions = "FACILITY_WRITE"
	RoleForPatchPermissionsFILTERENTITYREAD                      RoleForPatchPermissions = "FILTER_ENTITY_READ"
	RoleForPatchPermissionsHANDOVERCONTAINERREAD                 RoleForPatchPermissions = "HANDOVER_CONTAINER_READ"
	RoleForPatchPermissionsHANDOVERCONTAINERWRITE                RoleForPatchPermissions = "HANDOVER_CONTAINER_WRITE"
	RoleForPatchPermissionsHANDOVERJOBREAD                       RoleForPatchPermissions = "HANDOVERJOB_READ"
	RoleForPatchPermissionsHANDOVERJOBWRITE                      RoleForPatchPermissions = "HANDOVERJOB_WRITE"
	RoleForPatchPermissionsINBOUNDPROCESSREAD                    RoleForPatchPermissions = "INBOUND_PROCESS_READ"
	RoleForPatchPermissionsINBOUNDPROCESSWRITE                   RoleForPatchPermissions = "INBOUND_PROCESS_WRITE"
	RoleForPatchPermissionsKPIREAD                               RoleForPatchPermissions = "KPI_READ"
	RoleForPatchPermissionsLINEITEMADD                           RoleForPatchPermissions = "LINE_ITEM_ADD"
	RoleForPatchPermissionsLINEITEMDELETE                        RoleForPatchPermissions = "LINE_ITEM_DELETE"
	RoleForPatchPermissionsLINEITEMPRICINGREAD                   RoleForPatchPermissions = "LINE_ITEM_PRICING_READ"
	RoleForPatchPermissionsLINEITEMQUANTITYDECREASE              RoleForPatchPermissions = "LINE_ITEM_QUANTITY_DECREASE"
	RoleForPatchPermissionsLINEITEMQUANTITYINCREASE              RoleForPatchPermissions = "LINE_ITEM_QUANTITY_INCREASE"
	RoleForPatchPermissionsLINKEDSERVICEJOBSREAD                 RoleForPatchPermissions = "LINKED_SERVICE_JOBS_READ"
	RoleForPatchPermissionsLINKEDSERVICEJOBSWRITE                RoleForPatchPermissions = "LINKED_SERVICE_JOBS_WRITE"
	RoleForPatchPermissionsLISTINGDELETE                         RoleForPatchPermissions = "LISTING_DELETE"
	RoleForPatchPermissionsLISTINGREAD                           RoleForPatchPermissions = "LISTING_READ"
	RoleForPatchPermissionsLISTINGWRITE                          RoleForPatchPermissions = "LISTING_WRITE"
	RoleForPatchPermissionsLOADUNITREAD                          RoleForPatchPermissions = "LOADUNIT_READ"
	RoleForPatchPermissionsLOADUNITTYPEREAD                      RoleForPatchPermissions = "LOADUNITTYPE_READ"
	RoleForPatchPermissionsLOADUNITTYPEWRITE                     RoleForPatchPermissions = "LOADUNITTYPE_WRITE"
	RoleForPatchPermissionsLOADUNITWRITE                         RoleForPatchPermissions = "LOADUNIT_WRITE"
	RoleForPatchPermissionsLOCALEWRITE                           RoleForPatchPermissions = "LOCALE_WRITE"
	RoleForPatchPermissionsLOOKUPRECORDREAD                      RoleForPatchPermissions = "LOOKUP_RECORD_READ"
	RoleForPatchPermissionsLOOKUPRECORDWRITE                     RoleForPatchPermissions = "LOOKUP_RECORD_WRITE"
	RoleForPatchPermissionsMEASUREMENTUNITREAD                   RoleForPatchPermissions = "MEASUREMENTUNIT_READ"
	RoleForPatchPermissionsMEASUREMENTUNITWRITE                  RoleForPatchPermissions = "MEASUREMENTUNIT_WRITE"
	RoleForPatchPermissionsNOTIFICATIONCENTERCONFIGREAD          RoleForPatchPermissions = "NOTIFICATION_CENTER_CONFIG_READ"
	RoleForPatchPermissionsNOTIFICATIONCENTERCONFIGWRITE         RoleForPatchPermissions = "NOTIFICATION_CENTER_CONFIG_WRITE"
	RoleForPatchPermissionsNOTIFICATIONREAD                      RoleForPatchPermissions = "NOTIFICATION_READ"
	RoleForPatchPermissionsNOTIFICATIONWRITE                     RoleForPatchPermissions = "NOTIFICATION_WRITE"
	RoleForPatchPermissionsOIDCPROVIDERSCONFIGREAD               RoleForPatchPermissions = "OIDC_PROVIDERS_CONFIG_READ"
	RoleForPatchPermissionsOIDCPROVIDERSCONFIGWRITE              RoleForPatchPermissions = "OIDC_PROVIDERS_CONFIG_WRITE"
	RoleForPatchPermissionsOPERATIONSTATISTICSREAD               RoleForPatchPermissions = "OPERATION_STATISTICS_READ"
	RoleForPatchPermissionsOPERATIVEPROCESSREAD                  RoleForPatchPermissions = "OPERATIVE_PROCESS_READ"
	RoleForPatchPermissionsOPERATIVEPROCESSWRITE                 RoleForPatchPermissions = "OPERATIVE_PROCESS_WRITE"
	RoleForPatchPermissionsORDERCANCEL                           RoleForPatchPermissions = "ORDER_CANCEL"
	RoleForPatchPermissionsORDERCONSUMERWRITE                    RoleForPatchPermissions = "ORDER_CONSUMER_WRITE"
	RoleForPatchPermissionsORDERCUSTOMATTRIBUTESWRITE            RoleForPatchPermissions = "ORDER_CUSTOM_ATTRIBUTES_WRITE"
	RoleForPatchPermissionsORDERDELIVERYPROMISEWRITE             RoleForPatchPermissions = "ORDER_DELIVERY_PROMISE_WRITE"
	RoleForPatchPermissionsORDERFORCECANCEL                      RoleForPatchPermissions = "ORDER_FORCE_CANCEL"
	RoleForPatchPermissionsORDERLINEITEMWRITE                    RoleForPatchPermissions = "ORDER_LINEITEM_WRITE"
	RoleForPatchPermissionsORDERREAD                             RoleForPatchPermissions = "ORDER_READ"
	RoleForPatchPermissionsORDERRECORDREAD                       RoleForPatchPermissions = "ORDER_RECORD_READ"
	RoleForPatchPermissionsORDERRECORDWRITE                      RoleForPatchPermissions = "ORDER_RECORD_WRITE"
	RoleForPatchPermissionsORDERTOTALREAD                        RoleForPatchPermissions = "ORDER_TOTAL_READ"
	RoleForPatchPermissionsORDERUNLOCK                           RoleForPatchPermissions = "ORDER_UNLOCK"
	RoleForPatchPermissionsORDERWRITE                            RoleForPatchPermissions = "ORDER_WRITE"
	RoleForPatchPermissionsPACKAGINGUNITSREAD                    RoleForPatchPermissions = "PACKAGING_UNITS_READ"
	RoleForPatchPermissionsPACKAGINGUNITSWRITE                   RoleForPatchPermissions = "PACKAGING_UNITS_WRITE"
	RoleForPatchPermissionsPACKINGCONTAINERTYPEWRITE             RoleForPatchPermissions = "PACKINGCONTAINER_TYPE_WRITE"
	RoleForPatchPermissionsPACKINGSOURCECONTAINERREAD            RoleForPatchPermissions = "PACKING_SOURCE_CONTAINER_READ"
	RoleForPatchPermissionsPACKINGSOURCECONTAINERWRITE           RoleForPatchPermissions = "PACKING_SOURCE_CONTAINER_WRITE"
	RoleForPatchPermissionsPACKJOBREAD                           RoleForPatchPermissions = "PACKJOB_READ"
	RoleForPatchPermissionsPACKJOBWRITE                          RoleForPatchPermissions = "PACKJOB_WRITE"
	RoleForPatchPermissionsPARCELREAD                            RoleForPatchPermissions = "PARCEL_READ"
	RoleForPatchPermissionsPARCELWRITE                           RoleForPatchPermissions = "PARCEL_WRITE"
	RoleForPatchPermissionsPERMISSIONREAD                        RoleForPatchPermissions = "PERMISSION_READ"
	RoleForPatchPermissionsPICKJOBREAD                           RoleForPatchPermissions = "PICKJOB_READ"
	RoleForPatchPermissionsPICKJOBREROUTE                        RoleForPatchPermissions = "PICKJOB_REROUTE"
	RoleForPatchPermissionsPICKJOBWRITE                          RoleForPatchPermissions = "PICKJOB_WRITE"
	RoleForPatchPermissionsPICKRUNREAD                           RoleForPatchPermissions = "PICKRUN_READ"
	RoleForPatchPermissionsPICKRUNWRITE                          RoleForPatchPermissions = "PICKRUN_WRITE"
	RoleForPatchPermissionsPICKUPSERVICEREAD                     RoleForPatchPermissions = "PICKUP_SERVICE_READ"
	RoleForPatchPermissionsPICKUPSERVICEWRITE                    RoleForPatchPermissions = "PICKUP_SERVICE_WRITE"
	RoleForPatchPermissionsPROCESSLOGREAD                        RoleForPatchPermissions = "PROCESS_LOG_READ"
	RoleForPatchPermissionsPROCESSREAD                           RoleForPatchPermissions = "PROCESS_READ"
	RoleForPatchPermissionsPROCESSREROUTE                        RoleForPatchPermissions = "PROCESS_REROUTE"
	RoleForPatchPermissionsPROCESSWRITE                          RoleForPatchPermissions = "PROCESS_WRITE"
	RoleForPatchPermissionsPROMISESCONFIGREAD                    RoleForPatchPermissions = "PROMISES_CONFIG_READ"
	RoleForPatchPermissionsPROMISESCONFIGWRITE                   RoleForPatchPermissions = "PROMISES_CONFIG_WRITE"
	RoleForPatchPermissionsPURCHASEPRICEREAD                     RoleForPatchPermissions = "PURCHASE_PRICE_READ"
	RoleForPatchPermissionsREMOTECONFIGREAD                      RoleForPatchPermissions = "REMOTE_CONFIG_READ"
	RoleForPatchPermissionsREMOTECONFIGWRITE                     RoleForPatchPermissions = "REMOTE_CONFIG_WRITE"
	RoleForPatchPermissionsRESERVATIONREAD                       RoleForPatchPermissions = "RESERVATION_READ"
	RoleForPatchPermissionsRESERVATIONWRITE                      RoleForPatchPermissions = "RESERVATION_WRITE"
	RoleForPatchPermissionsRESTOWITEMREAD                        RoleForPatchPermissions = "RESTOW_ITEM_READ"
	RoleForPatchPermissionsRESTOWITEMWRITE                       RoleForPatchPermissions = "RESTOW_ITEM_WRITE"
	RoleForPatchPermissionsRETURNREAD                            RoleForPatchPermissions = "RETURN_READ"
	RoleForPatchPermissionsRETURNWRITE                           RoleForPatchPermissions = "RETURN_WRITE"
	RoleForPatchPermissionsROLEREAD                              RoleForPatchPermissions = "ROLE_READ"
	RoleForPatchPermissionsROLEWRITE                             RoleForPatchPermissions = "ROLE_WRITE"
	RoleForPatchPermissionsROUTINGCONFIGREAD                     RoleForPatchPermissions = "ROUTING_CONFIG_READ"
	RoleForPatchPermissionsROUTINGCONFIGWRITE                    RoleForPatchPermissions = "ROUTING_CONFIG_WRITE"
	RoleForPatchPermissionsROUTINGREAD                           RoleForPatchPermissions = "ROUTING_READ"
	RoleForPatchPermissionsROUTINGWRITE                          RoleForPatchPermissions = "ROUTING_WRITE"
	RoleForPatchPermissionsSAFETYSTOCKREAD                       RoleForPatchPermissions = "SAFETY_STOCK_READ"
	RoleForPatchPermissionsSAFETYSTOCKWRITE                      RoleForPatchPermissions = "SAFETY_STOCK_WRITE"
	RoleForPatchPermissionsSERVICEJOBREAD                        RoleForPatchPermissions = "SERVICE_JOB_READ"
	RoleForPatchPermissionsSERVICEJOBWRITE                       RoleForPatchPermissions = "SERVICE_JOB_WRITE"
	RoleForPatchPermissionsSHIPMENTREAD                          RoleForPatchPermissions = "SHIPMENT_READ"
	RoleForPatchPermissionsSHIPMENTWRITE                         RoleForPatchPermissions = "SHIPMENT_WRITE"
	RoleForPatchPermissionsSIMULATIONORDERREAD                   RoleForPatchPermissions = "SIMULATION_ORDER_READ"
	RoleForPatchPermissionsSIMULATIONORDERWRITE                  RoleForPatchPermissions = "SIMULATION_ORDER_WRITE"
	RoleForPatchPermissionsSTACKSREAD                            RoleForPatchPermissions = "STACKS_READ"
	RoleForPatchPermissionsSTACKSWRITE                           RoleForPatchPermissions = "STACKS_WRITE"
	RoleForPatchPermissionsSTOCKAVAILABILITIESREAD               RoleForPatchPermissions = "STOCK_AVAILABILITIES_READ"
	RoleForPatchPermissionsSTOCKREAD                             RoleForPatchPermissions = "STOCK_READ"
	RoleForPatchPermissionsSTOCKWRITE                            RoleForPatchPermissions = "STOCK_WRITE"
	RoleForPatchPermissionsSTORAGELOCATIONREAD                   RoleForPatchPermissions = "STORAGE_LOCATION_READ"
	RoleForPatchPermissionsSTORAGELOCATIONWRITE                  RoleForPatchPermissions = "STORAGE_LOCATION_WRITE"
	RoleForPatchPermissionsSTOWJOBFULLWRITE                      RoleForPatchPermissions = "STOW_JOB_FULL_WRITE"
	RoleForPatchPermissionsSTOWJOBOPERATIVEWRITE                 RoleForPatchPermissions = "STOW_JOB_OPERATIVE_WRITE"
	RoleForPatchPermissionsSTOWJOBREAD                           RoleForPatchPermissions = "STOW_JOB_READ"
	RoleForPatchPermissionsSUBSCRIPTIONREAD                      RoleForPatchPermissions = "SUBSCRIPTION_READ"
	RoleForPatchPermissionsSUBSCRIPTIONWRITE                     RoleForPatchPermissions = "SUBSCRIPTION_WRITE"
	RoleForPatchPermissionsSUBSTITUTEREAD                        RoleForPatchPermissions = "SUBSTITUTE_READ"
	RoleForPatchPermissionsSUBSTITUTEWRITE                       RoleForPatchPermissions = "SUBSTITUTE_WRITE"
	RoleForPatchPermissionsTAGREAD                               RoleForPatchPermissions = "TAG_READ"
	RoleForPatchPermissionsTAGWRITE                              RoleForPatchPermissions = "TAG_WRITE"
	RoleForPatchPermissionsTENANTCONNECTORCONFIGREAD             RoleForPatchPermissions = "TENANT_CONNECTOR_CONFIG_READ"
	RoleForPatchPermissionsUSERMODIFY                            RoleForPatchPermissions = "USER_MODIFY"
	RoleForPatchPermissionsUSERREAD                              RoleForPatchPermissions = "USER_READ"
	RoleForPatchPermissionsUSERSREAD                             RoleForPatchPermissions = "USERS_READ"
	RoleForPatchPermissionsUSERWRITE                             RoleForPatchPermissions = "USER_WRITE"
	RoleForPatchPermissionsVALIDATIONSREAD                       RoleForPatchPermissions = "VALIDATIONS_READ"
	RoleForPatchPermissionsWORKFLOWDEFINITIONREAD                RoleForPatchPermissions = "WORKFLOW_DEFINITION_READ"
	RoleForPatchPermissionsWORKFLOWDEFINITIONWRITE               RoleForPatchPermissions = "WORKFLOW_DEFINITION_WRITE"
	RoleForPatchPermissionsZONEREAD                              RoleForPatchPermissions = "ZONE_READ"
	RoleForPatchPermissionsZONEWRITE                             RoleForPatchPermissions = "ZONE_WRITE"
)

Defines values for RoleForPatchPermissions.

func (RoleForPatchPermissions) Valid

func (e RoleForPatchPermissions) Valid() bool

Valid indicates whether the value is a known member of the RoleForPatchPermissions enum.

type RoleForUpdate

type RoleForUpdate struct {
	// Context An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.
	Context *[]ContextLimitation `json:"context,omitempty"`

	// ContextLimitations Deprecated: Use context instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ContextLimitations *[]ContextLimitation `json:"contextLimitations,omitempty"`

	// Contexts Deprecated: Use context instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Contexts *[]ContextLimitation `json:"contexts,omitempty"`

	// CustomAttributes The custom attributes of the role, which can be used to store additional information.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Description The description of the role, which provides more details about its purpose.
	Description *string `json:"description,omitempty"`

	// DisplayName The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
	DisplayName *string `json:"displayName,omitempty"`

	// Name The name of the role, which must be unique and is used to identify the role.
	Name string `json:"name"`

	// Permissions The permissions associated with the role, which define what actions the role can perform.
	Permissions []RoleForUpdatePermissions `json:"permissions"`

	// Version The version of the role.
	//
	// Example: 1
	Version float32 `json:"version"`
}

RoleForUpdate RoleForUpdate

type RoleForUpdatePermissions

type RoleForUpdatePermissions string

RoleForUpdatePermissions defines model for RoleForUpdate.Permissions.

const (
	RoleForUpdatePermissionsADMINDATARESET                        RoleForUpdatePermissions = "ADMIN_DATA_RESET"
	RoleForUpdatePermissionsADMININTERFACILITYCONNECTIONMIGRATION RoleForUpdatePermissions = "ADMIN_INTER_FACILITY_CONNECTION_MIGRATION"
	RoleForUpdatePermissionsADMINMODULESREAD                      RoleForUpdatePermissions = "ADMIN_MODULES_READ"
	RoleForUpdatePermissionsADMINMODULESWRITE                     RoleForUpdatePermissions = "ADMIN_MODULES_WRITE"
	RoleForUpdatePermissionsADMINROUTINGPLANANALYSIS              RoleForUpdatePermissions = "ADMIN_ROUTING_PLAN_ANALYSIS"
	RoleForUpdatePermissionsAIASSISTANTACCESS                     RoleForUpdatePermissions = "AI_ASSISTANT_ACCESS"
	RoleForUpdatePermissionsANALYTICSDASHBOARDREAD                RoleForUpdatePermissions = "ANALYTICS_DASHBOARD_READ"
	RoleForUpdatePermissionsAUDITREAD                             RoleForUpdatePermissions = "AUDIT_READ"
	RoleForUpdatePermissionsAVAILABILITYCHANNELREAD               RoleForUpdatePermissions = "AVAILABILITY_CHANNEL_READ"
	RoleForUpdatePermissionsAVAILABILITYCHANNELWRITE              RoleForUpdatePermissions = "AVAILABILITY_CHANNEL_WRITE"
	RoleForUpdatePermissionsAVAILABILITYTHRESHOLDSREAD            RoleForUpdatePermissions = "AVAILABILITY_THRESHOLDS_READ"
	RoleForUpdatePermissionsAVAILABILITYTHRESHOLDSWRITE           RoleForUpdatePermissions = "AVAILABILITY_THRESHOLDS_WRITE"
	RoleForUpdatePermissionsBRANDREAD                             RoleForUpdatePermissions = "BRAND_READ"
	RoleForUpdatePermissionsCARRIERREAD                           RoleForUpdatePermissions = "CARRIER_READ"
	RoleForUpdatePermissionsCARRIERWRITE                          RoleForUpdatePermissions = "CARRIER_WRITE"
	RoleForUpdatePermissionsCATEGORYREAD                          RoleForUpdatePermissions = "CATEGORY_READ"
	RoleForUpdatePermissionsCATEGORYWRITE                         RoleForUpdatePermissions = "CATEGORY_WRITE"
	RoleForUpdatePermissionsCONFIGREAD                            RoleForUpdatePermissions = "CONFIG_READ"
	RoleForUpdatePermissionsCONFIGWRITE                           RoleForUpdatePermissions = "CONFIG_WRITE"
	RoleForUpdatePermissionsCURRENTUSERMODIFY                     RoleForUpdatePermissions = "CURRENT_USER_MODIFY"
	RoleForUpdatePermissionsCURRENTUSERREAD                       RoleForUpdatePermissions = "CURRENT_USER_READ"
	RoleForUpdatePermissionsCUSTOMSERVICEREAD                     RoleForUpdatePermissions = "CUSTOM_SERVICE_READ"
	RoleForUpdatePermissionsCUSTOMSERVICEWRITE                    RoleForUpdatePermissions = "CUSTOM_SERVICE_WRITE"
	RoleForUpdatePermissionsDELIVERYNOTEWRITE                     RoleForUpdatePermissions = "DELIVERYNOTE_WRITE"
	RoleForUpdatePermissionsDOCUMENTSETREAD                       RoleForUpdatePermissions = "DOCUMENT_SET_READ"
	RoleForUpdatePermissionsDOCUMENTSETWRITE                      RoleForUpdatePermissions = "DOCUMENT_SET_WRITE"
	RoleForUpdatePermissionsDOMSSTATISTICSREAD                    RoleForUpdatePermissions = "DOMS_STATISTICS_READ"
	RoleForUpdatePermissionsDOMSTOOLKITREAD                       RoleForUpdatePermissions = "DOMS_TOOLKIT_READ"
	RoleForUpdatePermissionsDOMSTOOLKITWRITE                      RoleForUpdatePermissions = "DOMS_TOOLKIT_WRITE"
	RoleForUpdatePermissionsEVENTREAD                             RoleForUpdatePermissions = "EVENT_READ"
	RoleForUpdatePermissionsEXPIRIESREAD                          RoleForUpdatePermissions = "EXPIRIES_READ"
	RoleForUpdatePermissionsEXPIRIESWRITE                         RoleForUpdatePermissions = "EXPIRIES_WRITE"
	RoleForUpdatePermissionsEXPORTREAD                            RoleForUpdatePermissions = "EXPORT_READ"
	RoleForUpdatePermissionsEXPORTWRITE                           RoleForUpdatePermissions = "EXPORT_WRITE"
	RoleForUpdatePermissionsEXTERNALACTIONSREAD                   RoleForUpdatePermissions = "EXTERNAL_ACTIONS_READ"
	RoleForUpdatePermissionsEXTERNALACTIONSWRITE                  RoleForUpdatePermissions = "EXTERNAL_ACTIONS_WRITE"
	RoleForUpdatePermissionsEXTERNALSTOCKCHANGEREASONSREAD        RoleForUpdatePermissions = "EXTERNAL_STOCK_CHANGE_REASONS_READ"
	RoleForUpdatePermissionsEXTERNALSTOCKCHANGEREASONSWRITE       RoleForUpdatePermissions = "EXTERNAL_STOCK_CHANGE_REASONS_WRITE"
	RoleForUpdatePermissionsFACILITYCREATE                        RoleForUpdatePermissions = "FACILITY_CREATE"
	RoleForUpdatePermissionsFACILITYDELETE                        RoleForUpdatePermissions = "FACILITY_DELETE"
	RoleForUpdatePermissionsFACILITYGROUPREAD                     RoleForUpdatePermissions = "FACILITY_GROUP_READ"
	RoleForUpdatePermissionsFACILITYGROUPWRITE                    RoleForUpdatePermissions = "FACILITY_GROUP_WRITE"
	RoleForUpdatePermissionsFACILITYREAD                          RoleForUpdatePermissions = "FACILITY_READ"
	RoleForUpdatePermissionsFACILITYWRITE                         RoleForUpdatePermissions = "FACILITY_WRITE"
	RoleForUpdatePermissionsFILTERENTITYREAD                      RoleForUpdatePermissions = "FILTER_ENTITY_READ"
	RoleForUpdatePermissionsHANDOVERCONTAINERREAD                 RoleForUpdatePermissions = "HANDOVER_CONTAINER_READ"
	RoleForUpdatePermissionsHANDOVERCONTAINERWRITE                RoleForUpdatePermissions = "HANDOVER_CONTAINER_WRITE"
	RoleForUpdatePermissionsHANDOVERJOBREAD                       RoleForUpdatePermissions = "HANDOVERJOB_READ"
	RoleForUpdatePermissionsHANDOVERJOBWRITE                      RoleForUpdatePermissions = "HANDOVERJOB_WRITE"
	RoleForUpdatePermissionsINBOUNDPROCESSREAD                    RoleForUpdatePermissions = "INBOUND_PROCESS_READ"
	RoleForUpdatePermissionsINBOUNDPROCESSWRITE                   RoleForUpdatePermissions = "INBOUND_PROCESS_WRITE"
	RoleForUpdatePermissionsKPIREAD                               RoleForUpdatePermissions = "KPI_READ"
	RoleForUpdatePermissionsLINEITEMADD                           RoleForUpdatePermissions = "LINE_ITEM_ADD"
	RoleForUpdatePermissionsLINEITEMDELETE                        RoleForUpdatePermissions = "LINE_ITEM_DELETE"
	RoleForUpdatePermissionsLINEITEMPRICINGREAD                   RoleForUpdatePermissions = "LINE_ITEM_PRICING_READ"
	RoleForUpdatePermissionsLINEITEMQUANTITYDECREASE              RoleForUpdatePermissions = "LINE_ITEM_QUANTITY_DECREASE"
	RoleForUpdatePermissionsLINEITEMQUANTITYINCREASE              RoleForUpdatePermissions = "LINE_ITEM_QUANTITY_INCREASE"
	RoleForUpdatePermissionsLINKEDSERVICEJOBSREAD                 RoleForUpdatePermissions = "LINKED_SERVICE_JOBS_READ"
	RoleForUpdatePermissionsLINKEDSERVICEJOBSWRITE                RoleForUpdatePermissions = "LINKED_SERVICE_JOBS_WRITE"
	RoleForUpdatePermissionsLISTINGDELETE                         RoleForUpdatePermissions = "LISTING_DELETE"
	RoleForUpdatePermissionsLISTINGREAD                           RoleForUpdatePermissions = "LISTING_READ"
	RoleForUpdatePermissionsLISTINGWRITE                          RoleForUpdatePermissions = "LISTING_WRITE"
	RoleForUpdatePermissionsLOADUNITREAD                          RoleForUpdatePermissions = "LOADUNIT_READ"
	RoleForUpdatePermissionsLOADUNITTYPEREAD                      RoleForUpdatePermissions = "LOADUNITTYPE_READ"
	RoleForUpdatePermissionsLOADUNITTYPEWRITE                     RoleForUpdatePermissions = "LOADUNITTYPE_WRITE"
	RoleForUpdatePermissionsLOADUNITWRITE                         RoleForUpdatePermissions = "LOADUNIT_WRITE"
	RoleForUpdatePermissionsLOCALEWRITE                           RoleForUpdatePermissions = "LOCALE_WRITE"
	RoleForUpdatePermissionsLOOKUPRECORDREAD                      RoleForUpdatePermissions = "LOOKUP_RECORD_READ"
	RoleForUpdatePermissionsLOOKUPRECORDWRITE                     RoleForUpdatePermissions = "LOOKUP_RECORD_WRITE"
	RoleForUpdatePermissionsMEASUREMENTUNITREAD                   RoleForUpdatePermissions = "MEASUREMENTUNIT_READ"
	RoleForUpdatePermissionsMEASUREMENTUNITWRITE                  RoleForUpdatePermissions = "MEASUREMENTUNIT_WRITE"
	RoleForUpdatePermissionsNOTIFICATIONCENTERCONFIGREAD          RoleForUpdatePermissions = "NOTIFICATION_CENTER_CONFIG_READ"
	RoleForUpdatePermissionsNOTIFICATIONCENTERCONFIGWRITE         RoleForUpdatePermissions = "NOTIFICATION_CENTER_CONFIG_WRITE"
	RoleForUpdatePermissionsNOTIFICATIONREAD                      RoleForUpdatePermissions = "NOTIFICATION_READ"
	RoleForUpdatePermissionsNOTIFICATIONWRITE                     RoleForUpdatePermissions = "NOTIFICATION_WRITE"
	RoleForUpdatePermissionsOIDCPROVIDERSCONFIGREAD               RoleForUpdatePermissions = "OIDC_PROVIDERS_CONFIG_READ"
	RoleForUpdatePermissionsOIDCPROVIDERSCONFIGWRITE              RoleForUpdatePermissions = "OIDC_PROVIDERS_CONFIG_WRITE"
	RoleForUpdatePermissionsOPERATIONSTATISTICSREAD               RoleForUpdatePermissions = "OPERATION_STATISTICS_READ"
	RoleForUpdatePermissionsOPERATIVEPROCESSREAD                  RoleForUpdatePermissions = "OPERATIVE_PROCESS_READ"
	RoleForUpdatePermissionsOPERATIVEPROCESSWRITE                 RoleForUpdatePermissions = "OPERATIVE_PROCESS_WRITE"
	RoleForUpdatePermissionsORDERCANCEL                           RoleForUpdatePermissions = "ORDER_CANCEL"
	RoleForUpdatePermissionsORDERCONSUMERWRITE                    RoleForUpdatePermissions = "ORDER_CONSUMER_WRITE"
	RoleForUpdatePermissionsORDERCUSTOMATTRIBUTESWRITE            RoleForUpdatePermissions = "ORDER_CUSTOM_ATTRIBUTES_WRITE"
	RoleForUpdatePermissionsORDERDELIVERYPROMISEWRITE             RoleForUpdatePermissions = "ORDER_DELIVERY_PROMISE_WRITE"
	RoleForUpdatePermissionsORDERFORCECANCEL                      RoleForUpdatePermissions = "ORDER_FORCE_CANCEL"
	RoleForUpdatePermissionsORDERLINEITEMWRITE                    RoleForUpdatePermissions = "ORDER_LINEITEM_WRITE"
	RoleForUpdatePermissionsORDERREAD                             RoleForUpdatePermissions = "ORDER_READ"
	RoleForUpdatePermissionsORDERRECORDREAD                       RoleForUpdatePermissions = "ORDER_RECORD_READ"
	RoleForUpdatePermissionsORDERRECORDWRITE                      RoleForUpdatePermissions = "ORDER_RECORD_WRITE"
	RoleForUpdatePermissionsORDERTOTALREAD                        RoleForUpdatePermissions = "ORDER_TOTAL_READ"
	RoleForUpdatePermissionsORDERUNLOCK                           RoleForUpdatePermissions = "ORDER_UNLOCK"
	RoleForUpdatePermissionsORDERWRITE                            RoleForUpdatePermissions = "ORDER_WRITE"
	RoleForUpdatePermissionsPACKAGINGUNITSREAD                    RoleForUpdatePermissions = "PACKAGING_UNITS_READ"
	RoleForUpdatePermissionsPACKAGINGUNITSWRITE                   RoleForUpdatePermissions = "PACKAGING_UNITS_WRITE"
	RoleForUpdatePermissionsPACKINGCONTAINERTYPEWRITE             RoleForUpdatePermissions = "PACKINGCONTAINER_TYPE_WRITE"
	RoleForUpdatePermissionsPACKINGSOURCECONTAINERREAD            RoleForUpdatePermissions = "PACKING_SOURCE_CONTAINER_READ"
	RoleForUpdatePermissionsPACKINGSOURCECONTAINERWRITE           RoleForUpdatePermissions = "PACKING_SOURCE_CONTAINER_WRITE"
	RoleForUpdatePermissionsPACKJOBREAD                           RoleForUpdatePermissions = "PACKJOB_READ"
	RoleForUpdatePermissionsPACKJOBWRITE                          RoleForUpdatePermissions = "PACKJOB_WRITE"
	RoleForUpdatePermissionsPARCELREAD                            RoleForUpdatePermissions = "PARCEL_READ"
	RoleForUpdatePermissionsPARCELWRITE                           RoleForUpdatePermissions = "PARCEL_WRITE"
	RoleForUpdatePermissionsPERMISSIONREAD                        RoleForUpdatePermissions = "PERMISSION_READ"
	RoleForUpdatePermissionsPICKJOBREAD                           RoleForUpdatePermissions = "PICKJOB_READ"
	RoleForUpdatePermissionsPICKJOBREROUTE                        RoleForUpdatePermissions = "PICKJOB_REROUTE"
	RoleForUpdatePermissionsPICKJOBWRITE                          RoleForUpdatePermissions = "PICKJOB_WRITE"
	RoleForUpdatePermissionsPICKRUNREAD                           RoleForUpdatePermissions = "PICKRUN_READ"
	RoleForUpdatePermissionsPICKRUNWRITE                          RoleForUpdatePermissions = "PICKRUN_WRITE"
	RoleForUpdatePermissionsPICKUPSERVICEREAD                     RoleForUpdatePermissions = "PICKUP_SERVICE_READ"
	RoleForUpdatePermissionsPICKUPSERVICEWRITE                    RoleForUpdatePermissions = "PICKUP_SERVICE_WRITE"
	RoleForUpdatePermissionsPROCESSLOGREAD                        RoleForUpdatePermissions = "PROCESS_LOG_READ"
	RoleForUpdatePermissionsPROCESSREAD                           RoleForUpdatePermissions = "PROCESS_READ"
	RoleForUpdatePermissionsPROCESSREROUTE                        RoleForUpdatePermissions = "PROCESS_REROUTE"
	RoleForUpdatePermissionsPROCESSWRITE                          RoleForUpdatePermissions = "PROCESS_WRITE"
	RoleForUpdatePermissionsPROMISESCONFIGREAD                    RoleForUpdatePermissions = "PROMISES_CONFIG_READ"
	RoleForUpdatePermissionsPROMISESCONFIGWRITE                   RoleForUpdatePermissions = "PROMISES_CONFIG_WRITE"
	RoleForUpdatePermissionsPURCHASEPRICEREAD                     RoleForUpdatePermissions = "PURCHASE_PRICE_READ"
	RoleForUpdatePermissionsREMOTECONFIGREAD                      RoleForUpdatePermissions = "REMOTE_CONFIG_READ"
	RoleForUpdatePermissionsREMOTECONFIGWRITE                     RoleForUpdatePermissions = "REMOTE_CONFIG_WRITE"
	RoleForUpdatePermissionsRESERVATIONREAD                       RoleForUpdatePermissions = "RESERVATION_READ"
	RoleForUpdatePermissionsRESERVATIONWRITE                      RoleForUpdatePermissions = "RESERVATION_WRITE"
	RoleForUpdatePermissionsRESTOWITEMREAD                        RoleForUpdatePermissions = "RESTOW_ITEM_READ"
	RoleForUpdatePermissionsRESTOWITEMWRITE                       RoleForUpdatePermissions = "RESTOW_ITEM_WRITE"
	RoleForUpdatePermissionsRETURNREAD                            RoleForUpdatePermissions = "RETURN_READ"
	RoleForUpdatePermissionsRETURNWRITE                           RoleForUpdatePermissions = "RETURN_WRITE"
	RoleForUpdatePermissionsROLEREAD                              RoleForUpdatePermissions = "ROLE_READ"
	RoleForUpdatePermissionsROLEWRITE                             RoleForUpdatePermissions = "ROLE_WRITE"
	RoleForUpdatePermissionsROUTINGCONFIGREAD                     RoleForUpdatePermissions = "ROUTING_CONFIG_READ"
	RoleForUpdatePermissionsROUTINGCONFIGWRITE                    RoleForUpdatePermissions = "ROUTING_CONFIG_WRITE"
	RoleForUpdatePermissionsROUTINGREAD                           RoleForUpdatePermissions = "ROUTING_READ"
	RoleForUpdatePermissionsROUTINGWRITE                          RoleForUpdatePermissions = "ROUTING_WRITE"
	RoleForUpdatePermissionsSAFETYSTOCKREAD                       RoleForUpdatePermissions = "SAFETY_STOCK_READ"
	RoleForUpdatePermissionsSAFETYSTOCKWRITE                      RoleForUpdatePermissions = "SAFETY_STOCK_WRITE"
	RoleForUpdatePermissionsSERVICEJOBREAD                        RoleForUpdatePermissions = "SERVICE_JOB_READ"
	RoleForUpdatePermissionsSERVICEJOBWRITE                       RoleForUpdatePermissions = "SERVICE_JOB_WRITE"
	RoleForUpdatePermissionsSHIPMENTREAD                          RoleForUpdatePermissions = "SHIPMENT_READ"
	RoleForUpdatePermissionsSHIPMENTWRITE                         RoleForUpdatePermissions = "SHIPMENT_WRITE"
	RoleForUpdatePermissionsSIMULATIONORDERREAD                   RoleForUpdatePermissions = "SIMULATION_ORDER_READ"
	RoleForUpdatePermissionsSIMULATIONORDERWRITE                  RoleForUpdatePermissions = "SIMULATION_ORDER_WRITE"
	RoleForUpdatePermissionsSTACKSREAD                            RoleForUpdatePermissions = "STACKS_READ"
	RoleForUpdatePermissionsSTACKSWRITE                           RoleForUpdatePermissions = "STACKS_WRITE"
	RoleForUpdatePermissionsSTOCKAVAILABILITIESREAD               RoleForUpdatePermissions = "STOCK_AVAILABILITIES_READ"
	RoleForUpdatePermissionsSTOCKREAD                             RoleForUpdatePermissions = "STOCK_READ"
	RoleForUpdatePermissionsSTOCKWRITE                            RoleForUpdatePermissions = "STOCK_WRITE"
	RoleForUpdatePermissionsSTORAGELOCATIONREAD                   RoleForUpdatePermissions = "STORAGE_LOCATION_READ"
	RoleForUpdatePermissionsSTORAGELOCATIONWRITE                  RoleForUpdatePermissions = "STORAGE_LOCATION_WRITE"
	RoleForUpdatePermissionsSTOWJOBFULLWRITE                      RoleForUpdatePermissions = "STOW_JOB_FULL_WRITE"
	RoleForUpdatePermissionsSTOWJOBOPERATIVEWRITE                 RoleForUpdatePermissions = "STOW_JOB_OPERATIVE_WRITE"
	RoleForUpdatePermissionsSTOWJOBREAD                           RoleForUpdatePermissions = "STOW_JOB_READ"
	RoleForUpdatePermissionsSUBSCRIPTIONREAD                      RoleForUpdatePermissions = "SUBSCRIPTION_READ"
	RoleForUpdatePermissionsSUBSCRIPTIONWRITE                     RoleForUpdatePermissions = "SUBSCRIPTION_WRITE"
	RoleForUpdatePermissionsSUBSTITUTEREAD                        RoleForUpdatePermissions = "SUBSTITUTE_READ"
	RoleForUpdatePermissionsSUBSTITUTEWRITE                       RoleForUpdatePermissions = "SUBSTITUTE_WRITE"
	RoleForUpdatePermissionsTAGREAD                               RoleForUpdatePermissions = "TAG_READ"
	RoleForUpdatePermissionsTAGWRITE                              RoleForUpdatePermissions = "TAG_WRITE"
	RoleForUpdatePermissionsTENANTCONNECTORCONFIGREAD             RoleForUpdatePermissions = "TENANT_CONNECTOR_CONFIG_READ"
	RoleForUpdatePermissionsUSERMODIFY                            RoleForUpdatePermissions = "USER_MODIFY"
	RoleForUpdatePermissionsUSERREAD                              RoleForUpdatePermissions = "USER_READ"
	RoleForUpdatePermissionsUSERSREAD                             RoleForUpdatePermissions = "USERS_READ"
	RoleForUpdatePermissionsUSERWRITE                             RoleForUpdatePermissions = "USER_WRITE"
	RoleForUpdatePermissionsVALIDATIONSREAD                       RoleForUpdatePermissions = "VALIDATIONS_READ"
	RoleForUpdatePermissionsWORKFLOWDEFINITIONREAD                RoleForUpdatePermissions = "WORKFLOW_DEFINITION_READ"
	RoleForUpdatePermissionsWORKFLOWDEFINITIONWRITE               RoleForUpdatePermissions = "WORKFLOW_DEFINITION_WRITE"
	RoleForUpdatePermissionsZONEREAD                              RoleForUpdatePermissions = "ZONE_READ"
	RoleForUpdatePermissionsZONEWRITE                             RoleForUpdatePermissions = "ZONE_WRITE"
)

Defines values for RoleForUpdatePermissions.

func (RoleForUpdatePermissions) Valid

func (e RoleForUpdatePermissions) Valid() bool

Valid indicates whether the value is a known member of the RoleForUpdatePermissions enum.

type RolePaginatedResult

type RolePaginatedResult struct {
	// PageInfo Pagination information for the search result.
	PageInfo PageInfo `json:"pageInfo"`
	Roles    []Role   `json:"roles"`

	// Total The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
	Total *float32 `json:"total,omitempty"`
}

RolePaginatedResult RolePaginatedResult

type RolePermissions

type RolePermissions string

RolePermissions defines model for Role.Permissions.

const (
	RolePermissionsADMINDATARESET                        RolePermissions = "ADMIN_DATA_RESET"
	RolePermissionsADMININTERFACILITYCONNECTIONMIGRATION RolePermissions = "ADMIN_INTER_FACILITY_CONNECTION_MIGRATION"
	RolePermissionsADMINMODULESREAD                      RolePermissions = "ADMIN_MODULES_READ"
	RolePermissionsADMINMODULESWRITE                     RolePermissions = "ADMIN_MODULES_WRITE"
	RolePermissionsADMINROUTINGPLANANALYSIS              RolePermissions = "ADMIN_ROUTING_PLAN_ANALYSIS"
	RolePermissionsAIASSISTANTACCESS                     RolePermissions = "AI_ASSISTANT_ACCESS"
	RolePermissionsANALYTICSDASHBOARDREAD                RolePermissions = "ANALYTICS_DASHBOARD_READ"
	RolePermissionsAUDITREAD                             RolePermissions = "AUDIT_READ"
	RolePermissionsAVAILABILITYCHANNELREAD               RolePermissions = "AVAILABILITY_CHANNEL_READ"
	RolePermissionsAVAILABILITYCHANNELWRITE              RolePermissions = "AVAILABILITY_CHANNEL_WRITE"
	RolePermissionsAVAILABILITYTHRESHOLDSREAD            RolePermissions = "AVAILABILITY_THRESHOLDS_READ"
	RolePermissionsAVAILABILITYTHRESHOLDSWRITE           RolePermissions = "AVAILABILITY_THRESHOLDS_WRITE"
	RolePermissionsBRANDREAD                             RolePermissions = "BRAND_READ"
	RolePermissionsCARRIERREAD                           RolePermissions = "CARRIER_READ"
	RolePermissionsCARRIERWRITE                          RolePermissions = "CARRIER_WRITE"
	RolePermissionsCATEGORYREAD                          RolePermissions = "CATEGORY_READ"
	RolePermissionsCATEGORYWRITE                         RolePermissions = "CATEGORY_WRITE"
	RolePermissionsCONFIGREAD                            RolePermissions = "CONFIG_READ"
	RolePermissionsCONFIGWRITE                           RolePermissions = "CONFIG_WRITE"
	RolePermissionsCURRENTUSERMODIFY                     RolePermissions = "CURRENT_USER_MODIFY"
	RolePermissionsCURRENTUSERREAD                       RolePermissions = "CURRENT_USER_READ"
	RolePermissionsCUSTOMSERVICEREAD                     RolePermissions = "CUSTOM_SERVICE_READ"
	RolePermissionsCUSTOMSERVICEWRITE                    RolePermissions = "CUSTOM_SERVICE_WRITE"
	RolePermissionsDELIVERYNOTEWRITE                     RolePermissions = "DELIVERYNOTE_WRITE"
	RolePermissionsDOCUMENTSETREAD                       RolePermissions = "DOCUMENT_SET_READ"
	RolePermissionsDOCUMENTSETWRITE                      RolePermissions = "DOCUMENT_SET_WRITE"
	RolePermissionsDOMSSTATISTICSREAD                    RolePermissions = "DOMS_STATISTICS_READ"
	RolePermissionsDOMSTOOLKITREAD                       RolePermissions = "DOMS_TOOLKIT_READ"
	RolePermissionsDOMSTOOLKITWRITE                      RolePermissions = "DOMS_TOOLKIT_WRITE"
	RolePermissionsEVENTREAD                             RolePermissions = "EVENT_READ"
	RolePermissionsEXPIRIESREAD                          RolePermissions = "EXPIRIES_READ"
	RolePermissionsEXPIRIESWRITE                         RolePermissions = "EXPIRIES_WRITE"
	RolePermissionsEXPORTREAD                            RolePermissions = "EXPORT_READ"
	RolePermissionsEXPORTWRITE                           RolePermissions = "EXPORT_WRITE"
	RolePermissionsEXTERNALACTIONSREAD                   RolePermissions = "EXTERNAL_ACTIONS_READ"
	RolePermissionsEXTERNALACTIONSWRITE                  RolePermissions = "EXTERNAL_ACTIONS_WRITE"
	RolePermissionsEXTERNALSTOCKCHANGEREASONSREAD        RolePermissions = "EXTERNAL_STOCK_CHANGE_REASONS_READ"
	RolePermissionsEXTERNALSTOCKCHANGEREASONSWRITE       RolePermissions = "EXTERNAL_STOCK_CHANGE_REASONS_WRITE"
	RolePermissionsFACILITYCREATE                        RolePermissions = "FACILITY_CREATE"
	RolePermissionsFACILITYDELETE                        RolePermissions = "FACILITY_DELETE"
	RolePermissionsFACILITYGROUPREAD                     RolePermissions = "FACILITY_GROUP_READ"
	RolePermissionsFACILITYGROUPWRITE                    RolePermissions = "FACILITY_GROUP_WRITE"
	RolePermissionsFACILITYREAD                          RolePermissions = "FACILITY_READ"
	RolePermissionsFACILITYWRITE                         RolePermissions = "FACILITY_WRITE"
	RolePermissionsFILTERENTITYREAD                      RolePermissions = "FILTER_ENTITY_READ"
	RolePermissionsHANDOVERCONTAINERREAD                 RolePermissions = "HANDOVER_CONTAINER_READ"
	RolePermissionsHANDOVERCONTAINERWRITE                RolePermissions = "HANDOVER_CONTAINER_WRITE"
	RolePermissionsHANDOVERJOBREAD                       RolePermissions = "HANDOVERJOB_READ"
	RolePermissionsHANDOVERJOBWRITE                      RolePermissions = "HANDOVERJOB_WRITE"
	RolePermissionsINBOUNDPROCESSREAD                    RolePermissions = "INBOUND_PROCESS_READ"
	RolePermissionsINBOUNDPROCESSWRITE                   RolePermissions = "INBOUND_PROCESS_WRITE"
	RolePermissionsKPIREAD                               RolePermissions = "KPI_READ"
	RolePermissionsLINEITEMADD                           RolePermissions = "LINE_ITEM_ADD"
	RolePermissionsLINEITEMDELETE                        RolePermissions = "LINE_ITEM_DELETE"
	RolePermissionsLINEITEMPRICINGREAD                   RolePermissions = "LINE_ITEM_PRICING_READ"
	RolePermissionsLINEITEMQUANTITYDECREASE              RolePermissions = "LINE_ITEM_QUANTITY_DECREASE"
	RolePermissionsLINEITEMQUANTITYINCREASE              RolePermissions = "LINE_ITEM_QUANTITY_INCREASE"
	RolePermissionsLINKEDSERVICEJOBSREAD                 RolePermissions = "LINKED_SERVICE_JOBS_READ"
	RolePermissionsLINKEDSERVICEJOBSWRITE                RolePermissions = "LINKED_SERVICE_JOBS_WRITE"
	RolePermissionsLISTINGDELETE                         RolePermissions = "LISTING_DELETE"
	RolePermissionsLISTINGREAD                           RolePermissions = "LISTING_READ"
	RolePermissionsLISTINGWRITE                          RolePermissions = "LISTING_WRITE"
	RolePermissionsLOADUNITREAD                          RolePermissions = "LOADUNIT_READ"
	RolePermissionsLOADUNITTYPEREAD                      RolePermissions = "LOADUNITTYPE_READ"
	RolePermissionsLOADUNITTYPEWRITE                     RolePermissions = "LOADUNITTYPE_WRITE"
	RolePermissionsLOADUNITWRITE                         RolePermissions = "LOADUNIT_WRITE"
	RolePermissionsLOCALEWRITE                           RolePermissions = "LOCALE_WRITE"
	RolePermissionsLOOKUPRECORDREAD                      RolePermissions = "LOOKUP_RECORD_READ"
	RolePermissionsLOOKUPRECORDWRITE                     RolePermissions = "LOOKUP_RECORD_WRITE"
	RolePermissionsMEASUREMENTUNITREAD                   RolePermissions = "MEASUREMENTUNIT_READ"
	RolePermissionsMEASUREMENTUNITWRITE                  RolePermissions = "MEASUREMENTUNIT_WRITE"
	RolePermissionsNOTIFICATIONCENTERCONFIGREAD          RolePermissions = "NOTIFICATION_CENTER_CONFIG_READ"
	RolePermissionsNOTIFICATIONCENTERCONFIGWRITE         RolePermissions = "NOTIFICATION_CENTER_CONFIG_WRITE"
	RolePermissionsNOTIFICATIONREAD                      RolePermissions = "NOTIFICATION_READ"
	RolePermissionsNOTIFICATIONWRITE                     RolePermissions = "NOTIFICATION_WRITE"
	RolePermissionsOIDCPROVIDERSCONFIGREAD               RolePermissions = "OIDC_PROVIDERS_CONFIG_READ"
	RolePermissionsOIDCPROVIDERSCONFIGWRITE              RolePermissions = "OIDC_PROVIDERS_CONFIG_WRITE"
	RolePermissionsOPERATIONSTATISTICSREAD               RolePermissions = "OPERATION_STATISTICS_READ"
	RolePermissionsOPERATIVEPROCESSREAD                  RolePermissions = "OPERATIVE_PROCESS_READ"
	RolePermissionsOPERATIVEPROCESSWRITE                 RolePermissions = "OPERATIVE_PROCESS_WRITE"
	RolePermissionsORDERCANCEL                           RolePermissions = "ORDER_CANCEL"
	RolePermissionsORDERCONSUMERWRITE                    RolePermissions = "ORDER_CONSUMER_WRITE"
	RolePermissionsORDERCUSTOMATTRIBUTESWRITE            RolePermissions = "ORDER_CUSTOM_ATTRIBUTES_WRITE"
	RolePermissionsORDERDELIVERYPROMISEWRITE             RolePermissions = "ORDER_DELIVERY_PROMISE_WRITE"
	RolePermissionsORDERFORCECANCEL                      RolePermissions = "ORDER_FORCE_CANCEL"
	RolePermissionsORDERLINEITEMWRITE                    RolePermissions = "ORDER_LINEITEM_WRITE"
	RolePermissionsORDERREAD                             RolePermissions = "ORDER_READ"
	RolePermissionsORDERRECORDREAD                       RolePermissions = "ORDER_RECORD_READ"
	RolePermissionsORDERRECORDWRITE                      RolePermissions = "ORDER_RECORD_WRITE"
	RolePermissionsORDERTOTALREAD                        RolePermissions = "ORDER_TOTAL_READ"
	RolePermissionsORDERUNLOCK                           RolePermissions = "ORDER_UNLOCK"
	RolePermissionsORDERWRITE                            RolePermissions = "ORDER_WRITE"
	RolePermissionsPACKAGINGUNITSREAD                    RolePermissions = "PACKAGING_UNITS_READ"
	RolePermissionsPACKAGINGUNITSWRITE                   RolePermissions = "PACKAGING_UNITS_WRITE"
	RolePermissionsPACKINGCONTAINERTYPEWRITE             RolePermissions = "PACKINGCONTAINER_TYPE_WRITE"
	RolePermissionsPACKINGSOURCECONTAINERREAD            RolePermissions = "PACKING_SOURCE_CONTAINER_READ"
	RolePermissionsPACKINGSOURCECONTAINERWRITE           RolePermissions = "PACKING_SOURCE_CONTAINER_WRITE"
	RolePermissionsPACKJOBREAD                           RolePermissions = "PACKJOB_READ"
	RolePermissionsPACKJOBWRITE                          RolePermissions = "PACKJOB_WRITE"
	RolePermissionsPARCELREAD                            RolePermissions = "PARCEL_READ"
	RolePermissionsPARCELWRITE                           RolePermissions = "PARCEL_WRITE"
	RolePermissionsPERMISSIONREAD                        RolePermissions = "PERMISSION_READ"
	RolePermissionsPICKJOBREAD                           RolePermissions = "PICKJOB_READ"
	RolePermissionsPICKJOBREROUTE                        RolePermissions = "PICKJOB_REROUTE"
	RolePermissionsPICKJOBWRITE                          RolePermissions = "PICKJOB_WRITE"
	RolePermissionsPICKRUNREAD                           RolePermissions = "PICKRUN_READ"
	RolePermissionsPICKRUNWRITE                          RolePermissions = "PICKRUN_WRITE"
	RolePermissionsPICKUPSERVICEREAD                     RolePermissions = "PICKUP_SERVICE_READ"
	RolePermissionsPICKUPSERVICEWRITE                    RolePermissions = "PICKUP_SERVICE_WRITE"
	RolePermissionsPROCESSLOGREAD                        RolePermissions = "PROCESS_LOG_READ"
	RolePermissionsPROCESSREAD                           RolePermissions = "PROCESS_READ"
	RolePermissionsPROCESSREROUTE                        RolePermissions = "PROCESS_REROUTE"
	RolePermissionsPROCESSWRITE                          RolePermissions = "PROCESS_WRITE"
	RolePermissionsPROMISESCONFIGREAD                    RolePermissions = "PROMISES_CONFIG_READ"
	RolePermissionsPROMISESCONFIGWRITE                   RolePermissions = "PROMISES_CONFIG_WRITE"
	RolePermissionsPURCHASEPRICEREAD                     RolePermissions = "PURCHASE_PRICE_READ"
	RolePermissionsREMOTECONFIGREAD                      RolePermissions = "REMOTE_CONFIG_READ"
	RolePermissionsREMOTECONFIGWRITE                     RolePermissions = "REMOTE_CONFIG_WRITE"
	RolePermissionsRESERVATIONREAD                       RolePermissions = "RESERVATION_READ"
	RolePermissionsRESERVATIONWRITE                      RolePermissions = "RESERVATION_WRITE"
	RolePermissionsRESTOWITEMREAD                        RolePermissions = "RESTOW_ITEM_READ"
	RolePermissionsRESTOWITEMWRITE                       RolePermissions = "RESTOW_ITEM_WRITE"
	RolePermissionsRETURNREAD                            RolePermissions = "RETURN_READ"
	RolePermissionsRETURNWRITE                           RolePermissions = "RETURN_WRITE"
	RolePermissionsROLEREAD                              RolePermissions = "ROLE_READ"
	RolePermissionsROLEWRITE                             RolePermissions = "ROLE_WRITE"
	RolePermissionsROUTINGCONFIGREAD                     RolePermissions = "ROUTING_CONFIG_READ"
	RolePermissionsROUTINGCONFIGWRITE                    RolePermissions = "ROUTING_CONFIG_WRITE"
	RolePermissionsROUTINGREAD                           RolePermissions = "ROUTING_READ"
	RolePermissionsROUTINGWRITE                          RolePermissions = "ROUTING_WRITE"
	RolePermissionsSAFETYSTOCKREAD                       RolePermissions = "SAFETY_STOCK_READ"
	RolePermissionsSAFETYSTOCKWRITE                      RolePermissions = "SAFETY_STOCK_WRITE"
	RolePermissionsSERVICEJOBREAD                        RolePermissions = "SERVICE_JOB_READ"
	RolePermissionsSERVICEJOBWRITE                       RolePermissions = "SERVICE_JOB_WRITE"
	RolePermissionsSHIPMENTREAD                          RolePermissions = "SHIPMENT_READ"
	RolePermissionsSHIPMENTWRITE                         RolePermissions = "SHIPMENT_WRITE"
	RolePermissionsSIMULATIONORDERREAD                   RolePermissions = "SIMULATION_ORDER_READ"
	RolePermissionsSIMULATIONORDERWRITE                  RolePermissions = "SIMULATION_ORDER_WRITE"
	RolePermissionsSTACKSREAD                            RolePermissions = "STACKS_READ"
	RolePermissionsSTACKSWRITE                           RolePermissions = "STACKS_WRITE"
	RolePermissionsSTOCKAVAILABILITIESREAD               RolePermissions = "STOCK_AVAILABILITIES_READ"
	RolePermissionsSTOCKREAD                             RolePermissions = "STOCK_READ"
	RolePermissionsSTOCKWRITE                            RolePermissions = "STOCK_WRITE"
	RolePermissionsSTORAGELOCATIONREAD                   RolePermissions = "STORAGE_LOCATION_READ"
	RolePermissionsSTORAGELOCATIONWRITE                  RolePermissions = "STORAGE_LOCATION_WRITE"
	RolePermissionsSTOWJOBFULLWRITE                      RolePermissions = "STOW_JOB_FULL_WRITE"
	RolePermissionsSTOWJOBOPERATIVEWRITE                 RolePermissions = "STOW_JOB_OPERATIVE_WRITE"
	RolePermissionsSTOWJOBREAD                           RolePermissions = "STOW_JOB_READ"
	RolePermissionsSUBSCRIPTIONREAD                      RolePermissions = "SUBSCRIPTION_READ"
	RolePermissionsSUBSCRIPTIONWRITE                     RolePermissions = "SUBSCRIPTION_WRITE"
	RolePermissionsSUBSTITUTEREAD                        RolePermissions = "SUBSTITUTE_READ"
	RolePermissionsSUBSTITUTEWRITE                       RolePermissions = "SUBSTITUTE_WRITE"
	RolePermissionsTAGREAD                               RolePermissions = "TAG_READ"
	RolePermissionsTAGWRITE                              RolePermissions = "TAG_WRITE"
	RolePermissionsTENANTCONNECTORCONFIGREAD             RolePermissions = "TENANT_CONNECTOR_CONFIG_READ"
	RolePermissionsUSERMODIFY                            RolePermissions = "USER_MODIFY"
	RolePermissionsUSERREAD                              RolePermissions = "USER_READ"
	RolePermissionsUSERSREAD                             RolePermissions = "USERS_READ"
	RolePermissionsUSERWRITE                             RolePermissions = "USER_WRITE"
	RolePermissionsVALIDATIONSREAD                       RolePermissions = "VALIDATIONS_READ"
	RolePermissionsWORKFLOWDEFINITIONREAD                RolePermissions = "WORKFLOW_DEFINITION_READ"
	RolePermissionsWORKFLOWDEFINITIONWRITE               RolePermissions = "WORKFLOW_DEFINITION_WRITE"
	RolePermissionsZONEREAD                              RolePermissions = "ZONE_READ"
	RolePermissionsZONEWRITE                             RolePermissions = "ZONE_WRITE"
)

Defines values for RolePermissions.

func (RolePermissions) Valid

func (e RolePermissions) Valid() bool

Valid indicates whether the value is a known member of the RolePermissions enum.

type RoleSearchPayload

type RoleSearchPayload struct {
	// After 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`.
	After *string `json:"after,omitempty"`

	// Before 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).
	Before *string `json:"before,omitempty"`

	// Last Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
	Last *float32 `json:"last,omitempty"`

	// Options SearchOptions
	Options *SearchOptions `json:"options,omitempty"`

	// Query RoleSearchQuery
	Query RoleSearchQuery `json:"query"`

	// Size Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
	//
	// Example: 10
	Size *float32 `json:"size,omitempty"`

	// Sort Use for sorting the result.
	Sort *[]RoleSort `json:"sort,omitempty"`

	// StartAfterId The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	StartAfterId *string `json:"startAfterId,omitempty"`
}

RoleSearchPayload RoleSearchPayload

type RoleSearchQuery

type RoleSearchQuery struct {
	And *[]RoleSearchQuery `json:"and,omitempty"`

	// Description Search by description
	Description *StringFilter `json:"description,omitempty"`

	// DisplayName Search by displayName
	DisplayName *StringSearchFilter `json:"displayName,omitempty"`

	// Name Search by name
	Name *StringFilter      `json:"name,omitempty"`
	Or   *[]RoleSearchQuery `json:"or,omitempty"`
}

RoleSearchQuery RoleSearchQuery

type RoleSort

type RoleSort struct {
	DisplayName *RoleSortDisplayName `json:"displayName,omitempty"`
}

RoleSort RoleSort

type RoleSortDisplayName

type RoleSortDisplayName string

RoleSortDisplayName defines model for RoleSort.DisplayName.

const (
	RoleSortDisplayNameASC  RoleSortDisplayName = "ASC"
	RoleSortDisplayNameDESC RoleSortDisplayName = "DESC"
)

Defines values for RoleSortDisplayName.

func (RoleSortDisplayName) Valid

func (e RoleSortDisplayName) Valid() bool

Valid indicates whether the value is a known member of the RoleSortDisplayName enum.

type RoutingDecisionLog added in v0.6.0

type RoutingDecisionLog struct {
	// Created The date this order was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created time.Time `json:"created"`

	// ExecutionResults SourcingOptionsExecutionResults
	ExecutionResults SourcingOptionsExecutionResults `json:"executionResults"`
	Id               string                          `json:"id"`

	// LastModified The date this order was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified time.Time `json:"lastModified"`

	// RelatedRefs RoutingDecisionLogRelatedRefs
	RelatedRefs RoutingDecisionLogRelatedRefs `json:"relatedRefs"`

	// RoutingStrategyEvaluationResult RoutingStrategyEvaluationResult
	RoutingStrategyEvaluationResult *RoutingStrategyEvaluationResult `json:"routingStrategyEvaluationResult,omitempty"`
	SourcingOptions                 []SourcingOption                 `json:"sourcingOptions"`
}

RoutingDecisionLog RoutingDecisionLog

type RoutingDecisionLogRelatedRefs added in v0.6.0

type RoutingDecisionLogRelatedRefs struct {
	// OrderRef The orderRef of the order this decision log is related to.
	OrderRef *string `json:"orderRef,omitempty"`

	// ProcessRef The processRef of the process this decision log is related to.
	ProcessRef *string `json:"processRef,omitempty"`

	// RoutingPlanRefs The routingPlanRefs of the routing plans this decision log is related to.
	RoutingPlanRefs *[]string `json:"routingPlanRefs,omitempty"`

	// RunId The runId of the connected sourcingOption this decision log is related to.
	RunId *string `json:"runId,omitempty"`

	// SourcingOptionRefs The sourcingOptionsRefs of the request this decision log is related to.
	SourcingOptionRefs *[]string `json:"sourcingOptionRefs,omitempty"`

	// SourcingOptionsRef The sourcingOptionsRef of the request this decision log is related to.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	SourcingOptionsRef *string `json:"sourcingOptionsRef,omitempty"`

	// TenantOrderId The tenantOrderId of the order this decision log is related to.
	TenantOrderId *string `json:"tenantOrderId,omitempty"`
}

RoutingDecisionLogRelatedRefs RoutingDecisionLogRelatedRefs

type RoutingDecisionLogs added in v0.6.0

type RoutingDecisionLogs struct {
	DecisionLogs []RoutingDecisionLog `json:"decisionLogs"`

	// Total Total number of found decision logs for this query
	//
	// Example: 42
	Total int `json:"total"`
}

RoutingDecisionLogs RoutingDecisionLogs

type RoutingPlanCustomServicesArticleItemsFilter

type RoutingPlanCustomServicesArticleItemsFilter struct {
	// TenantArticleRef Search by tenantArticleRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	TenantArticleRef *StringFilter `json:"tenantArticleRef,omitempty"`
}

RoutingPlanCustomServicesArticleItemsFilter RoutingPlanCustomServicesArticleItemsFilter

type RoutingPlanCustomServicesArticleItemsListFilter

type RoutingPlanCustomServicesArticleItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanCustomServicesArticleItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanCustomServicesArticleItemsListFilter RoutingPlanCustomServicesArticleItemsListFilter

type RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter

type RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter struct {
	// AdditionalInformationRef Search by additionalInformationRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	AdditionalInformationRef *StringFilter `json:"additionalInformationRef,omitempty"`
}

RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter

type RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter

type RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter

type RoutingPlanCustomServicesCustomServiceDefinitionFilter

type RoutingPlanCustomServicesCustomServiceDefinitionFilter struct {
	// AdditionalInformation Nested list search by additionalInformation
	AdditionalInformation *RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter `json:"additionalInformation,omitempty"`

	// CustomServiceRef Search by customServiceRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	CustomServiceRef *StringFilter `json:"customServiceRef,omitempty"`
}

RoutingPlanCustomServicesCustomServiceDefinitionFilter RoutingPlanCustomServicesCustomServiceDefinitionFilter

type RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter

type RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter struct {
	// TenantArticleRef Search by tenantArticleRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	TenantArticleRef *StringFilter `json:"tenantArticleRef,omitempty"`
}

RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter

type RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter

type RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter

type RoutingPlanCustomServicesCustomServiceItemsFilter

type RoutingPlanCustomServicesCustomServiceItemsFilter struct {
	// ArticleItems Nested list search by articleItems
	ArticleItems *RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter `json:"articleItems,omitempty"`
}

RoutingPlanCustomServicesCustomServiceItemsFilter RoutingPlanCustomServicesCustomServiceItemsFilter

type RoutingPlanCustomServicesCustomServiceItemsListFilter

type RoutingPlanCustomServicesCustomServiceItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanCustomServicesCustomServiceItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanCustomServicesCustomServiceItemsListFilter RoutingPlanCustomServicesCustomServiceItemsListFilter

type RoutingPlanCustomServicesFilter

type RoutingPlanCustomServicesFilter struct {
	// ArticleItems Nested list search by articleItems
	ArticleItems *RoutingPlanCustomServicesArticleItemsListFilter `json:"articleItems,omitempty"`

	// CustomServiceDefinition Nested search by customServiceDefinition
	CustomServiceDefinition *RoutingPlanCustomServicesCustomServiceDefinitionFilter `json:"customServiceDefinition,omitempty"`

	// CustomServiceItems Nested list search by customServiceItems
	CustomServiceItems *RoutingPlanCustomServicesCustomServiceItemsListFilter `json:"customServiceItems,omitempty"`
}

RoutingPlanCustomServicesFilter RoutingPlanCustomServicesFilter

type RoutingPlanCustomServicesListFilter

type RoutingPlanCustomServicesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanCustomServicesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanCustomServicesListFilter RoutingPlanCustomServicesListFilter

type RoutingPlanDeliveryPreferencesCollectFilter

type RoutingPlanDeliveryPreferencesCollectFilter struct {
	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Paid Search by paid
	Paid *BooleanFilter `json:"paid,omitempty"`

	// SupplyingFacilities Search by supplyingFacilities
	SupplyingFacilities *StringListFilter `json:"supplyingFacilities,omitempty"`
}

RoutingPlanDeliveryPreferencesCollectFilter RoutingPlanDeliveryPreferencesCollectFilter

type RoutingPlanDeliveryPreferencesCollectListFilter

type RoutingPlanDeliveryPreferencesCollectListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanDeliveryPreferencesCollectFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanDeliveryPreferencesCollectListFilter RoutingPlanDeliveryPreferencesCollectListFilter

type RoutingPlanDeliveryPreferencesFilter

type RoutingPlanDeliveryPreferencesFilter struct {
	// Collect Nested list search by collect
	Collect *RoutingPlanDeliveryPreferencesCollectListFilter `json:"collect,omitempty"`

	// Shipping Nested search by shipping
	Shipping *RoutingPlanDeliveryPreferencesShippingFilter `json:"shipping,omitempty"`

	// SupplyingFacilities Search by supplyingFacilities
	SupplyingFacilities *StringListFilter `json:"supplyingFacilities,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`
}

RoutingPlanDeliveryPreferencesFilter RoutingPlanDeliveryPreferencesFilter

type RoutingPlanDeliveryPreferencesShippingFilter

type RoutingPlanDeliveryPreferencesShippingFilter struct {
	// PreferredCarriers Search by preferredCarriers
	PreferredCarriers *StringListFilter `json:"preferredCarriers,omitempty"`

	// PreferredCarriersWithProduct Nested list search by preferredCarriersWithProduct
	PreferredCarriersWithProduct *RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter `json:"preferredCarriersWithProduct,omitempty"`
}

RoutingPlanDeliveryPreferencesShippingFilter RoutingPlanDeliveryPreferencesShippingFilter

type RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter

type RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter struct {
	// CarrierKey Search by carrierKey
	CarrierKey *StringFilter `json:"carrierKey,omitempty"`
}

RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter

type RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter

type RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter

type RoutingPlanEarliestPickingStartFilter

type RoutingPlanEarliestPickingStartFilter struct {
	// CarrierRef Search by carrierRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	CarrierRef *StringFilter `json:"carrierRef,omitempty"`

	// EarliestPickingStartDate Search by earliestPickingStartDate
	//
	// Example: 2026-06-17T12:00:00.000Z
	EarliestPickingStartDate *DateFilter `json:"earliestPickingStartDate,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`
}

RoutingPlanEarliestPickingStartFilter RoutingPlanEarliestPickingStartFilter

type RoutingPlanHistoryFilter

type RoutingPlanHistoryFilter struct {
	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// Status Search by status
	Status *RoutingPlanHistoryRoutingPlanStatusEnumFilter `json:"status,omitempty"`
}

RoutingPlanHistoryFilter RoutingPlanHistoryFilter

type RoutingPlanHistoryListFilter

type RoutingPlanHistoryListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanHistoryFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanHistoryListFilter RoutingPlanHistoryListFilter

type RoutingPlanHistoryRoutingPlanStatusEnumFilter

type RoutingPlanHistoryRoutingPlanStatusEnumFilter struct {
	// Eq Search by status
	Eq *RoutingPlanHistoryRoutingPlanStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]RoutingPlanHistoryRoutingPlanStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

RoutingPlanHistoryRoutingPlanStatusEnumFilter RoutingPlanHistoryRoutingPlanStatusEnumFilter

type RoutingPlanHistoryRoutingPlanStatusEnumFilterEq

type RoutingPlanHistoryRoutingPlanStatusEnumFilterEq string

RoutingPlanHistoryRoutingPlanStatusEnumFilterEq Search by status

const (
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqCANCELED         RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "CANCELED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqFAILED           RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "FAILED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqFAILEDREROUTE    RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "FAILED_REROUTE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqFALLBACKROUTING  RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "FALLBACK_ROUTING"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqINITIAL          RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "INITIAL"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqINPREPARATION    RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "IN_PREPARATION"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqLOCKED           RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "LOCKED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqMANUALPLANNED    RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "MANUAL_PLANNED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqNOTROUTABLE      RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "NOT_ROUTABLE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqOBSOLETE         RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "OBSOLETE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqPLANNED          RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "PLANNED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqPRIORITIZED      RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "PRIORITIZED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqPROMISED         RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "PROMISED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqPROPOSED         RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "PROPOSED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqREDUNDANTREROUTE RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "REDUNDANT_REROUTE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqREROUTED         RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "REROUTED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqRETRYABLE        RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "RETRYABLE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqROUTED           RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "ROUTED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqROUTING          RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "ROUTING"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterEqWAITING          RoutingPlanHistoryRoutingPlanStatusEnumFilterEq = "WAITING"
)

Defines values for RoutingPlanHistoryRoutingPlanStatusEnumFilterEq.

func (RoutingPlanHistoryRoutingPlanStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the RoutingPlanHistoryRoutingPlanStatusEnumFilterEq enum.

type RoutingPlanHistoryRoutingPlanStatusEnumFilterIn

type RoutingPlanHistoryRoutingPlanStatusEnumFilterIn string

RoutingPlanHistoryRoutingPlanStatusEnumFilterIn defines model for RoutingPlanHistoryRoutingPlanStatusEnumFilter.In.

const (
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInCANCELED         RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "CANCELED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInFAILED           RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "FAILED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInFAILEDREROUTE    RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "FAILED_REROUTE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInFALLBACKROUTING  RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "FALLBACK_ROUTING"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInINITIAL          RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "INITIAL"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInINPREPARATION    RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "IN_PREPARATION"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInLOCKED           RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "LOCKED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInMANUALPLANNED    RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "MANUAL_PLANNED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInNOTROUTABLE      RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "NOT_ROUTABLE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInOBSOLETE         RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "OBSOLETE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInPLANNED          RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "PLANNED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInPRIORITIZED      RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "PRIORITIZED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInPROMISED         RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "PROMISED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInPROPOSED         RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "PROPOSED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInREDUNDANTREROUTE RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "REDUNDANT_REROUTE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInREROUTED         RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "REROUTED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInRETRYABLE        RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "RETRYABLE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInROUTED           RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "ROUTED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInROUTING          RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "ROUTING"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterInWAITING          RoutingPlanHistoryRoutingPlanStatusEnumFilterIn = "WAITING"
)

Defines values for RoutingPlanHistoryRoutingPlanStatusEnumFilterIn.

func (RoutingPlanHistoryRoutingPlanStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the RoutingPlanHistoryRoutingPlanStatusEnumFilterIn enum.

type RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq

type RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq string

RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq Search by status

const (
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqCANCELED         RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "CANCELED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqFAILED           RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "FAILED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqFAILEDREROUTE    RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "FAILED_REROUTE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqFALLBACKROUTING  RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "FALLBACK_ROUTING"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqINITIAL          RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "INITIAL"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqINPREPARATION    RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "IN_PREPARATION"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqLOCKED           RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "LOCKED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqMANUALPLANNED    RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "MANUAL_PLANNED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqNOTROUTABLE      RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "NOT_ROUTABLE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqOBSOLETE         RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "OBSOLETE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqPLANNED          RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "PLANNED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqPRIORITIZED      RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "PRIORITIZED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqPROMISED         RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "PROMISED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqPROPOSED         RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "PROPOSED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqREDUNDANTREROUTE RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "REDUNDANT_REROUTE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqREROUTED         RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "REROUTED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqRETRYABLE        RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "RETRYABLE"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqROUTED           RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "ROUTED"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqROUTING          RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "ROUTING"
	RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEqWAITING          RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq = "WAITING"
)

Defines values for RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq.

func (RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the RoutingPlanHistoryRoutingPlanStatusEnumFilterNotEq enum.

type RoutingPlanLatestPickingStartFilter

type RoutingPlanLatestPickingStartFilter struct {
	// CarrierRef Search by carrierRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	CarrierRef *StringFilter `json:"carrierRef,omitempty"`

	// LatestPickingStartDate Search by latestPickingStartDate
	//
	// Example: 2026-06-17T12:00:00.000Z
	LatestPickingStartDate *DateFilter `json:"latestPickingStartDate,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`
}

RoutingPlanLatestPickingStartFilter RoutingPlanLatestPickingStartFilter

type RoutingPlanOrderLineItemsFilter

type RoutingPlanOrderLineItemsFilter struct {
	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`
}

RoutingPlanOrderLineItemsFilter RoutingPlanOrderLineItemsFilter

type RoutingPlanOrderLineItemsListFilter

type RoutingPlanOrderLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanOrderLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanOrderLineItemsListFilter RoutingPlanOrderLineItemsListFilter

type RoutingPlanSearchQuery

type RoutingPlanSearchQuery struct {
	And *[]RoutingPlanSearchQuery `json:"and,omitempty"`

	// Anonymized Search by anonymized
	Anonymized *BooleanFilter `json:"anonymized,omitempty"`

	// CustomServices Nested list search by customServices
	CustomServices *RoutingPlanCustomServicesListFilter `json:"customServices,omitempty"`

	// DeliveryPreferences Nested search by deliveryPreferences
	DeliveryPreferences *RoutingPlanDeliveryPreferencesFilter `json:"deliveryPreferences,omitempty"`

	// EarliestPickingStart Nested search by earliestPickingStart
	EarliestPickingStart *RoutingPlanEarliestPickingStartFilter `json:"earliestPickingStart,omitempty"`

	// History Nested list search by history
	History *RoutingPlanHistoryListFilter `json:"history,omitempty"`

	// LatestPickingStart Nested search by latestPickingStart
	LatestPickingStart *RoutingPlanLatestPickingStartFilter `json:"latestPickingStart,omitempty"`
	Or                 *[]RoutingPlanSearchQuery            `json:"or,omitempty"`

	// OrderDate Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	//
	// Example: 2026-06-17T12:00:00.000Z
	OrderDate *DateFilter `json:"orderDate,omitempty"`

	// OrderLineItems Nested list search by orderLineItems
	OrderLineItems *RoutingPlanOrderLineItemsListFilter `json:"orderLineItems,omitempty"`

	// OrderRef Search by orderRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	OrderRef *StringFilter `json:"orderRef,omitempty"`

	// PickJobRef Search by pickJobRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	PickJobRef *StringFilter `json:"pickJobRef,omitempty"`

	// Priority Search by priority
	Priority *NumberFilter `json:"priority,omitempty"`

	// ProcessId Search by processId
	ProcessId *StringFilter `json:"processId,omitempty"`

	// ProvisioningTime Search by provisioningTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	ProvisioningTime *DateFilter `json:"provisioningTime,omitempty"`

	// ReRouteReason Search by reRouteReason
	ReRouteReason *StringFilter `json:"reRouteReason,omitempty"`

	// SplitCount Search by splitCount
	SplitCount *NumberFilter `json:"splitCount,omitempty"`

	// Status Search by status
	Status *RoutingPlanStatusEnumFilter `json:"status,omitempty"`

	// StatusReasons Nested list search by statusReasons
	StatusReasons *RoutingPlanStatusReasonsListFilter `json:"statusReasons,omitempty"`

	// TargetAddress Nested search by targetAddress
	TargetAddress *RoutingPlanTargetAddressFilter `json:"targetAddress,omitempty"`
}

RoutingPlanSearchQuery RoutingPlanSearchQuery

type RoutingPlanStatusEnumFilter

type RoutingPlanStatusEnumFilter struct {
	// Eq Search by status
	Eq *RoutingPlanStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]RoutingPlanStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *RoutingPlanStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

RoutingPlanStatusEnumFilter RoutingPlanStatusEnumFilter

type RoutingPlanStatusEnumFilterEq

type RoutingPlanStatusEnumFilterEq string

RoutingPlanStatusEnumFilterEq Search by status

const (
	RoutingPlanStatusEnumFilterEqCANCELED         RoutingPlanStatusEnumFilterEq = "CANCELED"
	RoutingPlanStatusEnumFilterEqFAILED           RoutingPlanStatusEnumFilterEq = "FAILED"
	RoutingPlanStatusEnumFilterEqFAILEDREROUTE    RoutingPlanStatusEnumFilterEq = "FAILED_REROUTE"
	RoutingPlanStatusEnumFilterEqFALLBACKROUTING  RoutingPlanStatusEnumFilterEq = "FALLBACK_ROUTING"
	RoutingPlanStatusEnumFilterEqINITIAL          RoutingPlanStatusEnumFilterEq = "INITIAL"
	RoutingPlanStatusEnumFilterEqINPREPARATION    RoutingPlanStatusEnumFilterEq = "IN_PREPARATION"
	RoutingPlanStatusEnumFilterEqLOCKED           RoutingPlanStatusEnumFilterEq = "LOCKED"
	RoutingPlanStatusEnumFilterEqMANUALPLANNED    RoutingPlanStatusEnumFilterEq = "MANUAL_PLANNED"
	RoutingPlanStatusEnumFilterEqNOTROUTABLE      RoutingPlanStatusEnumFilterEq = "NOT_ROUTABLE"
	RoutingPlanStatusEnumFilterEqOBSOLETE         RoutingPlanStatusEnumFilterEq = "OBSOLETE"
	RoutingPlanStatusEnumFilterEqPLANNED          RoutingPlanStatusEnumFilterEq = "PLANNED"
	RoutingPlanStatusEnumFilterEqPRIORITIZED      RoutingPlanStatusEnumFilterEq = "PRIORITIZED"
	RoutingPlanStatusEnumFilterEqPROMISED         RoutingPlanStatusEnumFilterEq = "PROMISED"
	RoutingPlanStatusEnumFilterEqPROPOSED         RoutingPlanStatusEnumFilterEq = "PROPOSED"
	RoutingPlanStatusEnumFilterEqREDUNDANTREROUTE RoutingPlanStatusEnumFilterEq = "REDUNDANT_REROUTE"
	RoutingPlanStatusEnumFilterEqREROUTED         RoutingPlanStatusEnumFilterEq = "REROUTED"
	RoutingPlanStatusEnumFilterEqRETRYABLE        RoutingPlanStatusEnumFilterEq = "RETRYABLE"
	RoutingPlanStatusEnumFilterEqROUTED           RoutingPlanStatusEnumFilterEq = "ROUTED"
	RoutingPlanStatusEnumFilterEqROUTING          RoutingPlanStatusEnumFilterEq = "ROUTING"
	RoutingPlanStatusEnumFilterEqWAITING          RoutingPlanStatusEnumFilterEq = "WAITING"
)

Defines values for RoutingPlanStatusEnumFilterEq.

func (RoutingPlanStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the RoutingPlanStatusEnumFilterEq enum.

type RoutingPlanStatusEnumFilterIn

type RoutingPlanStatusEnumFilterIn string

RoutingPlanStatusEnumFilterIn defines model for RoutingPlanStatusEnumFilter.In.

const (
	RoutingPlanStatusEnumFilterInCANCELED         RoutingPlanStatusEnumFilterIn = "CANCELED"
	RoutingPlanStatusEnumFilterInFAILED           RoutingPlanStatusEnumFilterIn = "FAILED"
	RoutingPlanStatusEnumFilterInFAILEDREROUTE    RoutingPlanStatusEnumFilterIn = "FAILED_REROUTE"
	RoutingPlanStatusEnumFilterInFALLBACKROUTING  RoutingPlanStatusEnumFilterIn = "FALLBACK_ROUTING"
	RoutingPlanStatusEnumFilterInINITIAL          RoutingPlanStatusEnumFilterIn = "INITIAL"
	RoutingPlanStatusEnumFilterInINPREPARATION    RoutingPlanStatusEnumFilterIn = "IN_PREPARATION"
	RoutingPlanStatusEnumFilterInLOCKED           RoutingPlanStatusEnumFilterIn = "LOCKED"
	RoutingPlanStatusEnumFilterInMANUALPLANNED    RoutingPlanStatusEnumFilterIn = "MANUAL_PLANNED"
	RoutingPlanStatusEnumFilterInNOTROUTABLE      RoutingPlanStatusEnumFilterIn = "NOT_ROUTABLE"
	RoutingPlanStatusEnumFilterInOBSOLETE         RoutingPlanStatusEnumFilterIn = "OBSOLETE"
	RoutingPlanStatusEnumFilterInPLANNED          RoutingPlanStatusEnumFilterIn = "PLANNED"
	RoutingPlanStatusEnumFilterInPRIORITIZED      RoutingPlanStatusEnumFilterIn = "PRIORITIZED"
	RoutingPlanStatusEnumFilterInPROMISED         RoutingPlanStatusEnumFilterIn = "PROMISED"
	RoutingPlanStatusEnumFilterInPROPOSED         RoutingPlanStatusEnumFilterIn = "PROPOSED"
	RoutingPlanStatusEnumFilterInREDUNDANTREROUTE RoutingPlanStatusEnumFilterIn = "REDUNDANT_REROUTE"
	RoutingPlanStatusEnumFilterInREROUTED         RoutingPlanStatusEnumFilterIn = "REROUTED"
	RoutingPlanStatusEnumFilterInRETRYABLE        RoutingPlanStatusEnumFilterIn = "RETRYABLE"
	RoutingPlanStatusEnumFilterInROUTED           RoutingPlanStatusEnumFilterIn = "ROUTED"
	RoutingPlanStatusEnumFilterInROUTING          RoutingPlanStatusEnumFilterIn = "ROUTING"
	RoutingPlanStatusEnumFilterInWAITING          RoutingPlanStatusEnumFilterIn = "WAITING"
)

Defines values for RoutingPlanStatusEnumFilterIn.

func (RoutingPlanStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the RoutingPlanStatusEnumFilterIn enum.

type RoutingPlanStatusEnumFilterNotEq

type RoutingPlanStatusEnumFilterNotEq string

RoutingPlanStatusEnumFilterNotEq Search by status

const (
	RoutingPlanStatusEnumFilterNotEqCANCELED         RoutingPlanStatusEnumFilterNotEq = "CANCELED"
	RoutingPlanStatusEnumFilterNotEqFAILED           RoutingPlanStatusEnumFilterNotEq = "FAILED"
	RoutingPlanStatusEnumFilterNotEqFAILEDREROUTE    RoutingPlanStatusEnumFilterNotEq = "FAILED_REROUTE"
	RoutingPlanStatusEnumFilterNotEqFALLBACKROUTING  RoutingPlanStatusEnumFilterNotEq = "FALLBACK_ROUTING"
	RoutingPlanStatusEnumFilterNotEqINITIAL          RoutingPlanStatusEnumFilterNotEq = "INITIAL"
	RoutingPlanStatusEnumFilterNotEqINPREPARATION    RoutingPlanStatusEnumFilterNotEq = "IN_PREPARATION"
	RoutingPlanStatusEnumFilterNotEqLOCKED           RoutingPlanStatusEnumFilterNotEq = "LOCKED"
	RoutingPlanStatusEnumFilterNotEqMANUALPLANNED    RoutingPlanStatusEnumFilterNotEq = "MANUAL_PLANNED"
	RoutingPlanStatusEnumFilterNotEqNOTROUTABLE      RoutingPlanStatusEnumFilterNotEq = "NOT_ROUTABLE"
	RoutingPlanStatusEnumFilterNotEqOBSOLETE         RoutingPlanStatusEnumFilterNotEq = "OBSOLETE"
	RoutingPlanStatusEnumFilterNotEqPLANNED          RoutingPlanStatusEnumFilterNotEq = "PLANNED"
	RoutingPlanStatusEnumFilterNotEqPRIORITIZED      RoutingPlanStatusEnumFilterNotEq = "PRIORITIZED"
	RoutingPlanStatusEnumFilterNotEqPROMISED         RoutingPlanStatusEnumFilterNotEq = "PROMISED"
	RoutingPlanStatusEnumFilterNotEqPROPOSED         RoutingPlanStatusEnumFilterNotEq = "PROPOSED"
	RoutingPlanStatusEnumFilterNotEqREDUNDANTREROUTE RoutingPlanStatusEnumFilterNotEq = "REDUNDANT_REROUTE"
	RoutingPlanStatusEnumFilterNotEqREROUTED         RoutingPlanStatusEnumFilterNotEq = "REROUTED"
	RoutingPlanStatusEnumFilterNotEqRETRYABLE        RoutingPlanStatusEnumFilterNotEq = "RETRYABLE"
	RoutingPlanStatusEnumFilterNotEqROUTED           RoutingPlanStatusEnumFilterNotEq = "ROUTED"
	RoutingPlanStatusEnumFilterNotEqROUTING          RoutingPlanStatusEnumFilterNotEq = "ROUTING"
	RoutingPlanStatusEnumFilterNotEqWAITING          RoutingPlanStatusEnumFilterNotEq = "WAITING"
)

Defines values for RoutingPlanStatusEnumFilterNotEq.

func (RoutingPlanStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the RoutingPlanStatusEnumFilterNotEq enum.

type RoutingPlanStatusReasonsFilter

type RoutingPlanStatusReasonsFilter struct {
	// Reason Search by reason
	Reason *RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter `json:"reason,omitempty"`

	// Status Search by status
	Status *RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter `json:"status,omitempty"`
}

RoutingPlanStatusReasonsFilter RoutingPlanStatusReasonsFilter

type RoutingPlanStatusReasonsListFilter

type RoutingPlanStatusReasonsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *RoutingPlanStatusReasonsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

RoutingPlanStatusReasonsListFilter RoutingPlanStatusReasonsListFilter

type RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter

type RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter struct {
	// Eq Search by reason
	Eq *RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq `json:"eq,omitempty"`

	// In Search by reason
	In *[]RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by reason
	NotEq *RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq `json:"notEq,omitempty"`
}

RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter

type RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq

type RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq string

RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq Search by reason

const (
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEqMANUALLYASSIGNED      RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq = "MANUALLY_ASSIGNED"
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEqMANUALLYREROUTED      RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq = "MANUALLY_REROUTED"
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEqORDERMODIFIED         RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq = "ORDER_MODIFIED"
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEqREROUTEAFTERSHORTPICK RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq = "REROUTE_AFTER_SHORTPICK"
)

Defines values for RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq.

func (RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq) Valid

Valid indicates whether the value is a known member of the RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterEq enum.

type RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn

type RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn string

RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn defines model for RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter.In.

const (
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterInMANUALLYASSIGNED      RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn = "MANUALLY_ASSIGNED"
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterInMANUALLYREROUTED      RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn = "MANUALLY_REROUTED"
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterInORDERMODIFIED         RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn = "ORDER_MODIFIED"
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterInREROUTEAFTERSHORTPICK RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn = "REROUTE_AFTER_SHORTPICK"
)

Defines values for RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn.

func (RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn) Valid

Valid indicates whether the value is a known member of the RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterIn enum.

type RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq

type RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq string

RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq Search by reason

const (
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEqMANUALLYASSIGNED      RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq = "MANUALLY_ASSIGNED"
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEqMANUALLYREROUTED      RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq = "MANUALLY_REROUTED"
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEqORDERMODIFIED         RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq = "ORDER_MODIFIED"
	RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEqREROUTEAFTERSHORTPICK RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq = "REROUTE_AFTER_SHORTPICK"
)

Defines values for RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq.

func (RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilterNotEq enum.

type RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter

type RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter struct {
	// Eq Search by status
	Eq *RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter

type RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterEq

type RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterEq string

RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterEq Search by status

const (
	RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterEqOBSOLETE RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterEq = "OBSOLETE"
)

Defines values for RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterEq.

func (RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterEq enum.

type RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterIn

type RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterIn string

RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterIn defines model for RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter.In.

const (
	RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterInOBSOLETE RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterIn = "OBSOLETE"
)

Defines values for RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterIn.

func (RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterIn enum.

type RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterNotEq

type RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterNotEq string

RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterNotEq Search by status

const (
	RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterNotEqOBSOLETE RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterNotEq = "OBSOLETE"
)

Defines values for RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterNotEq.

func (RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilterNotEq enum.

type RoutingPlanTargetAddressFilter

type RoutingPlanTargetAddressFilter struct {
	// City Search by city
	//
	// Example: Yellowstone
	City *StringFilter `json:"city,omitempty"`

	// Country Search by country
	//
	// Example: US
	Country *StringFilter `json:"country,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// Province Search by province
	Province *StringFilter `json:"province,omitempty"`

	// Street Search by street
	Street *StringFilter `json:"street,omitempty"`
}

RoutingPlanTargetAddressFilter RoutingPlanTargetAddressFilter

type RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties

type RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties defines model for RoutingPlanTargetAddressFilter.customAttributes.AdditionalProperties.

func (RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties as a BooleanFilter

func (RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties as a DateFilter

func (RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) MarshalJSON

func (*RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*RoutingPlanTargetAddressFilter_CustomAttributes_AdditionalProperties) UnmarshalJSON

type RoutingStrategy added in v0.6.0

type RoutingStrategy struct {
	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// GlobalConfiguration RoutingStrategyGlobalConfiguration
	GlobalConfiguration RoutingStrategyGlobalConfiguration `json:"globalConfiguration"`
	Id                  string                             `json:"id"`

	// InUse Only one strategy can be inUse
	InUse bool `json:"inUse"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`
	Name         *string    `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// Revision The revision of the routing strategy
	//
	// Example: 1
	Revision int `json:"revision"`

	// RootNode RoutingStrategyNode
	RootNode RoutingStrategyNode `json:"rootNode"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version              int64                  `json:"version"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

RoutingStrategy RoutingStrategy

func (RoutingStrategy) Get added in v0.8.0

func (a RoutingStrategy) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for RoutingStrategy. Returns the specified element and whether it was found

func (RoutingStrategy) MarshalJSON added in v0.8.0

func (a RoutingStrategy) MarshalJSON() ([]byte, error)

Override default JSON handling for RoutingStrategy to handle AdditionalProperties

func (*RoutingStrategy) Set added in v0.8.0

func (a *RoutingStrategy) Set(fieldName string, value interface{})

Setter for additional properties for RoutingStrategy

func (*RoutingStrategy) UnmarshalJSON added in v0.8.0

func (a *RoutingStrategy) UnmarshalJSON(b []byte) error

Override default JSON handling for RoutingStrategy to handle AdditionalProperties

type RoutingStrategyActionsParameter added in v0.6.0

type RoutingStrategyActionsParameter struct {
	// contains filtered or unexported fields
}

RoutingStrategyActionsParameter RoutingStrategyActionsParameter

func (RoutingStrategyActionsParameter) AsRoutingStrategyActivateActionParameter added in v0.6.0

func (t RoutingStrategyActionsParameter) AsRoutingStrategyActivateActionParameter() (RoutingStrategyActivateActionParameter, error)

AsRoutingStrategyActivateActionParameter returns the union data inside the RoutingStrategyActionsParameter as a RoutingStrategyActivateActionParameter

func (RoutingStrategyActionsParameter) AsRoutingStrategyCreateCopyActionParameter added in v0.6.0

func (t RoutingStrategyActionsParameter) AsRoutingStrategyCreateCopyActionParameter() (RoutingStrategyCreateCopyActionParameter, error)

AsRoutingStrategyCreateCopyActionParameter returns the union data inside the RoutingStrategyActionsParameter as a RoutingStrategyCreateCopyActionParameter

func (RoutingStrategyActionsParameter) AsRoutingStrategyReplaceConditionActionParameter added in v0.6.0

func (t RoutingStrategyActionsParameter) AsRoutingStrategyReplaceConditionActionParameter() (RoutingStrategyReplaceConditionActionParameter, error)

AsRoutingStrategyReplaceConditionActionParameter returns the union data inside the RoutingStrategyActionsParameter as a RoutingStrategyReplaceConditionActionParameter

func (RoutingStrategyActionsParameter) AsRoutingStrategyReplaceGlobalConfigurationActionParameter added in v0.6.0

func (t RoutingStrategyActionsParameter) AsRoutingStrategyReplaceGlobalConfigurationActionParameter() (RoutingStrategyReplaceGlobalConfigurationActionParameter, error)

AsRoutingStrategyReplaceGlobalConfigurationActionParameter returns the union data inside the RoutingStrategyActionsParameter as a RoutingStrategyReplaceGlobalConfigurationActionParameter

func (RoutingStrategyActionsParameter) AsRoutingStrategyReplaceNodeActionParameter added in v0.6.0

func (t RoutingStrategyActionsParameter) AsRoutingStrategyReplaceNodeActionParameter() (RoutingStrategyReplaceNodeActionParameter, error)

AsRoutingStrategyReplaceNodeActionParameter returns the union data inside the RoutingStrategyActionsParameter as a RoutingStrategyReplaceNodeActionParameter

func (*RoutingStrategyActionsParameter) FromRoutingStrategyActivateActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) FromRoutingStrategyActivateActionParameter(v RoutingStrategyActivateActionParameter) error

FromRoutingStrategyActivateActionParameter overwrites any union data inside the RoutingStrategyActionsParameter as the provided RoutingStrategyActivateActionParameter

func (*RoutingStrategyActionsParameter) FromRoutingStrategyCreateCopyActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) FromRoutingStrategyCreateCopyActionParameter(v RoutingStrategyCreateCopyActionParameter) error

FromRoutingStrategyCreateCopyActionParameter overwrites any union data inside the RoutingStrategyActionsParameter as the provided RoutingStrategyCreateCopyActionParameter

func (*RoutingStrategyActionsParameter) FromRoutingStrategyReplaceConditionActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) FromRoutingStrategyReplaceConditionActionParameter(v RoutingStrategyReplaceConditionActionParameter) error

FromRoutingStrategyReplaceConditionActionParameter overwrites any union data inside the RoutingStrategyActionsParameter as the provided RoutingStrategyReplaceConditionActionParameter

func (*RoutingStrategyActionsParameter) FromRoutingStrategyReplaceGlobalConfigurationActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) FromRoutingStrategyReplaceGlobalConfigurationActionParameter(v RoutingStrategyReplaceGlobalConfigurationActionParameter) error

FromRoutingStrategyReplaceGlobalConfigurationActionParameter overwrites any union data inside the RoutingStrategyActionsParameter as the provided RoutingStrategyReplaceGlobalConfigurationActionParameter

func (*RoutingStrategyActionsParameter) FromRoutingStrategyReplaceNodeActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) FromRoutingStrategyReplaceNodeActionParameter(v RoutingStrategyReplaceNodeActionParameter) error

FromRoutingStrategyReplaceNodeActionParameter overwrites any union data inside the RoutingStrategyActionsParameter as the provided RoutingStrategyReplaceNodeActionParameter

func (RoutingStrategyActionsParameter) MarshalJSON added in v0.6.0

func (t RoutingStrategyActionsParameter) MarshalJSON() ([]byte, error)

func (*RoutingStrategyActionsParameter) MergeRoutingStrategyActivateActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) MergeRoutingStrategyActivateActionParameter(v RoutingStrategyActivateActionParameter) error

MergeRoutingStrategyActivateActionParameter performs a merge with any union data inside the RoutingStrategyActionsParameter, using the provided RoutingStrategyActivateActionParameter

func (*RoutingStrategyActionsParameter) MergeRoutingStrategyCreateCopyActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) MergeRoutingStrategyCreateCopyActionParameter(v RoutingStrategyCreateCopyActionParameter) error

MergeRoutingStrategyCreateCopyActionParameter performs a merge with any union data inside the RoutingStrategyActionsParameter, using the provided RoutingStrategyCreateCopyActionParameter

func (*RoutingStrategyActionsParameter) MergeRoutingStrategyReplaceConditionActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) MergeRoutingStrategyReplaceConditionActionParameter(v RoutingStrategyReplaceConditionActionParameter) error

MergeRoutingStrategyReplaceConditionActionParameter performs a merge with any union data inside the RoutingStrategyActionsParameter, using the provided RoutingStrategyReplaceConditionActionParameter

func (*RoutingStrategyActionsParameter) MergeRoutingStrategyReplaceGlobalConfigurationActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) MergeRoutingStrategyReplaceGlobalConfigurationActionParameter(v RoutingStrategyReplaceGlobalConfigurationActionParameter) error

MergeRoutingStrategyReplaceGlobalConfigurationActionParameter performs a merge with any union data inside the RoutingStrategyActionsParameter, using the provided RoutingStrategyReplaceGlobalConfigurationActionParameter

func (*RoutingStrategyActionsParameter) MergeRoutingStrategyReplaceNodeActionParameter added in v0.6.0

func (t *RoutingStrategyActionsParameter) MergeRoutingStrategyReplaceNodeActionParameter(v RoutingStrategyReplaceNodeActionParameter) error

MergeRoutingStrategyReplaceNodeActionParameter performs a merge with any union data inside the RoutingStrategyActionsParameter, using the provided RoutingStrategyReplaceNodeActionParameter

func (*RoutingStrategyActionsParameter) UnmarshalJSON added in v0.6.0

func (t *RoutingStrategyActionsParameter) UnmarshalJSON(b []byte) error

type RoutingStrategyActivateActionParameter added in v0.6.0

type RoutingStrategyActivateActionParameter struct {
	Name RoutingStrategyActivateActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

RoutingStrategyActivateActionParameter Action to activate a routing strategy.

type RoutingStrategyActivateActionParameterName added in v0.8.0

type RoutingStrategyActivateActionParameterName string

RoutingStrategyActivateActionParameterName defines model for RoutingStrategyActivateActionParameter.Name.

const (
	ACTIVATE RoutingStrategyActivateActionParameterName = "ACTIVATE"
)

Defines values for RoutingStrategyActivateActionParameterName.

func (RoutingStrategyActivateActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the RoutingStrategyActivateActionParameterName enum.

type RoutingStrategyCondition

type RoutingStrategyCondition struct {
	ActivationTimeFrames *[]ActivationTimeFrame `json:"activationTimeFrames,omitempty"`
	Active               bool                   `json:"active"`
	Description          *string                `json:"description,omitempty"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`
	Id                   string        `json:"id"`
	Name                 *string       `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// NextCondition RoutingStrategyCondition
	NextCondition *RoutingStrategyCondition `json:"nextCondition,omitempty"`

	// NextNode RoutingStrategyNode
	NextNode RoutingStrategyNode `json:"nextNode"`

	// Rule RoutingStrategyConditionRule
	Rule RoutingStrategyConditionRule `json:"rule"`
}

RoutingStrategyCondition RoutingStrategyCondition

type RoutingStrategyConditionForCreation

type RoutingStrategyConditionForCreation struct {
	ActivationTimeFrames *[]ActivationTimeFrame `json:"activationTimeFrames,omitempty"`
	Active               bool                   `json:"active"`
	Description          *string                `json:"description,omitempty"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`
	Name                 *string       `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// NextCondition RoutingStrategyConditionForCreation
	NextCondition *RoutingStrategyConditionForCreation `json:"nextCondition,omitempty"`

	// NextNode RoutingStrategyNodeForCreation
	NextNode RoutingStrategyNodeForCreation `json:"nextNode"`

	// Rule RoutingStrategyConditionRule
	Rule RoutingStrategyConditionRule `json:"rule"`
}

RoutingStrategyConditionForCreation RoutingStrategyConditionForCreation

type RoutingStrategyConditionForModification

type RoutingStrategyConditionForModification struct {
	ActivationTimeFrames *[]ActivationTimeFrame `json:"activationTimeFrames,omitempty"`
	Active               bool                   `json:"active"`
	Description          *string                `json:"description,omitempty"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`
	Name                 *string       `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// NextCondition RoutingStrategyConditionForModification
	NextCondition *RoutingStrategyConditionForModification `json:"nextCondition,omitempty"`

	// NextNode RoutingStrategyNodeForModification
	NextNode RoutingStrategyNodeForModification `json:"nextNode"`

	// Rule RoutingStrategyConditionRule
	Rule RoutingStrategyConditionRule `json:"rule"`
}

RoutingStrategyConditionForModification RoutingStrategyConditionForModification

type RoutingStrategyConditionForReplace added in v0.6.0

type RoutingStrategyConditionForReplace struct {
	ActivationTimeFrames *[]ActivationTimeFrame `json:"activationTimeFrames,omitempty"`
	Active               bool                   `json:"active"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// Rule RoutingStrategyConditionRule
	Rule RoutingStrategyConditionRule `json:"rule"`
}

RoutingStrategyConditionForReplace Condition data for replacing a condition in a routing strategy.

type RoutingStrategyConditionPredicate

type RoutingStrategyConditionPredicate struct {
	// EntityOperator The possible operator types that can be used on given entities
	EntityOperator ToolkitEntityOperatorType                        `json:"entityOperator"`
	ExpectedValue  *RoutingStrategyConditionPredicate_ExpectedValue `json:"expectedValue,omitempty"`
	PropertyPath   string                                           `json:"propertyPath"`

	// Transformation The transformations available to apply on the entity property value before a predicate is evaluated
	Transformation     *ToolkitTransformationType                                   `json:"transformation,omitempty"`
	TransformationArgs *[]RoutingStrategyConditionPredicate_TransformationArgs_Item `json:"transformationArgs,omitempty"`
}

RoutingStrategyConditionPredicate The predicate for a routing strategy condition rule

type RoutingStrategyConditionPredicateExpectedValue0

type RoutingStrategyConditionPredicateExpectedValue0 = string

RoutingStrategyConditionPredicateExpectedValue0 defines model for RoutingStrategyConditionPredicate.ExpectedValue.0.

type RoutingStrategyConditionPredicateExpectedValue1

type RoutingStrategyConditionPredicateExpectedValue1 = float32

RoutingStrategyConditionPredicateExpectedValue1 defines model for RoutingStrategyConditionPredicate.ExpectedValue.1.

type RoutingStrategyConditionPredicateExpectedValue2

type RoutingStrategyConditionPredicateExpectedValue2 = bool

RoutingStrategyConditionPredicateExpectedValue2 defines model for RoutingStrategyConditionPredicate.ExpectedValue.2.

type RoutingStrategyConditionPredicateTransformationArgs0

type RoutingStrategyConditionPredicateTransformationArgs0 = string

RoutingStrategyConditionPredicateTransformationArgs0 defines model for RoutingStrategyConditionPredicate.TransformationArgs.0.

type RoutingStrategyConditionPredicateTransformationArgs1

type RoutingStrategyConditionPredicateTransformationArgs1 = float32

RoutingStrategyConditionPredicateTransformationArgs1 defines model for RoutingStrategyConditionPredicate.TransformationArgs.1.

type RoutingStrategyConditionPredicateTransformationArgs2

type RoutingStrategyConditionPredicateTransformationArgs2 = bool

RoutingStrategyConditionPredicateTransformationArgs2 defines model for RoutingStrategyConditionPredicate.TransformationArgs.2.

type RoutingStrategyConditionPredicate_ExpectedValue

type RoutingStrategyConditionPredicate_ExpectedValue struct {
	// contains filtered or unexported fields
}

RoutingStrategyConditionPredicate_ExpectedValue defines model for RoutingStrategyConditionPredicate.ExpectedValue.

func (RoutingStrategyConditionPredicate_ExpectedValue) AsRoutingStrategyConditionPredicateExpectedValue0

func (t RoutingStrategyConditionPredicate_ExpectedValue) AsRoutingStrategyConditionPredicateExpectedValue0() (RoutingStrategyConditionPredicateExpectedValue0, error)

AsRoutingStrategyConditionPredicateExpectedValue0 returns the union data inside the RoutingStrategyConditionPredicate_ExpectedValue as a RoutingStrategyConditionPredicateExpectedValue0

func (RoutingStrategyConditionPredicate_ExpectedValue) AsRoutingStrategyConditionPredicateExpectedValue1

func (t RoutingStrategyConditionPredicate_ExpectedValue) AsRoutingStrategyConditionPredicateExpectedValue1() (RoutingStrategyConditionPredicateExpectedValue1, error)

AsRoutingStrategyConditionPredicateExpectedValue1 returns the union data inside the RoutingStrategyConditionPredicate_ExpectedValue as a RoutingStrategyConditionPredicateExpectedValue1

func (RoutingStrategyConditionPredicate_ExpectedValue) AsRoutingStrategyConditionPredicateExpectedValue2

func (t RoutingStrategyConditionPredicate_ExpectedValue) AsRoutingStrategyConditionPredicateExpectedValue2() (RoutingStrategyConditionPredicateExpectedValue2, error)

AsRoutingStrategyConditionPredicateExpectedValue2 returns the union data inside the RoutingStrategyConditionPredicate_ExpectedValue as a RoutingStrategyConditionPredicateExpectedValue2

func (*RoutingStrategyConditionPredicate_ExpectedValue) FromRoutingStrategyConditionPredicateExpectedValue0

func (t *RoutingStrategyConditionPredicate_ExpectedValue) FromRoutingStrategyConditionPredicateExpectedValue0(v RoutingStrategyConditionPredicateExpectedValue0) error

FromRoutingStrategyConditionPredicateExpectedValue0 overwrites any union data inside the RoutingStrategyConditionPredicate_ExpectedValue as the provided RoutingStrategyConditionPredicateExpectedValue0

func (*RoutingStrategyConditionPredicate_ExpectedValue) FromRoutingStrategyConditionPredicateExpectedValue1

func (t *RoutingStrategyConditionPredicate_ExpectedValue) FromRoutingStrategyConditionPredicateExpectedValue1(v RoutingStrategyConditionPredicateExpectedValue1) error

FromRoutingStrategyConditionPredicateExpectedValue1 overwrites any union data inside the RoutingStrategyConditionPredicate_ExpectedValue as the provided RoutingStrategyConditionPredicateExpectedValue1

func (*RoutingStrategyConditionPredicate_ExpectedValue) FromRoutingStrategyConditionPredicateExpectedValue2

func (t *RoutingStrategyConditionPredicate_ExpectedValue) FromRoutingStrategyConditionPredicateExpectedValue2(v RoutingStrategyConditionPredicateExpectedValue2) error

FromRoutingStrategyConditionPredicateExpectedValue2 overwrites any union data inside the RoutingStrategyConditionPredicate_ExpectedValue as the provided RoutingStrategyConditionPredicateExpectedValue2

func (RoutingStrategyConditionPredicate_ExpectedValue) MarshalJSON

func (*RoutingStrategyConditionPredicate_ExpectedValue) MergeRoutingStrategyConditionPredicateExpectedValue0

func (t *RoutingStrategyConditionPredicate_ExpectedValue) MergeRoutingStrategyConditionPredicateExpectedValue0(v RoutingStrategyConditionPredicateExpectedValue0) error

MergeRoutingStrategyConditionPredicateExpectedValue0 performs a merge with any union data inside the RoutingStrategyConditionPredicate_ExpectedValue, using the provided RoutingStrategyConditionPredicateExpectedValue0

func (*RoutingStrategyConditionPredicate_ExpectedValue) MergeRoutingStrategyConditionPredicateExpectedValue1

func (t *RoutingStrategyConditionPredicate_ExpectedValue) MergeRoutingStrategyConditionPredicateExpectedValue1(v RoutingStrategyConditionPredicateExpectedValue1) error

MergeRoutingStrategyConditionPredicateExpectedValue1 performs a merge with any union data inside the RoutingStrategyConditionPredicate_ExpectedValue, using the provided RoutingStrategyConditionPredicateExpectedValue1

func (*RoutingStrategyConditionPredicate_ExpectedValue) MergeRoutingStrategyConditionPredicateExpectedValue2

func (t *RoutingStrategyConditionPredicate_ExpectedValue) MergeRoutingStrategyConditionPredicateExpectedValue2(v RoutingStrategyConditionPredicateExpectedValue2) error

MergeRoutingStrategyConditionPredicateExpectedValue2 performs a merge with any union data inside the RoutingStrategyConditionPredicate_ExpectedValue, using the provided RoutingStrategyConditionPredicateExpectedValue2

func (*RoutingStrategyConditionPredicate_ExpectedValue) UnmarshalJSON

type RoutingStrategyConditionPredicate_TransformationArgs_Item

type RoutingStrategyConditionPredicate_TransformationArgs_Item struct {
	// contains filtered or unexported fields
}

RoutingStrategyConditionPredicate_TransformationArgs_Item defines model for RoutingStrategyConditionPredicate.transformationArgs.Item.

func (RoutingStrategyConditionPredicate_TransformationArgs_Item) AsRoutingStrategyConditionPredicateTransformationArgs0

AsRoutingStrategyConditionPredicateTransformationArgs0 returns the union data inside the RoutingStrategyConditionPredicate_TransformationArgs_Item as a RoutingStrategyConditionPredicateTransformationArgs0

func (RoutingStrategyConditionPredicate_TransformationArgs_Item) AsRoutingStrategyConditionPredicateTransformationArgs1

AsRoutingStrategyConditionPredicateTransformationArgs1 returns the union data inside the RoutingStrategyConditionPredicate_TransformationArgs_Item as a RoutingStrategyConditionPredicateTransformationArgs1

func (RoutingStrategyConditionPredicate_TransformationArgs_Item) AsRoutingStrategyConditionPredicateTransformationArgs2

AsRoutingStrategyConditionPredicateTransformationArgs2 returns the union data inside the RoutingStrategyConditionPredicate_TransformationArgs_Item as a RoutingStrategyConditionPredicateTransformationArgs2

func (*RoutingStrategyConditionPredicate_TransformationArgs_Item) FromRoutingStrategyConditionPredicateTransformationArgs0

FromRoutingStrategyConditionPredicateTransformationArgs0 overwrites any union data inside the RoutingStrategyConditionPredicate_TransformationArgs_Item as the provided RoutingStrategyConditionPredicateTransformationArgs0

func (*RoutingStrategyConditionPredicate_TransformationArgs_Item) FromRoutingStrategyConditionPredicateTransformationArgs1

FromRoutingStrategyConditionPredicateTransformationArgs1 overwrites any union data inside the RoutingStrategyConditionPredicate_TransformationArgs_Item as the provided RoutingStrategyConditionPredicateTransformationArgs1

func (*RoutingStrategyConditionPredicate_TransformationArgs_Item) FromRoutingStrategyConditionPredicateTransformationArgs2

FromRoutingStrategyConditionPredicateTransformationArgs2 overwrites any union data inside the RoutingStrategyConditionPredicate_TransformationArgs_Item as the provided RoutingStrategyConditionPredicateTransformationArgs2

func (RoutingStrategyConditionPredicate_TransformationArgs_Item) MarshalJSON

func (*RoutingStrategyConditionPredicate_TransformationArgs_Item) MergeRoutingStrategyConditionPredicateTransformationArgs0

MergeRoutingStrategyConditionPredicateTransformationArgs0 performs a merge with any union data inside the RoutingStrategyConditionPredicate_TransformationArgs_Item, using the provided RoutingStrategyConditionPredicateTransformationArgs0

func (*RoutingStrategyConditionPredicate_TransformationArgs_Item) MergeRoutingStrategyConditionPredicateTransformationArgs1

MergeRoutingStrategyConditionPredicateTransformationArgs1 performs a merge with any union data inside the RoutingStrategyConditionPredicate_TransformationArgs_Item, using the provided RoutingStrategyConditionPredicateTransformationArgs1

func (*RoutingStrategyConditionPredicate_TransformationArgs_Item) MergeRoutingStrategyConditionPredicateTransformationArgs2

MergeRoutingStrategyConditionPredicateTransformationArgs2 performs a merge with any union data inside the RoutingStrategyConditionPredicate_TransformationArgs_Item, using the provided RoutingStrategyConditionPredicateTransformationArgs2

func (*RoutingStrategyConditionPredicate_TransformationArgs_Item) UnmarshalJSON

type RoutingStrategyConditionRule

type RoutingStrategyConditionRule struct {
	// PredicateConnector The allowed operators for connecting multiple predicates
	PredicateConnector *ToolkitPredicateConnector          `json:"predicateConnector,omitempty"`
	Predicates         []RoutingStrategyConditionPredicate `json:"predicates"`
}

RoutingStrategyConditionRule RoutingStrategyConditionRule

type RoutingStrategyCreateCopyActionParameter added in v0.6.0

type RoutingStrategyCreateCopyActionParameter struct {
	Name RoutingStrategyCreateCopyActionParameterName `json:"name"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

RoutingStrategyCreateCopyActionParameter Action to create a copy of a routing strategy.

type RoutingStrategyCreateCopyActionParameterName added in v0.8.0

type RoutingStrategyCreateCopyActionParameterName string

RoutingStrategyCreateCopyActionParameterName defines model for RoutingStrategyCreateCopyActionParameter.Name.

Defines values for RoutingStrategyCreateCopyActionParameterName.

func (RoutingStrategyCreateCopyActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the RoutingStrategyCreateCopyActionParameterName enum.

type RoutingStrategyEvaluationResult added in v0.6.0

type RoutingStrategyEvaluationResult struct {
	// EvaluatedConfig RoutingStrategyNodeConfig
	EvaluatedConfig RoutingStrategyNodeConfig    `json:"evaluatedConfig"`
	EvaluatedPath   []RoutingStrategyPathElement `json:"evaluatedPath"`
}

RoutingStrategyEvaluationResult RoutingStrategyEvaluationResult

type RoutingStrategyEvaluationResultType added in v0.6.0

type RoutingStrategyEvaluationResultType string

RoutingStrategyEvaluationResultType RoutingStrategyEvaluationResultType

const (
	CONDITIONFALSE    RoutingStrategyEvaluationResultType = "CONDITION_FALSE"
	CONDITIONINACTIVE RoutingStrategyEvaluationResultType = "CONDITION_INACTIVE"
	CONDITIONTRUE     RoutingStrategyEvaluationResultType = "CONDITION_TRUE"
	NODEACTIVE        RoutingStrategyEvaluationResultType = "NODE_ACTIVE"
	NODEINACTIVE      RoutingStrategyEvaluationResultType = "NODE_INACTIVE"
)

Defines values for RoutingStrategyEvaluationResultType.

func (RoutingStrategyEvaluationResultType) Valid added in v0.6.0

Valid indicates whether the value is a known member of the RoutingStrategyEvaluationResultType enum.

type RoutingStrategyFacilityRerouteConfig

type RoutingStrategyFacilityRerouteConfig struct {
	Active *bool `json:"active,omitempty"`

	// RerouteType The type of reroute to apply to the order
	//   * `REROUTE`- the complete routing plan is rerouted.
	//   * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.
	RerouteType RoutingStrategyRerouteType `json:"rerouteType"`
}

RoutingStrategyFacilityRerouteConfig RoutingStrategyFacilityRerouteConfig

type RoutingStrategyFallbackFacilityConfig

type RoutingStrategyFallbackFacilityConfig struct {
	Active       bool     `json:"active"`
	FacilityRefs []string `json:"facilityRefs"`

	// FallbackAfterTime Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.
	FallbackAfterTime string `json:"fallbackAfterTime"`
}

RoutingStrategyFallbackFacilityConfig RoutingStrategyFallbackFacilityConfig

type RoutingStrategyForCreation added in v0.6.0

type RoutingStrategyForCreation struct {
	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`
}

RoutingStrategyForCreation RoutingStrategyForCreation

type RoutingStrategyForModification added in v0.6.0

type RoutingStrategyForModification struct {
	// GlobalConfiguration RoutingStrategyGlobalConfiguration
	GlobalConfiguration *RoutingStrategyGlobalConfiguration `json:"globalConfiguration,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// RootNode RoutingStrategyNodeForModification
	RootNode RoutingStrategyNodeForModification `json:"rootNode"`
	Version  int                                `json:"version"`
}

RoutingStrategyForModification RoutingStrategyForModification

type RoutingStrategyGlobalConfiguration added in v0.6.0

type RoutingStrategyGlobalConfiguration struct {
	// BlacklistAssignedFacilities If true, facilities that have already been assigned to the order in a previous routing attempt will not be considered in the next routing attempt.
	BlacklistAssignedFacilities *bool `json:"blacklistAssignedFacilities,omitempty"`

	// DefaultPrice The price applied when no specific price is defined in the order or listing
	DefaultPrice float32 `json:"defaultPrice"`

	// RestowAfterMinutes The amount of minutes after which a restow is executed. If not set, restows will not be executed.
	RestowAfterMinutes *float32 `json:"restowAfterMinutes,omitempty"`

	// StopRoutingAttemptsAfterTime The amount of time, specified in ISO 8601 duration format, after which a routing plan is considered not routable. Note: The duration must be a multiple of 60 seconds.
	StopRoutingAttemptsAfterTime *string `json:"stopRoutingAttemptsAfterTime,omitempty"`

	// TimeTriggered RoutingStrategyRerouteTimeTriggeredConfig
	TimeTriggered          *RoutingStrategyRerouteTimeTriggeredConfig `json:"timeTriggered,omitempty"`
	TimeTriggeredByContext *[]TimeTriggeredConfigurationContext       `json:"timeTriggeredByContext,omitempty"`
}

RoutingStrategyGlobalConfiguration RoutingStrategyGlobalConfiguration

type RoutingStrategyNode

type RoutingStrategyNode struct {
	ActivationTimeFrames *[]ActivationTimeFrame `json:"activationTimeFrames,omitempty"`
	Active               bool                   `json:"active"`
	CategoryRef          *string                `json:"categoryRef,omitempty"`

	// Config RoutingStrategyNodeConfig
	Config      RoutingStrategyNodeConfig `json:"config"`
	Description *string                   `json:"description,omitempty"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`
	Id                   string        `json:"id"`
	Name                 *string       `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// NextCondition RoutingStrategyCondition
	NextCondition *RoutingStrategyCondition `json:"nextCondition,omitempty"`
}

RoutingStrategyNode RoutingStrategyNode

type RoutingStrategyNodeConfig

type RoutingStrategyNodeConfig struct {
	// FallbackFacility RoutingStrategyFallbackFacilityConfig
	FallbackFacility *RoutingStrategyFallbackFacilityConfig  `json:"fallbackFacility,omitempty"`
	Fences           []RoutingStrategyNodeConfig_Fences_Item `json:"fences"`

	// OrderSplit RoutingStrategyOrderSplitConfig
	OrderSplit *RoutingStrategyOrderSplitConfig `json:"orderSplit,omitempty"`

	// PriorityRatings This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />
	PriorityRatings *[]RoutingStrategyNodeConfig_PriorityRatings_Item `json:"priorityRatings,omitempty"`
	Ratings         []RoutingStrategyNodeConfig_Ratings_Item          `json:"ratings"`

	// Reroute RoutingStrategyRerouteConfig
	Reroute *RoutingStrategyRerouteConfig `json:"reroute,omitempty"`
}

RoutingStrategyNodeConfig RoutingStrategyNodeConfig

type RoutingStrategyNodeConfigCategory added in v0.6.0

type RoutingStrategyNodeConfigCategory struct {
	Color string `json:"color"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`
	Id      string     `json:"id"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

RoutingStrategyNodeConfigCategory RoutingStrategyNodeConfigCategory

type RoutingStrategyNodeConfigCategoryForCreation added in v0.6.0

type RoutingStrategyNodeConfigCategoryForCreation struct {
	Color string `json:"color"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`
}

RoutingStrategyNodeConfigCategoryForCreation RoutingStrategyNodeConfigCategoryForCreation

type RoutingStrategyNodeConfigCategoryForModification added in v0.6.0

type RoutingStrategyNodeConfigCategoryForModification struct {
	Color string `json:"color"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`
	Version       float32      `json:"version"`
}

RoutingStrategyNodeConfigCategoryForModification RoutingStrategyNodeConfigCategoryForModification

type RoutingStrategyNodeConfigCategoryForResponse added in v0.6.0

type RoutingStrategyNodeConfigCategoryForResponse struct {
	Color string `json:"color"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`
	Name         *string    `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

RoutingStrategyNodeConfigCategoryForResponse RoutingStrategyNodeConfigCategoryForResponse

type RoutingStrategyNodeConfigCategoryTransporter added in v0.6.0

type RoutingStrategyNodeConfigCategoryTransporter struct {
	RoutingStrategyNodeConfigCategories []RoutingStrategyNodeConfigCategoryForResponse `json:"routingStrategyNodeConfigCategories"`

	// Total Total number of entities found for this query
	//
	// Example: 42
	Total int `json:"total"`
}

RoutingStrategyNodeConfigCategoryTransporter RoutingStrategyNodeConfigCategoryTransporter

type RoutingStrategyNodeConfigForUpsert

type RoutingStrategyNodeConfigForUpsert struct {
	// FallbackFacility RoutingStrategyFallbackFacilityConfig
	FallbackFacility *RoutingStrategyFallbackFacilityConfig           `json:"fallbackFacility,omitempty"`
	Fences           []RoutingStrategyNodeConfigForUpsert_Fences_Item `json:"fences"`

	// OrderSplit RoutingStrategyOrderSplitConfig
	OrderSplit *RoutingStrategyOrderSplitConfig `json:"orderSplit,omitempty"`

	// PriorityRatings This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />
	PriorityRatings *[]RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item `json:"priorityRatings,omitempty"`
	Ratings         []RoutingStrategyNodeConfigForUpsert_Ratings_Item          `json:"ratings"`

	// Reroute RoutingStrategyRerouteConfig
	Reroute *RoutingStrategyRerouteConfig `json:"reroute,omitempty"`
}

RoutingStrategyNodeConfigForUpsert RoutingStrategyNodeConfigForUpsert

type RoutingStrategyNodeConfigForUpsert_Fences_Item

type RoutingStrategyNodeConfigForUpsert_Fences_Item struct {
	// contains filtered or unexported fields
}

RoutingStrategyNodeConfigForUpsert_Fences_Item defines model for RoutingStrategyNodeConfigForUpsert.fences.Item.

func (RoutingStrategyNodeConfigForUpsert_Fences_Item) AsRoutingStrategyStandardFenceForUpsert

AsRoutingStrategyStandardFenceForUpsert returns the union data inside the RoutingStrategyNodeConfigForUpsert_Fences_Item as a RoutingStrategyStandardFenceForUpsert

func (RoutingStrategyNodeConfigForUpsert_Fences_Item) AsRoutingStrategyToolkitFence

AsRoutingStrategyToolkitFence returns the union data inside the RoutingStrategyNodeConfigForUpsert_Fences_Item as a RoutingStrategyToolkitFence

func (RoutingStrategyNodeConfigForUpsert_Fences_Item) Discriminator

func (*RoutingStrategyNodeConfigForUpsert_Fences_Item) FromRoutingStrategyStandardFenceForUpsert

func (t *RoutingStrategyNodeConfigForUpsert_Fences_Item) FromRoutingStrategyStandardFenceForUpsert(v RoutingStrategyStandardFenceForUpsert) error

FromRoutingStrategyStandardFenceForUpsert overwrites any union data inside the RoutingStrategyNodeConfigForUpsert_Fences_Item as the provided RoutingStrategyStandardFenceForUpsert

func (*RoutingStrategyNodeConfigForUpsert_Fences_Item) FromRoutingStrategyToolkitFence

FromRoutingStrategyToolkitFence overwrites any union data inside the RoutingStrategyNodeConfigForUpsert_Fences_Item as the provided RoutingStrategyToolkitFence

func (RoutingStrategyNodeConfigForUpsert_Fences_Item) MarshalJSON

func (*RoutingStrategyNodeConfigForUpsert_Fences_Item) MergeRoutingStrategyStandardFenceForUpsert

func (t *RoutingStrategyNodeConfigForUpsert_Fences_Item) MergeRoutingStrategyStandardFenceForUpsert(v RoutingStrategyStandardFenceForUpsert) error

MergeRoutingStrategyStandardFenceForUpsert performs a merge with any union data inside the RoutingStrategyNodeConfigForUpsert_Fences_Item, using the provided RoutingStrategyStandardFenceForUpsert

func (*RoutingStrategyNodeConfigForUpsert_Fences_Item) MergeRoutingStrategyToolkitFence

MergeRoutingStrategyToolkitFence performs a merge with any union data inside the RoutingStrategyNodeConfigForUpsert_Fences_Item, using the provided RoutingStrategyToolkitFence

func (*RoutingStrategyNodeConfigForUpsert_Fences_Item) UnmarshalJSON

func (RoutingStrategyNodeConfigForUpsert_Fences_Item) ValueByDiscriminator

func (t RoutingStrategyNodeConfigForUpsert_Fences_Item) ValueByDiscriminator() (interface{}, error)

type RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item added in v0.7.0

type RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item struct {
	// contains filtered or unexported fields
}

RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item defines model for RoutingStrategyNodeConfigForUpsert.priorityRatings.Item.

func (RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) AsRoutingStrategyPriorityRatingForUpsert added in v0.7.0

AsRoutingStrategyPriorityRatingForUpsert returns the union data inside the RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item as a RoutingStrategyPriorityRatingForUpsert

func (RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) AsRoutingStrategyToolkitPriorityRating added in v0.7.0

AsRoutingStrategyToolkitPriorityRating returns the union data inside the RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item as a RoutingStrategyToolkitPriorityRating

func (RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) Discriminator added in v0.7.0

func (*RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) FromRoutingStrategyPriorityRatingForUpsert added in v0.7.0

FromRoutingStrategyPriorityRatingForUpsert overwrites any union data inside the RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item as the provided RoutingStrategyPriorityRatingForUpsert

func (*RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) FromRoutingStrategyToolkitPriorityRating added in v0.7.0

FromRoutingStrategyToolkitPriorityRating overwrites any union data inside the RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item as the provided RoutingStrategyToolkitPriorityRating

func (RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) MarshalJSON added in v0.7.0

func (*RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) MergeRoutingStrategyPriorityRatingForUpsert added in v0.7.0

MergeRoutingStrategyPriorityRatingForUpsert performs a merge with any union data inside the RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item, using the provided RoutingStrategyPriorityRatingForUpsert

func (*RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) MergeRoutingStrategyToolkitPriorityRating added in v0.7.0

MergeRoutingStrategyToolkitPriorityRating performs a merge with any union data inside the RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item, using the provided RoutingStrategyToolkitPriorityRating

func (*RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) UnmarshalJSON added in v0.7.0

func (RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) ValueByDiscriminator added in v0.7.0

func (t RoutingStrategyNodeConfigForUpsert_PriorityRatings_Item) ValueByDiscriminator() (interface{}, error)

type RoutingStrategyNodeConfigForUpsert_Ratings_Item

type RoutingStrategyNodeConfigForUpsert_Ratings_Item struct {
	// contains filtered or unexported fields
}

RoutingStrategyNodeConfigForUpsert_Ratings_Item defines model for RoutingStrategyNodeConfigForUpsert.ratings.Item.

func (RoutingStrategyNodeConfigForUpsert_Ratings_Item) AsRoutingStrategyRatingForUpsert

AsRoutingStrategyRatingForUpsert returns the union data inside the RoutingStrategyNodeConfigForUpsert_Ratings_Item as a RoutingStrategyRatingForUpsert

func (RoutingStrategyNodeConfigForUpsert_Ratings_Item) AsRoutingStrategyToolkitRating

AsRoutingStrategyToolkitRating returns the union data inside the RoutingStrategyNodeConfigForUpsert_Ratings_Item as a RoutingStrategyToolkitRating

func (RoutingStrategyNodeConfigForUpsert_Ratings_Item) Discriminator

func (*RoutingStrategyNodeConfigForUpsert_Ratings_Item) FromRoutingStrategyRatingForUpsert

FromRoutingStrategyRatingForUpsert overwrites any union data inside the RoutingStrategyNodeConfigForUpsert_Ratings_Item as the provided RoutingStrategyRatingForUpsert

func (*RoutingStrategyNodeConfigForUpsert_Ratings_Item) FromRoutingStrategyToolkitRating

FromRoutingStrategyToolkitRating overwrites any union data inside the RoutingStrategyNodeConfigForUpsert_Ratings_Item as the provided RoutingStrategyToolkitRating

func (RoutingStrategyNodeConfigForUpsert_Ratings_Item) MarshalJSON

func (*RoutingStrategyNodeConfigForUpsert_Ratings_Item) MergeRoutingStrategyRatingForUpsert

MergeRoutingStrategyRatingForUpsert performs a merge with any union data inside the RoutingStrategyNodeConfigForUpsert_Ratings_Item, using the provided RoutingStrategyRatingForUpsert

func (*RoutingStrategyNodeConfigForUpsert_Ratings_Item) MergeRoutingStrategyToolkitRating

MergeRoutingStrategyToolkitRating performs a merge with any union data inside the RoutingStrategyNodeConfigForUpsert_Ratings_Item, using the provided RoutingStrategyToolkitRating

func (*RoutingStrategyNodeConfigForUpsert_Ratings_Item) UnmarshalJSON

func (RoutingStrategyNodeConfigForUpsert_Ratings_Item) ValueByDiscriminator

func (t RoutingStrategyNodeConfigForUpsert_Ratings_Item) ValueByDiscriminator() (interface{}, error)

type RoutingStrategyNodeConfig_Fences_Item

type RoutingStrategyNodeConfig_Fences_Item struct {
	// contains filtered or unexported fields
}

RoutingStrategyNodeConfig_Fences_Item defines model for RoutingStrategyNodeConfig.fences.Item.

func (RoutingStrategyNodeConfig_Fences_Item) AsRoutingStrategyStandardFence

func (t RoutingStrategyNodeConfig_Fences_Item) AsRoutingStrategyStandardFence() (RoutingStrategyStandardFence, error)

AsRoutingStrategyStandardFence returns the union data inside the RoutingStrategyNodeConfig_Fences_Item as a RoutingStrategyStandardFence

func (RoutingStrategyNodeConfig_Fences_Item) AsRoutingStrategyToolkitFence

func (t RoutingStrategyNodeConfig_Fences_Item) AsRoutingStrategyToolkitFence() (RoutingStrategyToolkitFence, error)

AsRoutingStrategyToolkitFence returns the union data inside the RoutingStrategyNodeConfig_Fences_Item as a RoutingStrategyToolkitFence

func (RoutingStrategyNodeConfig_Fences_Item) Discriminator

func (t RoutingStrategyNodeConfig_Fences_Item) Discriminator() (string, error)

func (*RoutingStrategyNodeConfig_Fences_Item) FromRoutingStrategyStandardFence

func (t *RoutingStrategyNodeConfig_Fences_Item) FromRoutingStrategyStandardFence(v RoutingStrategyStandardFence) error

FromRoutingStrategyStandardFence overwrites any union data inside the RoutingStrategyNodeConfig_Fences_Item as the provided RoutingStrategyStandardFence

func (*RoutingStrategyNodeConfig_Fences_Item) FromRoutingStrategyToolkitFence

func (t *RoutingStrategyNodeConfig_Fences_Item) FromRoutingStrategyToolkitFence(v RoutingStrategyToolkitFence) error

FromRoutingStrategyToolkitFence overwrites any union data inside the RoutingStrategyNodeConfig_Fences_Item as the provided RoutingStrategyToolkitFence

func (RoutingStrategyNodeConfig_Fences_Item) MarshalJSON

func (t RoutingStrategyNodeConfig_Fences_Item) MarshalJSON() ([]byte, error)

func (*RoutingStrategyNodeConfig_Fences_Item) MergeRoutingStrategyStandardFence

func (t *RoutingStrategyNodeConfig_Fences_Item) MergeRoutingStrategyStandardFence(v RoutingStrategyStandardFence) error

MergeRoutingStrategyStandardFence performs a merge with any union data inside the RoutingStrategyNodeConfig_Fences_Item, using the provided RoutingStrategyStandardFence

func (*RoutingStrategyNodeConfig_Fences_Item) MergeRoutingStrategyToolkitFence

func (t *RoutingStrategyNodeConfig_Fences_Item) MergeRoutingStrategyToolkitFence(v RoutingStrategyToolkitFence) error

MergeRoutingStrategyToolkitFence performs a merge with any union data inside the RoutingStrategyNodeConfig_Fences_Item, using the provided RoutingStrategyToolkitFence

func (*RoutingStrategyNodeConfig_Fences_Item) UnmarshalJSON

func (t *RoutingStrategyNodeConfig_Fences_Item) UnmarshalJSON(b []byte) error

func (RoutingStrategyNodeConfig_Fences_Item) ValueByDiscriminator

func (t RoutingStrategyNodeConfig_Fences_Item) ValueByDiscriminator() (interface{}, error)

type RoutingStrategyNodeConfig_PriorityRatings_Item added in v0.7.0

type RoutingStrategyNodeConfig_PriorityRatings_Item struct {
	// contains filtered or unexported fields
}

RoutingStrategyNodeConfig_PriorityRatings_Item defines model for RoutingStrategyNodeConfig.priorityRatings.Item.

func (RoutingStrategyNodeConfig_PriorityRatings_Item) AsRoutingStrategyStandardPriorityRating added in v0.7.0

AsRoutingStrategyStandardPriorityRating returns the union data inside the RoutingStrategyNodeConfig_PriorityRatings_Item as a RoutingStrategyStandardPriorityRating

func (RoutingStrategyNodeConfig_PriorityRatings_Item) AsRoutingStrategyToolkitPriorityRating added in v0.7.0

AsRoutingStrategyToolkitPriorityRating returns the union data inside the RoutingStrategyNodeConfig_PriorityRatings_Item as a RoutingStrategyToolkitPriorityRating

func (RoutingStrategyNodeConfig_PriorityRatings_Item) Discriminator added in v0.7.0

func (*RoutingStrategyNodeConfig_PriorityRatings_Item) FromRoutingStrategyStandardPriorityRating added in v0.7.0

func (t *RoutingStrategyNodeConfig_PriorityRatings_Item) FromRoutingStrategyStandardPriorityRating(v RoutingStrategyStandardPriorityRating) error

FromRoutingStrategyStandardPriorityRating overwrites any union data inside the RoutingStrategyNodeConfig_PriorityRatings_Item as the provided RoutingStrategyStandardPriorityRating

func (*RoutingStrategyNodeConfig_PriorityRatings_Item) FromRoutingStrategyToolkitPriorityRating added in v0.7.0

func (t *RoutingStrategyNodeConfig_PriorityRatings_Item) FromRoutingStrategyToolkitPriorityRating(v RoutingStrategyToolkitPriorityRating) error

FromRoutingStrategyToolkitPriorityRating overwrites any union data inside the RoutingStrategyNodeConfig_PriorityRatings_Item as the provided RoutingStrategyToolkitPriorityRating

func (RoutingStrategyNodeConfig_PriorityRatings_Item) MarshalJSON added in v0.7.0

func (*RoutingStrategyNodeConfig_PriorityRatings_Item) MergeRoutingStrategyStandardPriorityRating added in v0.7.0

func (t *RoutingStrategyNodeConfig_PriorityRatings_Item) MergeRoutingStrategyStandardPriorityRating(v RoutingStrategyStandardPriorityRating) error

MergeRoutingStrategyStandardPriorityRating performs a merge with any union data inside the RoutingStrategyNodeConfig_PriorityRatings_Item, using the provided RoutingStrategyStandardPriorityRating

func (*RoutingStrategyNodeConfig_PriorityRatings_Item) MergeRoutingStrategyToolkitPriorityRating added in v0.7.0

func (t *RoutingStrategyNodeConfig_PriorityRatings_Item) MergeRoutingStrategyToolkitPriorityRating(v RoutingStrategyToolkitPriorityRating) error

MergeRoutingStrategyToolkitPriorityRating performs a merge with any union data inside the RoutingStrategyNodeConfig_PriorityRatings_Item, using the provided RoutingStrategyToolkitPriorityRating

func (*RoutingStrategyNodeConfig_PriorityRatings_Item) UnmarshalJSON added in v0.7.0

func (RoutingStrategyNodeConfig_PriorityRatings_Item) ValueByDiscriminator added in v0.7.0

func (t RoutingStrategyNodeConfig_PriorityRatings_Item) ValueByDiscriminator() (interface{}, error)

type RoutingStrategyNodeConfig_Ratings_Item

type RoutingStrategyNodeConfig_Ratings_Item struct {
	// contains filtered or unexported fields
}

RoutingStrategyNodeConfig_Ratings_Item defines model for RoutingStrategyNodeConfig.ratings.Item.

func (RoutingStrategyNodeConfig_Ratings_Item) AsRoutingStrategyStandardRating

func (t RoutingStrategyNodeConfig_Ratings_Item) AsRoutingStrategyStandardRating() (RoutingStrategyStandardRating, error)

AsRoutingStrategyStandardRating returns the union data inside the RoutingStrategyNodeConfig_Ratings_Item as a RoutingStrategyStandardRating

func (RoutingStrategyNodeConfig_Ratings_Item) AsRoutingStrategyToolkitRating

func (t RoutingStrategyNodeConfig_Ratings_Item) AsRoutingStrategyToolkitRating() (RoutingStrategyToolkitRating, error)

AsRoutingStrategyToolkitRating returns the union data inside the RoutingStrategyNodeConfig_Ratings_Item as a RoutingStrategyToolkitRating

func (RoutingStrategyNodeConfig_Ratings_Item) Discriminator

func (*RoutingStrategyNodeConfig_Ratings_Item) FromRoutingStrategyStandardRating

func (t *RoutingStrategyNodeConfig_Ratings_Item) FromRoutingStrategyStandardRating(v RoutingStrategyStandardRating) error

FromRoutingStrategyStandardRating overwrites any union data inside the RoutingStrategyNodeConfig_Ratings_Item as the provided RoutingStrategyStandardRating

func (*RoutingStrategyNodeConfig_Ratings_Item) FromRoutingStrategyToolkitRating

func (t *RoutingStrategyNodeConfig_Ratings_Item) FromRoutingStrategyToolkitRating(v RoutingStrategyToolkitRating) error

FromRoutingStrategyToolkitRating overwrites any union data inside the RoutingStrategyNodeConfig_Ratings_Item as the provided RoutingStrategyToolkitRating

func (RoutingStrategyNodeConfig_Ratings_Item) MarshalJSON

func (t RoutingStrategyNodeConfig_Ratings_Item) MarshalJSON() ([]byte, error)

func (*RoutingStrategyNodeConfig_Ratings_Item) MergeRoutingStrategyStandardRating

func (t *RoutingStrategyNodeConfig_Ratings_Item) MergeRoutingStrategyStandardRating(v RoutingStrategyStandardRating) error

MergeRoutingStrategyStandardRating performs a merge with any union data inside the RoutingStrategyNodeConfig_Ratings_Item, using the provided RoutingStrategyStandardRating

func (*RoutingStrategyNodeConfig_Ratings_Item) MergeRoutingStrategyToolkitRating

func (t *RoutingStrategyNodeConfig_Ratings_Item) MergeRoutingStrategyToolkitRating(v RoutingStrategyToolkitRating) error

MergeRoutingStrategyToolkitRating performs a merge with any union data inside the RoutingStrategyNodeConfig_Ratings_Item, using the provided RoutingStrategyToolkitRating

func (*RoutingStrategyNodeConfig_Ratings_Item) UnmarshalJSON

func (t *RoutingStrategyNodeConfig_Ratings_Item) UnmarshalJSON(b []byte) error

func (RoutingStrategyNodeConfig_Ratings_Item) ValueByDiscriminator

func (t RoutingStrategyNodeConfig_Ratings_Item) ValueByDiscriminator() (interface{}, error)

type RoutingStrategyNodeForCreation

type RoutingStrategyNodeForCreation struct {
	ActivationTimeFrames *[]ActivationTimeFrame `json:"activationTimeFrames,omitempty"`
	Active               bool                   `json:"active"`
	CategoryRef          *string                `json:"categoryRef,omitempty"`

	// Config RoutingStrategyNodeConfigForUpsert
	Config      RoutingStrategyNodeConfigForUpsert `json:"config"`
	Description *string                            `json:"description,omitempty"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`
	Name                 *string       `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// NextCondition RoutingStrategyConditionForCreation
	NextCondition *RoutingStrategyConditionForCreation `json:"nextCondition,omitempty"`
}

RoutingStrategyNodeForCreation RoutingStrategyNodeForCreation

type RoutingStrategyNodeForModification

type RoutingStrategyNodeForModification struct {
	ActivationTimeFrames *[]ActivationTimeFrame `json:"activationTimeFrames,omitempty"`
	Active               bool                   `json:"active"`
	CategoryRef          *string                `json:"categoryRef,omitempty"`

	// Config RoutingStrategyNodeConfigForUpsert
	Config      RoutingStrategyNodeConfigForUpsert `json:"config"`
	Description *string                            `json:"description,omitempty"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`
	Name                 *string       `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// NextCondition RoutingStrategyConditionForModification
	NextCondition *RoutingStrategyConditionForModification `json:"nextCondition,omitempty"`
}

RoutingStrategyNodeForModification RoutingStrategyNodeForModification

type RoutingStrategyNodeForReplace added in v0.6.0

type RoutingStrategyNodeForReplace struct {
	ActivationTimeFrames *[]ActivationTimeFrame `json:"activationTimeFrames,omitempty"`
	Active               bool                   `json:"active"`
	CategoryRef          *string                `json:"categoryRef,omitempty"`

	// Config RoutingStrategyNodeConfigForUpsert
	Config RoutingStrategyNodeConfigForUpsert `json:"config"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`
}

RoutingStrategyNodeForReplace Node data for replacing a node in a routing strategy.

type RoutingStrategyOrderSplitConfig

type RoutingStrategyOrderSplitConfig struct {
	Active                                   bool `json:"active"`
	ActiveForSameday                         bool `json:"activeForSameday"`
	MaxSplitCount                            int  `json:"maxSplitCount"`
	ShouldUseWaitingRoomForPreBackOrderItems bool `json:"shouldUseWaitingRoomForPreBackOrderItems"`
}

RoutingStrategyOrderSplitConfig RoutingStrategyOrderSplitConfig

type RoutingStrategyPathElement added in v0.6.0

type RoutingStrategyPathElement struct {
	// EvaluationResult RoutingStrategyEvaluationResultType
	EvaluationResult RoutingStrategyEvaluationResultType `json:"evaluationResult"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`
	Ref           string       `json:"ref"`

	// Type RoutingStrategyPathElementType
	Type RoutingStrategyPathElementType `json:"type"`
}

RoutingStrategyPathElement RoutingStrategyPathElement

type RoutingStrategyPathElementType added in v0.6.0

type RoutingStrategyPathElementType string

RoutingStrategyPathElementType RoutingStrategyPathElementType

const (
	CONDITION RoutingStrategyPathElementType = "CONDITION"
	NODE      RoutingStrategyPathElementType = "NODE"
)

Defines values for RoutingStrategyPathElementType.

func (RoutingStrategyPathElementType) Valid added in v0.6.0

Valid indicates whether the value is a known member of the RoutingStrategyPathElementType enum.

type RoutingStrategyPriorityRatingForUpsert added in v0.7.0

type RoutingStrategyPriorityRatingForUpsert struct {
	Active bool `json:"active"`

	// Configuration Base configuration for ratings. See documentation for details.
	Configuration *AbstractRatingConfiguration `json:"configuration,omitempty"`

	// Implementation This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.
	Implementation RatingImplementation `json:"implementation"`

	// Priority Example: 100
	Priority float32 `json:"priority"`

	// Type Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.
	Type RoutingStrategyStandardPriorityRatingType `json:"type"`
}

RoutingStrategyPriorityRatingForUpsert A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.

type RoutingStrategyRatingForUpsert

type RoutingStrategyRatingForUpsert struct {
	Active bool `json:"active"`

	// Configuration Base configuration for ratings. See documentation for details.
	Configuration *AbstractRatingConfiguration `json:"configuration,omitempty"`

	// Implementation This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.
	Implementation RatingImplementation `json:"implementation"`

	// MaxPenalty Example: 100
	MaxPenalty float32 `json:"maxPenalty"`

	// Type Discriminator identifying a rating as a routing strategy standard rating.
	Type RoutingStrategyStandardRatingType `json:"type"`
}

RoutingStrategyRatingForUpsert A rating is used to rate a set of possible facilities against each other during routing of orders.

type RoutingStrategyReplaceConditionActionParameter added in v0.6.0

type RoutingStrategyReplaceConditionActionParameter struct {
	// Condition Condition data for replacing a condition in a routing strategy.
	Condition   RoutingStrategyConditionForReplace                 `json:"condition"`
	ConditionId string                                             `json:"conditionId"`
	Name        RoutingStrategyReplaceConditionActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

RoutingStrategyReplaceConditionActionParameter Action to replace a condition of a routing strategy.

type RoutingStrategyReplaceConditionActionParameterName added in v0.8.0

type RoutingStrategyReplaceConditionActionParameterName string

RoutingStrategyReplaceConditionActionParameterName defines model for RoutingStrategyReplaceConditionActionParameter.Name.

const (
	REPLACECONDITION RoutingStrategyReplaceConditionActionParameterName = "REPLACE_CONDITION"
)

Defines values for RoutingStrategyReplaceConditionActionParameterName.

func (RoutingStrategyReplaceConditionActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the RoutingStrategyReplaceConditionActionParameterName enum.

type RoutingStrategyReplaceGlobalConfigurationActionParameter added in v0.6.0

type RoutingStrategyReplaceGlobalConfigurationActionParameter struct {
	// GlobalConfiguration RoutingStrategyGlobalConfiguration
	GlobalConfiguration RoutingStrategyGlobalConfiguration                           `json:"globalConfiguration"`
	Name                RoutingStrategyReplaceGlobalConfigurationActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

RoutingStrategyReplaceGlobalConfigurationActionParameter Action to replace the global configuration of a routing strategy.

type RoutingStrategyReplaceGlobalConfigurationActionParameterName added in v0.8.0

type RoutingStrategyReplaceGlobalConfigurationActionParameterName string

RoutingStrategyReplaceGlobalConfigurationActionParameterName defines model for RoutingStrategyReplaceGlobalConfigurationActionParameter.Name.

const (
	REPLACEGLOBALCONFIGURATION RoutingStrategyReplaceGlobalConfigurationActionParameterName = "REPLACE_GLOBAL_CONFIGURATION"
)

Defines values for RoutingStrategyReplaceGlobalConfigurationActionParameterName.

func (RoutingStrategyReplaceGlobalConfigurationActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the RoutingStrategyReplaceGlobalConfigurationActionParameterName enum.

type RoutingStrategyReplaceNodeActionParameter added in v0.6.0

type RoutingStrategyReplaceNodeActionParameter struct {
	Name RoutingStrategyReplaceNodeActionParameterName `json:"name"`

	// Node Node data for replacing a node in a routing strategy.
	Node   RoutingStrategyNodeForReplace `json:"node"`
	NodeId string                        `json:"nodeId"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

RoutingStrategyReplaceNodeActionParameter Action to replace a node of a routing strategy.

type RoutingStrategyReplaceNodeActionParameterName added in v0.8.0

type RoutingStrategyReplaceNodeActionParameterName string

RoutingStrategyReplaceNodeActionParameterName defines model for RoutingStrategyReplaceNodeActionParameter.Name.

const (
	REPLACENODE RoutingStrategyReplaceNodeActionParameterName = "REPLACE_NODE"
)

Defines values for RoutingStrategyReplaceNodeActionParameterName.

func (RoutingStrategyReplaceNodeActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the RoutingStrategyReplaceNodeActionParameterName enum.

type RoutingStrategyRerouteConfig

type RoutingStrategyRerouteConfig struct {
	// ClickAndCollect RoutingStrategyFacilityRerouteConfig
	ClickAndCollect *RoutingStrategyFacilityRerouteConfig `json:"clickAndCollect,omitempty"`
	ManualReroute   *bool                                 `json:"manualReroute,omitempty"`

	// RerouteZeroPicksOnly Specifies whether only pick jobs with zero items picked are eligible for rerouting.
	RerouteZeroPicksOnly *bool `json:"rerouteZeroPicksOnly,omitempty"`

	// ShipFromStore RoutingStrategyFacilityRerouteConfig
	ShipFromStore *RoutingStrategyFacilityRerouteConfig `json:"shipFromStore,omitempty"`
}

RoutingStrategyRerouteConfig RoutingStrategyRerouteConfig

type RoutingStrategyRerouteTimeTriggeredConfig added in v0.6.0

type RoutingStrategyRerouteTimeTriggeredConfig struct {
	// ClickAndCollectReroute RerouteConfiguration
	ClickAndCollectReroute RerouteConfiguration `json:"clickAndCollectReroute"`

	// ShipFromStoreDeliveryReroute RerouteConfiguration
	ShipFromStoreDeliveryReroute RerouteConfiguration `json:"shipFromStoreDeliveryReroute"`

	// ShipFromStoreSamedayReroute RerouteConfiguration
	ShipFromStoreSamedayReroute RerouteConfiguration `json:"shipFromStoreSamedayReroute"`
}

RoutingStrategyRerouteTimeTriggeredConfig RoutingStrategyRerouteTimeTriggeredConfig

type RoutingStrategyRerouteType

type RoutingStrategyRerouteType string

RoutingStrategyRerouteType The type of reroute to apply to the order

  • `REROUTE`- the complete routing plan is rerouted.
  • `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.
const (
	RoutingStrategyRerouteTypeORDERSPLIT RoutingStrategyRerouteType = "ORDERSPLIT"
	RoutingStrategyRerouteTypeREROUTE    RoutingStrategyRerouteType = "REROUTE"
)

Defines values for RoutingStrategyRerouteType.

func (RoutingStrategyRerouteType) Valid

func (e RoutingStrategyRerouteType) Valid() bool

Valid indicates whether the value is a known member of the RoutingStrategyRerouteType enum.

type RoutingStrategyStandardFence

type RoutingStrategyStandardFence struct {
	Active bool `json:"active"`

	// ActiveMode FenceMode
	ActiveMode  *FenceMode `json:"activeMode,omitempty"`
	Description *string    `json:"description,omitempty"`

	// Implementation <i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview">API lifecycle documentation</a></i>
	Implementation FenceImplementation `json:"implementation"`
	Name           *string             `json:"name,omitempty"`
	SupportedModes *[]FenceMode        `json:"supportedModes,omitempty"`

	// Type RoutingStrategyStandardFenceType
	Type RoutingStrategyStandardFenceType `json:"type"`
}

RoutingStrategyStandardFence Routing Strategy Fence.

type RoutingStrategyStandardFenceForUpsert

type RoutingStrategyStandardFenceForUpsert struct {
	Active bool `json:"active"`

	// ActiveMode FenceMode
	ActiveMode *FenceMode `json:"activeMode,omitempty"`

	// Implementation <i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview">API lifecycle documentation</a></i>
	Implementation FenceImplementation `json:"implementation"`

	// Type RoutingStrategyStandardFenceType
	Type RoutingStrategyStandardFenceType `json:"type"`
}

RoutingStrategyStandardFenceForUpsert Routing Strategy Fence.

type RoutingStrategyStandardFenceType

type RoutingStrategyStandardFenceType string

RoutingStrategyStandardFenceType RoutingStrategyStandardFenceType

const (
	StandardFence RoutingStrategyStandardFenceType = "StandardFence"
)

Defines values for RoutingStrategyStandardFenceType.

func (RoutingStrategyStandardFenceType) Valid

Valid indicates whether the value is a known member of the RoutingStrategyStandardFenceType enum.

type RoutingStrategyStandardPriorityRating added in v0.7.0

type RoutingStrategyStandardPriorityRating struct {
	Active bool `json:"active"`

	// Configuration Base configuration for ratings. See documentation for details.
	Configuration *AbstractRatingConfiguration `json:"configuration,omitempty"`
	Description   *string                      `json:"description,omitempty"`

	// Implementation This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.
	Implementation RatingImplementation `json:"implementation"`
	Name           *string              `json:"name,omitempty"`

	// Priority Example: 100
	Priority float32 `json:"priority"`

	// Type Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.
	Type RoutingStrategyStandardPriorityRatingType `json:"type"`
}

RoutingStrategyStandardPriorityRating A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.

type RoutingStrategyStandardPriorityRatingType added in v0.7.0

type RoutingStrategyStandardPriorityRatingType string

RoutingStrategyStandardPriorityRatingType Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.

const (
	StandardPriorityRating RoutingStrategyStandardPriorityRatingType = "StandardPriorityRating"
)

Defines values for RoutingStrategyStandardPriorityRatingType.

func (RoutingStrategyStandardPriorityRatingType) Valid added in v0.7.0

Valid indicates whether the value is a known member of the RoutingStrategyStandardPriorityRatingType enum.

type RoutingStrategyStandardRating

type RoutingStrategyStandardRating struct {
	Active bool `json:"active"`

	// Configuration Base configuration for ratings. See documentation for details.
	Configuration *AbstractRatingConfiguration `json:"configuration,omitempty"`
	Description   *string                      `json:"description,omitempty"`

	// Implementation This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.
	Implementation RatingImplementation `json:"implementation"`

	// MaxPenalty Example: 100
	MaxPenalty float32 `json:"maxPenalty"`
	Name       *string `json:"name,omitempty"`

	// Type Discriminator identifying a rating as a routing strategy standard rating.
	Type RoutingStrategyStandardRatingType `json:"type"`
}

RoutingStrategyStandardRating A rating is used to rate a set of possible facilities against each other during routing of orders.

type RoutingStrategyStandardRatingType

type RoutingStrategyStandardRatingType string

RoutingStrategyStandardRatingType Discriminator identifying a rating as a routing strategy standard rating.

const (
	StandardRating RoutingStrategyStandardRatingType = "StandardRating"
)

Defines values for RoutingStrategyStandardRatingType.

func (RoutingStrategyStandardRatingType) Valid

Valid indicates whether the value is a known member of the RoutingStrategyStandardRatingType enum.

type RoutingStrategyToolkitFence

type RoutingStrategyToolkitFence struct {
	// Active Indicates whether this fence is active or not.
	Active bool `json:"active"`

	// ComparisonRule The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator
	ComparisonRule *ToolkitComparisonRule `json:"comparisonRule,omitempty"`

	// Description The description of this fence.
	//
	// Example: Some text that describes what the fence does.
	Description *string `json:"description,omitempty"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`

	// Entity1 The entities that can be compared by the toolkit fence or rating
	//   * `ORDER`
	//   * `FACILITY`
	//   * `CARRIERCONNECTION`
	//   * `LISTING`
	//   * `ORDERING_FACILITY` - left side only
	//   * `ORDERING_FACILITY_GROUPS` - left side only
	Entity1 *ToolkitAllowedEntities `json:"entity1,omitempty"`

	// Entity2 The entities that can be compared by the toolkit fence or rating
	//   * `ORDER`
	//   * `FACILITY`
	//   * `CARRIERCONNECTION`
	//   * `LISTING`
	//   * `ORDERING_FACILITY` - left side only
	//   * `ORDERING_FACILITY_GROUPS` - left side only
	Entity2 *ToolkitAllowedEntities `json:"entity2,omitempty"`

	// Name The name of the fence.
	//
	// Example: CustomFence
	Name *string `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// Order Order in which this fence is executed
	//
	// Example: 1
	Order       int    `json:"order"`
	ReferenceId string `json:"referenceId"`

	// Rule The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator
	Rule *ToolkitRule `json:"rule,omitempty"`

	// Type RoutingStrategyToolkitFenceType
	Type RoutingStrategyToolkitFenceType `json:"type"`
}

RoutingStrategyToolkitFence Routing Strategy Toolkit Fence.

type RoutingStrategyToolkitFenceType

type RoutingStrategyToolkitFenceType string

RoutingStrategyToolkitFenceType RoutingStrategyToolkitFenceType

const (
	ToolkitFence RoutingStrategyToolkitFenceType = "ToolkitFence"
)

Defines values for RoutingStrategyToolkitFenceType.

func (RoutingStrategyToolkitFenceType) Valid

Valid indicates whether the value is a known member of the RoutingStrategyToolkitFenceType enum.

type RoutingStrategyToolkitPriorityRating added in v0.7.0

type RoutingStrategyToolkitPriorityRating struct {
	Active bool `json:"active"`

	// ComparisonRule The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator
	ComparisonRule *ToolkitComparisonRule `json:"comparisonRule,omitempty"`

	// Description The description of this rating
	//
	// Example: Some text that describes what the rating does.
	Description *string `json:"description,omitempty"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`

	// Entity1 This field is obsolete, was replaced by the entity fields at predicate level.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Entity1 *ToolkitAllowedEntities `json:"entity1,omitempty"`

	// Entity2 This field is obsolete, was replaced by the entity fields at predicate level.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Entity2 *ToolkitAllowedEntities `json:"entity2,omitempty"`

	// Name The name of the rating
	//
	// Example: CustomRating
	Name *string `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`

	// Priority The priority of this rating
	//
	// Example: 100
	Priority    int    `json:"priority"`
	ReferenceId string `json:"referenceId"`

	// Rule The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator
	Rule *ToolkitRule `json:"rule,omitempty"`

	// Type Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.
	Type RoutingStrategyToolkitPriorityRatingType `json:"type"`
}

RoutingStrategyToolkitPriorityRating Routing Strategy Toolkit Rating, ordered by priority.

type RoutingStrategyToolkitPriorityRatingType added in v0.7.0

type RoutingStrategyToolkitPriorityRatingType string

RoutingStrategyToolkitPriorityRatingType Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.

const (
	ToolkitPriorityRating RoutingStrategyToolkitPriorityRatingType = "ToolkitPriorityRating"
)

Defines values for RoutingStrategyToolkitPriorityRatingType.

func (RoutingStrategyToolkitPriorityRatingType) Valid added in v0.7.0

Valid indicates whether the value is a known member of the RoutingStrategyToolkitPriorityRatingType enum.

type RoutingStrategyToolkitRating

type RoutingStrategyToolkitRating struct {
	// Active Indicates whether this rating is active or not
	Active bool `json:"active"`

	// ComparisonRule The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator
	ComparisonRule *ToolkitComparisonRule `json:"comparisonRule,omitempty"`

	// Description The description of this rating
	//
	// Example: Some text that describes what the rating does.
	Description *string `json:"description,omitempty"`

	// DescriptionLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	DescriptionLocalized *LocaleString `json:"descriptionLocalized,omitempty"`

	// Entity1 This field is obsolete, was replaced by the entity fields at predicate level.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Entity1 *ToolkitAllowedEntities `json:"entity1,omitempty"`

	// Entity2 This field is obsolete, was replaced by the entity fields at predicate level.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Entity2 *ToolkitAllowedEntities `json:"entity2,omitempty"`

	// MaxPenalty The maximum penalty this rating can have
	//
	// Example: 100
	MaxPenalty int `json:"maxPenalty"`

	// Name The name of the rating
	//
	// Example: CustomRating
	Name *string `json:"name,omitempty"`

	// NameLocalized Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
	//
	// Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}
	NameLocalized LocaleString `json:"nameLocalized"`
	ReferenceId   string       `json:"referenceId"`

	// Rule The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator
	Rule *ToolkitRule `json:"rule,omitempty"`

	// Type Discriminator identifying a rating as a routing strategy toolkit rating.
	Type RoutingStrategyToolkitRatingType `json:"type"`
}

RoutingStrategyToolkitRating Routing Strategy Toolkit Rating.

type RoutingStrategyToolkitRatingType

type RoutingStrategyToolkitRatingType string

RoutingStrategyToolkitRatingType Discriminator identifying a rating as a routing strategy toolkit rating.

const (
	ToolkitRating RoutingStrategyToolkitRatingType = "ToolkitRating"
)

Defines values for RoutingStrategyToolkitRatingType.

func (RoutingStrategyToolkitRatingType) Valid

Valid indicates whether the value is a known member of the RoutingStrategyToolkitRatingType enum.

type RoutingStrategyTransporter added in v0.6.0

type RoutingStrategyTransporter struct {
	RoutingStrategies []RoutingStrategy `json:"routingStrategies"`

	// Total Total number of entities found for this query
	//
	// Example: 42
	Total int `json:"total"`
}

RoutingStrategyTransporter RoutingStrategyTransporter

type SafetyStock

type SafetyStock struct {
	Created         time.Time `json:"created"`
	FacilityRef     *string   `json:"facilityRef,omitempty"`
	Id              string    `json:"id"`
	LastModified    time.Time `json:"lastModified"`
	TenantArticleId string    `json:"tenantArticleId"`
	Value           float32   `json:"value"`
	Version         float32   `json:"version"`
}

SafetyStock SafetyStock

type SafetyStockBulkOperation

type SafetyStockBulkOperation struct {
	FacilityRef     *string `json:"facilityRef,omitempty"`
	TenantArticleId string  `json:"tenantArticleId"`
	Value           float32 `json:"value"`
}

SafetyStockBulkOperation SafetyStockBulkOperation

type SafetyStockBulkOperationResult

type SafetyStockBulkOperationResult struct {
	// Error BulkOperationError
	Error           *BulkOperationError                  `json:"error,omitempty"`
	FacilityRef     string                               `json:"facilityRef"`
	Status          SafetyStockBulkOperationResultStatus `json:"status"`
	TenantArticleId string                               `json:"tenantArticleId"`
	Value           float32                              `json:"value"`
}

SafetyStockBulkOperationResult SafetyStockBulkOperationResult

type SafetyStockBulkOperationResultStatus

type SafetyStockBulkOperationResultStatus string

SafetyStockBulkOperationResultStatus defines model for SafetyStockBulkOperationResult.Status.

const (
	SafetyStockBulkOperationResultStatusCREATED SafetyStockBulkOperationResultStatus = "CREATED"
	SafetyStockBulkOperationResultStatusFAILED  SafetyStockBulkOperationResultStatus = "FAILED"
	SafetyStockBulkOperationResultStatusUPDATED SafetyStockBulkOperationResultStatus = "UPDATED"
)

Defines values for SafetyStockBulkOperationResultStatus.

func (SafetyStockBulkOperationResultStatus) Valid

Valid indicates whether the value is a known member of the SafetyStockBulkOperationResultStatus enum.

type SafetyStockBulkOperations

type SafetyStockBulkOperations struct {
	Operations []SafetyStockBulkOperation `json:"operations"`
}

SafetyStockBulkOperations SafetyStockBulkOperations

type SafetyStocksPaginatedResult

type SafetyStocksPaginatedResult struct {
	SafetyStocks []SafetyStock `json:"safetyStocks"`
	Total        float32       `json:"total"`
}

SafetyStocksPaginatedResult SafetyStocksPaginatedResult

type ScanningRuleConfiguration

type ScanningRuleConfiguration struct {
	Values *[]ScanningRuleValue `json:"values,omitempty"`
}

ScanningRuleConfiguration Configuration to show the client how the items should be scanned during picking

type ScanningRuleTypeEnum

type ScanningRuleTypeEnum string

ScanningRuleTypeEnum Type of scanning rule

Example: ARTICLE

const (
	ARTICLE  ScanningRuleTypeEnum = "ARTICLE"
	LOCATION ScanningRuleTypeEnum = "LOCATION"
)

Defines values for ScanningRuleTypeEnum.

func (ScanningRuleTypeEnum) Valid

func (e ScanningRuleTypeEnum) Valid() bool

Valid indicates whether the value is a known member of the ScanningRuleTypeEnum enum.

type ScanningRuleValue

type ScanningRuleValue struct {
	// Priority This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.
	Priority float32 `json:"priority"`

	// ScanningRuleType Type of scanning rule
	//
	// Example: ARTICLE
	ScanningRuleType ScanningRuleTypeEnum `json:"scanningRuleType"`
}

ScanningRuleValue ScanningRuleValue

type ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter

type ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter struct {
	// Eq Search by status
	Eq *ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter

type ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEq

type ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEq string

ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEq Search by status

const (
	ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEqACTIVE   ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEq = "ACTIVE"
	ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEqINACTIVE ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEq = "INACTIVE"
)

Defines values for ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEq.

func (ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterEq enum.

type ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterIn

type ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterIn string

ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterIn defines model for ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter.In.

const (
	ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterInACTIVE   ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterIn = "ACTIVE"
	ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterInINACTIVE ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterIn = "INACTIVE"
)

Defines values for ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterIn.

func (ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterIn enum.

type ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEq

type ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEq string

ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEq Search by status

const (
	ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEqACTIVE   ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEq = "ACTIVE"
	ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEqINACTIVE ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEq = "INACTIVE"
)

Defines values for ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEq.

func (ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ScopedAvailabilityConfigEventScopeConfigStatusEnumFilterNotEq enum.

type ScopedAvailabilityConfigSearchQuery

type ScopedAvailabilityConfigSearchQuery struct {
	And *[]ScopedAvailabilityConfigSearchQuery `json:"and,omitempty"`

	// FacilityGroupRefs Search by facilityGroupRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityGroupRefs *StringListFilter `json:"facilityGroupRefs,omitempty"`

	// FacilityRefs Search by facilityRefs
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	FacilityRefs *StringListFilter `json:"facilityRefs,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Key Search by key
	Key *StringSearchFilter                    `json:"key,omitempty"`
	Or  *[]ScopedAvailabilityConfigSearchQuery `json:"or,omitempty"`

	// Status Search by status
	Status *ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter `json:"status,omitempty"`
}

ScopedAvailabilityConfigSearchQuery ScopedAvailabilityConfigSearchQuery

type Score

type Score struct {
	// ScoreName Describes the name of the score for humans to identify
	ScoreName ScoreName `json:"scoreName"`

	// ScoreType Describes what kind of score is represented
	ScoreType ScoreType `json:"scoreType"`

	// ScoreValue Describes the performance of the score
	ScoreValue float32 `json:"scoreValue"`
}

Score Score

type ScoreName

type ScoreName string

ScoreName Describes the name of the score for humans to identify

const (
	ScoreNameEXPIRYDATE      ScoreName = "EXPIRY_DATE"
	ScoreNameRECEIPTDATE     ScoreName = "RECEIPT_DATE"
	ScoreNameRESTOWSEQUENCE  ScoreName = "RESTOW_SEQUENCE"
	ScoreNameRUNNINGSEQUENCE ScoreName = "RUNNING_SEQUENCE"
	ScoreNameZONE            ScoreName = "ZONE"
)

Defines values for ScoreName.

func (ScoreName) Valid

func (e ScoreName) Valid() bool

Valid indicates whether the value is a known member of the ScoreName enum.

type ScoreType

type ScoreType string

ScoreType Describes what kind of score is represented

const (
	RATING   ScoreType = "RATING"
	SEQUENCE ScoreType = "SEQUENCE"
)

Defines values for ScoreType.

func (ScoreType) Valid

func (e ScoreType) Valid() bool

Valid indicates whether the value is a known member of the ScoreType enum.

type SearchFacilityJSONRequestBody

type SearchFacilityJSONRequestBody = FacilitySearchPayload

SearchFacilityJSONRequestBody defines body for SearchFacility for application/json ContentType.

type SearchFacilityResponse

type SearchFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FacilityPaginatedResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseSearchFacilityResponse

func ParseSearchFacilityResponse(rsp *http.Response) (*SearchFacilityResponse, error)

ParseSearchFacilityResponse parses an HTTP response from a SearchFacilityWithResponse call

func (SearchFacilityResponse) ContentType

func (r SearchFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SearchFacilityResponse) GetBody added in v0.8.0

func (r SearchFacilityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SearchFacilityResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SearchFacilityResponse) GetJSON401 added in v0.8.0

func (r SearchFacilityResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SearchFacilityResponse) GetJSON403 added in v0.8.0

func (r SearchFacilityResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (SearchFacilityResponse) Status

func (r SearchFacilityResponse) Status() string

Status returns HTTPResponse.Status

func (SearchFacilityResponse) StatusCode

func (r SearchFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchFilter

type SearchFilter struct {
	// Like Search by regex pattern
	Like *string `json:"like,omitempty"`
}

SearchFilter SearchFilter

type SearchListingJSONRequestBody

type SearchListingJSONRequestBody = ListingSearchPayload

SearchListingJSONRequestBody defines body for SearchListing for application/json ContentType.

type SearchListingResponse

type SearchListingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ListingPaginatedResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseSearchListingResponse

func ParseSearchListingResponse(rsp *http.Response) (*SearchListingResponse, error)

ParseSearchListingResponse parses an HTTP response from a SearchListingWithResponse call

func (SearchListingResponse) ContentType

func (r SearchListingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SearchListingResponse) GetBody added in v0.8.0

func (r SearchListingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SearchListingResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SearchListingResponse) GetJSON401 added in v0.8.0

func (r SearchListingResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SearchListingResponse) GetJSON403 added in v0.8.0

func (r SearchListingResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (SearchListingResponse) Status

func (r SearchListingResponse) Status() string

Status returns HTTPResponse.Status

func (SearchListingResponse) StatusCode

func (r SearchListingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchOptions

type SearchOptions struct {
	// WithTotal Set to true to include the total count of items in the search result.
	WithTotal *bool `json:"withTotal,omitempty"`
}

SearchOptions SearchOptions

type SearchOrderJSONRequestBody added in v0.3.0

type SearchOrderJSONRequestBody = OrderSearchPayload

SearchOrderJSONRequestBody defines body for SearchOrder for application/json ContentType.

type SearchOrderResponse added in v0.3.0

type SearchOrderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *OrderPaginatedResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseSearchOrderResponse added in v0.3.0

func ParseSearchOrderResponse(rsp *http.Response) (*SearchOrderResponse, error)

ParseSearchOrderResponse parses an HTTP response from a SearchOrderWithResponse call

func (SearchOrderResponse) ContentType added in v0.3.0

func (r SearchOrderResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SearchOrderResponse) GetBody added in v0.8.0

func (r SearchOrderResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SearchOrderResponse) GetJSON200 added in v0.8.0

func (r SearchOrderResponse) GetJSON200() *OrderPaginatedResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SearchOrderResponse) GetJSON401 added in v0.8.0

func (r SearchOrderResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SearchOrderResponse) GetJSON403 added in v0.8.0

func (r SearchOrderResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (SearchOrderResponse) Status added in v0.3.0

func (r SearchOrderResponse) Status() string

Status returns HTTPResponse.Status

func (SearchOrderResponse) StatusCode added in v0.3.0

func (r SearchOrderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchRoleJSONRequestBody

type SearchRoleJSONRequestBody = RoleSearchPayload

SearchRoleJSONRequestBody defines body for SearchRole for application/json ContentType.

type SearchRoleResponse

type SearchRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RolePaginatedResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseSearchRoleResponse

func ParseSearchRoleResponse(rsp *http.Response) (*SearchRoleResponse, error)

ParseSearchRoleResponse parses an HTTP response from a SearchRoleWithResponse call

func (SearchRoleResponse) ContentType

func (r SearchRoleResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SearchRoleResponse) GetBody added in v0.8.0

func (r SearchRoleResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SearchRoleResponse) GetJSON200 added in v0.8.0

func (r SearchRoleResponse) GetJSON200() *RolePaginatedResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SearchRoleResponse) GetJSON401 added in v0.8.0

func (r SearchRoleResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SearchRoleResponse) GetJSON403 added in v0.8.0

func (r SearchRoleResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (SearchRoleResponse) Status

func (r SearchRoleResponse) Status() string

Status returns HTTPResponse.Status

func (SearchRoleResponse) StatusCode

func (r SearchRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchStockJSONRequestBody

type SearchStockJSONRequestBody = StockSearchPayload

SearchStockJSONRequestBody defines body for SearchStock for application/json ContentType.

type SearchStockResponse

type SearchStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StockPaginatedResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseSearchStockResponse

func ParseSearchStockResponse(rsp *http.Response) (*SearchStockResponse, error)

ParseSearchStockResponse parses an HTTP response from a SearchStockWithResponse call

func (SearchStockResponse) ContentType

func (r SearchStockResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SearchStockResponse) GetBody added in v0.8.0

func (r SearchStockResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SearchStockResponse) GetJSON200 added in v0.8.0

func (r SearchStockResponse) GetJSON200() *StockPaginatedResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SearchStockResponse) GetJSON401 added in v0.8.0

func (r SearchStockResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SearchStockResponse) GetJSON403 added in v0.8.0

func (r SearchStockResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (SearchStockResponse) Status

func (r SearchStockResponse) Status() string

Status returns HTTPResponse.Status

func (SearchStockResponse) StatusCode

func (r SearchStockResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchUserJSONRequestBody

type SearchUserJSONRequestBody = UserSearchPayload

SearchUserJSONRequestBody defines body for SearchUser for application/json ContentType.

type SearchUserResponse

type SearchUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *UserPaginatedResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseSearchUserResponse

func ParseSearchUserResponse(rsp *http.Response) (*SearchUserResponse, error)

ParseSearchUserResponse parses an HTTP response from a SearchUserWithResponse call

func (SearchUserResponse) ContentType

func (r SearchUserResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SearchUserResponse) GetBody added in v0.8.0

func (r SearchUserResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SearchUserResponse) GetJSON200 added in v0.8.0

func (r SearchUserResponse) GetJSON200() *UserPaginatedResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SearchUserResponse) GetJSON401 added in v0.8.0

func (r SearchUserResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SearchUserResponse) GetJSON403 added in v0.8.0

func (r SearchUserResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (SearchUserResponse) Status

func (r SearchUserResponse) Status() string

Status returns HTTPResponse.Status

func (SearchUserResponse) StatusCode

func (r SearchUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ServiceJobLink struct {
	// Id Unique ID of this service job link
	//
	// Example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad
	Id string `json:"id"`

	// NextServiceJobLinks Links to the next service jobs in the execution chain
	NextServiceJobLinks []ServiceJobLink `json:"nextServiceJobLinks"`

	// PreviousServiceJobLinkRefs id of the created previous service job links
	//
	// Example: ["9f197dbf-c724-469b-90f1-dc94f20b2825"]
	PreviousServiceJobLinkRefs []string `json:"previousServiceJobLinkRefs"`

	// PreviousServiceJobRefs IDs of the preceding service job links that must be completed before this one
	//
	// Example: ["9f197dbf-c724-469b-90f1-dc94f20b2825"]
	PreviousServiceJobRefs []string `json:"previousServiceJobRefs"`

	// ServiceJobRef ID of the service job this link references
	//
	// Example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad
	ServiceJobRef string `json:"serviceJobRef"`
}

ServiceJobLink ServiceJobLink

type ShipmentParcelsFilter

type ShipmentParcelsFilter struct {
	// Status Search by status
	Status *ShipmentParcelsParcelStatusEnumFilter `json:"status,omitempty"`
}

ShipmentParcelsFilter ShipmentParcelsFilter

type ShipmentParcelsListFilter

type ShipmentParcelsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *ShipmentParcelsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

ShipmentParcelsListFilter ShipmentParcelsListFilter

type ShipmentParcelsParcelStatusEnumFilter

type ShipmentParcelsParcelStatusEnumFilter struct {
	// Eq Search by status
	Eq *ShipmentParcelsParcelStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ShipmentParcelsParcelStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ShipmentParcelsParcelStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ShipmentParcelsParcelStatusEnumFilter ShipmentParcelsParcelStatusEnumFilter

type ShipmentParcelsParcelStatusEnumFilterEq

type ShipmentParcelsParcelStatusEnumFilterEq string

ShipmentParcelsParcelStatusEnumFilterEq Search by status

const (
	ShipmentParcelsParcelStatusEnumFilterEqCANCELED        ShipmentParcelsParcelStatusEnumFilterEq = "CANCELED"
	ShipmentParcelsParcelStatusEnumFilterEqDONE            ShipmentParcelsParcelStatusEnumFilterEq = "DONE"
	ShipmentParcelsParcelStatusEnumFilterEqFAILED          ShipmentParcelsParcelStatusEnumFilterEq = "FAILED"
	ShipmentParcelsParcelStatusEnumFilterEqOBSOLETE        ShipmentParcelsParcelStatusEnumFilterEq = "OBSOLETE"
	ShipmentParcelsParcelStatusEnumFilterEqOPEN            ShipmentParcelsParcelStatusEnumFilterEq = "OPEN"
	ShipmentParcelsParcelStatusEnumFilterEqPROCESSING      ShipmentParcelsParcelStatusEnumFilterEq = "PROCESSING"
	ShipmentParcelsParcelStatusEnumFilterEqWAITINGFORINPUT ShipmentParcelsParcelStatusEnumFilterEq = "WAITING_FOR_INPUT"
)

Defines values for ShipmentParcelsParcelStatusEnumFilterEq.

func (ShipmentParcelsParcelStatusEnumFilterEq) Valid

Valid indicates whether the value is a known member of the ShipmentParcelsParcelStatusEnumFilterEq enum.

type ShipmentParcelsParcelStatusEnumFilterIn

type ShipmentParcelsParcelStatusEnumFilterIn string

ShipmentParcelsParcelStatusEnumFilterIn defines model for ShipmentParcelsParcelStatusEnumFilter.In.

const (
	ShipmentParcelsParcelStatusEnumFilterInCANCELED        ShipmentParcelsParcelStatusEnumFilterIn = "CANCELED"
	ShipmentParcelsParcelStatusEnumFilterInDONE            ShipmentParcelsParcelStatusEnumFilterIn = "DONE"
	ShipmentParcelsParcelStatusEnumFilterInFAILED          ShipmentParcelsParcelStatusEnumFilterIn = "FAILED"
	ShipmentParcelsParcelStatusEnumFilterInOBSOLETE        ShipmentParcelsParcelStatusEnumFilterIn = "OBSOLETE"
	ShipmentParcelsParcelStatusEnumFilterInOPEN            ShipmentParcelsParcelStatusEnumFilterIn = "OPEN"
	ShipmentParcelsParcelStatusEnumFilterInPROCESSING      ShipmentParcelsParcelStatusEnumFilterIn = "PROCESSING"
	ShipmentParcelsParcelStatusEnumFilterInWAITINGFORINPUT ShipmentParcelsParcelStatusEnumFilterIn = "WAITING_FOR_INPUT"
)

Defines values for ShipmentParcelsParcelStatusEnumFilterIn.

func (ShipmentParcelsParcelStatusEnumFilterIn) Valid

Valid indicates whether the value is a known member of the ShipmentParcelsParcelStatusEnumFilterIn enum.

type ShipmentParcelsParcelStatusEnumFilterNotEq

type ShipmentParcelsParcelStatusEnumFilterNotEq string

ShipmentParcelsParcelStatusEnumFilterNotEq Search by status

const (
	ShipmentParcelsParcelStatusEnumFilterNotEqCANCELED        ShipmentParcelsParcelStatusEnumFilterNotEq = "CANCELED"
	ShipmentParcelsParcelStatusEnumFilterNotEqDONE            ShipmentParcelsParcelStatusEnumFilterNotEq = "DONE"
	ShipmentParcelsParcelStatusEnumFilterNotEqFAILED          ShipmentParcelsParcelStatusEnumFilterNotEq = "FAILED"
	ShipmentParcelsParcelStatusEnumFilterNotEqOBSOLETE        ShipmentParcelsParcelStatusEnumFilterNotEq = "OBSOLETE"
	ShipmentParcelsParcelStatusEnumFilterNotEqOPEN            ShipmentParcelsParcelStatusEnumFilterNotEq = "OPEN"
	ShipmentParcelsParcelStatusEnumFilterNotEqPROCESSING      ShipmentParcelsParcelStatusEnumFilterNotEq = "PROCESSING"
	ShipmentParcelsParcelStatusEnumFilterNotEqWAITINGFORINPUT ShipmentParcelsParcelStatusEnumFilterNotEq = "WAITING_FOR_INPUT"
)

Defines values for ShipmentParcelsParcelStatusEnumFilterNotEq.

func (ShipmentParcelsParcelStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ShipmentParcelsParcelStatusEnumFilterNotEq enum.

type ShipmentSearchQuery

type ShipmentSearchQuery struct {
	And *[]ShipmentSearchQuery `json:"and,omitempty"`

	// Anonymized Search by anonymized
	Anonymized *BooleanFilter `json:"anonymized,omitempty"`

	// CarrierKey Search by carrierKey
	CarrierKey *StringFilter `json:"carrierKey,omitempty"`

	// CarrierRef Search by carrierRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	CarrierRef *StringFilter `json:"carrierRef,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter          `json:"id,omitempty"`
	Or *[]ShipmentSearchQuery `json:"or,omitempty"`

	// Parcels Nested list search by parcels
	Parcels *ShipmentParcelsListFilter `json:"parcels,omitempty"`

	// PickJobRef Search by pickJobRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	PickJobRef *StringFilter `json:"pickJobRef,omitempty"`

	// Status Search by status
	Status *ShipmentStatusEnumFilter `json:"status,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringFilter `json:"tenantOrderId,omitempty"`
}

ShipmentSearchQuery ShipmentSearchQuery

type ShipmentStatusEnumFilter

type ShipmentStatusEnumFilter struct {
	// Eq Search by status
	Eq *ShipmentStatusEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]ShipmentStatusEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *ShipmentStatusEnumFilterNotEq `json:"notEq,omitempty"`
}

ShipmentStatusEnumFilter ShipmentStatusEnumFilter

type ShipmentStatusEnumFilterEq

type ShipmentStatusEnumFilterEq string

ShipmentStatusEnumFilterEq Search by status

const (
	ShipmentStatusEnumFilterEqCANCELED  ShipmentStatusEnumFilterEq = "CANCELED"
	ShipmentStatusEnumFilterEqCOMPLETED ShipmentStatusEnumFilterEq = "COMPLETED"
	ShipmentStatusEnumFilterEqCONFIRMED ShipmentStatusEnumFilterEq = "CONFIRMED"
	ShipmentStatusEnumFilterEqINITIAL   ShipmentStatusEnumFilterEq = "INITIAL"
	ShipmentStatusEnumFilterEqOBSOLETE  ShipmentStatusEnumFilterEq = "OBSOLETE"
	ShipmentStatusEnumFilterEqREQUEST   ShipmentStatusEnumFilterEq = "REQUEST"
	ShipmentStatusEnumFilterEqRETRYABLE ShipmentStatusEnumFilterEq = "RETRYABLE"
)

Defines values for ShipmentStatusEnumFilterEq.

func (ShipmentStatusEnumFilterEq) Valid

func (e ShipmentStatusEnumFilterEq) Valid() bool

Valid indicates whether the value is a known member of the ShipmentStatusEnumFilterEq enum.

type ShipmentStatusEnumFilterIn

type ShipmentStatusEnumFilterIn string

ShipmentStatusEnumFilterIn defines model for ShipmentStatusEnumFilter.In.

const (
	ShipmentStatusEnumFilterInCANCELED  ShipmentStatusEnumFilterIn = "CANCELED"
	ShipmentStatusEnumFilterInCOMPLETED ShipmentStatusEnumFilterIn = "COMPLETED"
	ShipmentStatusEnumFilterInCONFIRMED ShipmentStatusEnumFilterIn = "CONFIRMED"
	ShipmentStatusEnumFilterInINITIAL   ShipmentStatusEnumFilterIn = "INITIAL"
	ShipmentStatusEnumFilterInOBSOLETE  ShipmentStatusEnumFilterIn = "OBSOLETE"
	ShipmentStatusEnumFilterInREQUEST   ShipmentStatusEnumFilterIn = "REQUEST"
	ShipmentStatusEnumFilterInRETRYABLE ShipmentStatusEnumFilterIn = "RETRYABLE"
)

Defines values for ShipmentStatusEnumFilterIn.

func (ShipmentStatusEnumFilterIn) Valid

func (e ShipmentStatusEnumFilterIn) Valid() bool

Valid indicates whether the value is a known member of the ShipmentStatusEnumFilterIn enum.

type ShipmentStatusEnumFilterNotEq

type ShipmentStatusEnumFilterNotEq string

ShipmentStatusEnumFilterNotEq Search by status

const (
	ShipmentStatusEnumFilterNotEqCANCELED  ShipmentStatusEnumFilterNotEq = "CANCELED"
	ShipmentStatusEnumFilterNotEqCOMPLETED ShipmentStatusEnumFilterNotEq = "COMPLETED"
	ShipmentStatusEnumFilterNotEqCONFIRMED ShipmentStatusEnumFilterNotEq = "CONFIRMED"
	ShipmentStatusEnumFilterNotEqINITIAL   ShipmentStatusEnumFilterNotEq = "INITIAL"
	ShipmentStatusEnumFilterNotEqOBSOLETE  ShipmentStatusEnumFilterNotEq = "OBSOLETE"
	ShipmentStatusEnumFilterNotEqREQUEST   ShipmentStatusEnumFilterNotEq = "REQUEST"
	ShipmentStatusEnumFilterNotEqRETRYABLE ShipmentStatusEnumFilterNotEq = "RETRYABLE"
)

Defines values for ShipmentStatusEnumFilterNotEq.

func (ShipmentStatusEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the ShipmentStatusEnumFilterNotEq enum.

type ShippingCosts added in v0.2.0

type ShippingCosts struct {
	// PackageCosts Costs of the individual packaging units
	PackageCosts *[]PackageCost `json:"packageCosts,omitempty"`

	// TotalTransportCostAmount Money
	TotalTransportCostAmount Money `json:"totalTransportCostAmount"`
}

ShippingCosts ShippingCosts

type ShippingInformationCarrierRecipientInformationAddressFilter

type ShippingInformationCarrierRecipientInformationAddressFilter struct {
	// CompanyName Search by companyName
	CompanyName *StringSearchFilter `json:"companyName,omitempty"`

	// Email Search by email
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *StringSearchFilter `json:"email,omitempty"`

	// FirstName Search by firstName
	FirstName *StringSearchFilter `json:"firstName,omitempty"`

	// LastName Search by lastName
	LastName *StringSearchFilter `json:"lastName,omitempty"`
}

ShippingInformationCarrierRecipientInformationAddressFilter ShippingInformationCarrierRecipientInformationAddressFilter

type ShippingInformationCarrierRecipientInformationAddressListFilter

type ShippingInformationCarrierRecipientInformationAddressListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *ShippingInformationCarrierRecipientInformationAddressFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

ShippingInformationCarrierRecipientInformationAddressListFilter ShippingInformationCarrierRecipientInformationAddressListFilter

type ShippingInformationCarrierRecipientInformationFilter

type ShippingInformationCarrierRecipientInformationFilter struct {
	// Address Nested list search by address
	Address *ShippingInformationCarrierRecipientInformationAddressListFilter `json:"address,omitempty"`
}

ShippingInformationCarrierRecipientInformationFilter ShippingInformationCarrierRecipientInformationFilter

type ShippingInformationCarrierRecipientInformationListFilter

type ShippingInformationCarrierRecipientInformationListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *ShippingInformationCarrierRecipientInformationFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

ShippingInformationCarrierRecipientInformationListFilter ShippingInformationCarrierRecipientInformationListFilter

type ShippingInformationSearchQuery

type ShippingInformationSearchQuery struct {
	And *[]ShippingInformationSearchQuery `json:"and,omitempty"`

	// CarrierRecipientInformation Nested list search by carrierRecipientInformation
	CarrierRecipientInformation *ShippingInformationCarrierRecipientInformationListFilter `json:"carrierRecipientInformation,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter                       `json:"lastModified,omitempty"`
	Or           *[]ShippingInformationSearchQuery `json:"or,omitempty"`

	// ShippingInformationLineItems Nested list search by shippingInformationLineItems
	ShippingInformationLineItems *ShippingInformationShippingInformationLineItemsListFilter `json:"shippingInformationLineItems,omitempty"`

	// ShortId Search by shortId
	ShortId *StringFilter `json:"shortId,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringFilter `json:"tenantOrderId,omitempty"`
}

ShippingInformationSearchQuery ShippingInformationSearchQuery

type ShippingInformationShippingInformationLineItemsArticleFilter

type ShippingInformationShippingInformationLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`

	// Title Search by title
	Title *StringSearchFilter `json:"title,omitempty"`
}

ShippingInformationShippingInformationLineItemsArticleFilter ShippingInformationShippingInformationLineItemsArticleFilter

type ShippingInformationShippingInformationLineItemsFilter

type ShippingInformationShippingInformationLineItemsFilter struct {
	// Article Nested search by article
	Article *ShippingInformationShippingInformationLineItemsArticleFilter `json:"article,omitempty"`
}

ShippingInformationShippingInformationLineItemsFilter ShippingInformationShippingInformationLineItemsFilter

type ShippingInformationShippingInformationLineItemsListFilter

type ShippingInformationShippingInformationLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *ShippingInformationShippingInformationLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

ShippingInformationShippingInformationLineItemsListFilter ShippingInformationShippingInformationLineItemsListFilter

type SimulationOrderConsumerAddressesAddressTypeEnumFilter

type SimulationOrderConsumerAddressesAddressTypeEnumFilter struct {
	// Eq Search by addressType
	Eq *SimulationOrderConsumerAddressesAddressTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by addressType
	In *[]SimulationOrderConsumerAddressesAddressTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by addressType
	NotEq *SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

SimulationOrderConsumerAddressesAddressTypeEnumFilter SimulationOrderConsumerAddressesAddressTypeEnumFilter

type SimulationOrderConsumerAddressesAddressTypeEnumFilterEq

type SimulationOrderConsumerAddressesAddressTypeEnumFilterEq string

SimulationOrderConsumerAddressesAddressTypeEnumFilterEq Search by addressType

const (
	SimulationOrderConsumerAddressesAddressTypeEnumFilterEqINVOICEADDRESS SimulationOrderConsumerAddressesAddressTypeEnumFilterEq = "INVOICE_ADDRESS"
	SimulationOrderConsumerAddressesAddressTypeEnumFilterEqPARCELLOCKER   SimulationOrderConsumerAddressesAddressTypeEnumFilterEq = "PARCEL_LOCKER"
	SimulationOrderConsumerAddressesAddressTypeEnumFilterEqPOSTALADDRESS  SimulationOrderConsumerAddressesAddressTypeEnumFilterEq = "POSTAL_ADDRESS"
)

Defines values for SimulationOrderConsumerAddressesAddressTypeEnumFilterEq.

func (SimulationOrderConsumerAddressesAddressTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the SimulationOrderConsumerAddressesAddressTypeEnumFilterEq enum.

type SimulationOrderConsumerAddressesAddressTypeEnumFilterIn

type SimulationOrderConsumerAddressesAddressTypeEnumFilterIn string

SimulationOrderConsumerAddressesAddressTypeEnumFilterIn defines model for SimulationOrderConsumerAddressesAddressTypeEnumFilter.In.

const (
	SimulationOrderConsumerAddressesAddressTypeEnumFilterInINVOICEADDRESS SimulationOrderConsumerAddressesAddressTypeEnumFilterIn = "INVOICE_ADDRESS"
	SimulationOrderConsumerAddressesAddressTypeEnumFilterInPARCELLOCKER   SimulationOrderConsumerAddressesAddressTypeEnumFilterIn = "PARCEL_LOCKER"
	SimulationOrderConsumerAddressesAddressTypeEnumFilterInPOSTALADDRESS  SimulationOrderConsumerAddressesAddressTypeEnumFilterIn = "POSTAL_ADDRESS"
)

Defines values for SimulationOrderConsumerAddressesAddressTypeEnumFilterIn.

func (SimulationOrderConsumerAddressesAddressTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the SimulationOrderConsumerAddressesAddressTypeEnumFilterIn enum.

type SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq

type SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq string

SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq Search by addressType

const (
	SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEqINVOICEADDRESS SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq = "INVOICE_ADDRESS"
	SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEqPARCELLOCKER   SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq = "PARCEL_LOCKER"
	SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEqPOSTALADDRESS  SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq = "POSTAL_ADDRESS"
)

Defines values for SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq.

func (SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the SimulationOrderConsumerAddressesAddressTypeEnumFilterNotEq enum.

type SimulationOrderConsumerAddressesFilter

type SimulationOrderConsumerAddressesFilter struct {
	// AddressType Search by addressType
	AddressType *SimulationOrderConsumerAddressesAddressTypeEnumFilter `json:"addressType,omitempty"`

	// City Search by city
	//
	// Example: Yellowstone
	City *StringFilter `json:"city,omitempty"`

	// CompanyName Search by companyName
	CompanyName *StringFilter `json:"companyName,omitempty"`

	// Country Search by country
	//
	// Example: US
	Country *StringFilter `json:"country,omitempty"`

	// Email Search by email
	//
	// Example: phil.bison@fulfillmenttools.com
	Email *StringFilter `json:"email,omitempty"`

	// FirstName Search by firstName
	FirstName *StringFilter `json:"firstName,omitempty"`

	// HouseNumber Search by houseNumber
	//
	// Example: 42
	HouseNumber *StringFilter `json:"houseNumber,omitempty"`

	// LastName Search by lastName
	LastName *StringFilter `json:"lastName,omitempty"`

	// PostalCode Search by postalCode
	//
	// Example: 42420
	PostalCode *StringFilter `json:"postalCode,omitempty"`

	// Province Search by province
	Province *StringFilter `json:"province,omitempty"`

	// Street Search by street
	Street *StringFilter `json:"street,omitempty"`
}

SimulationOrderConsumerAddressesFilter SimulationOrderConsumerAddressesFilter

type SimulationOrderConsumerAddressesListFilter

type SimulationOrderConsumerAddressesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *SimulationOrderConsumerAddressesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

SimulationOrderConsumerAddressesListFilter SimulationOrderConsumerAddressesListFilter

type SimulationOrderConsumerFilter

type SimulationOrderConsumerFilter struct {
	// Addresses Nested list search by addresses
	Addresses *SimulationOrderConsumerAddressesListFilter `json:"addresses,omitempty"`

	// ConsumerId Search by consumerId
	ConsumerId *StringFilter `json:"consumerId,omitempty"`
}

SimulationOrderConsumerFilter SimulationOrderConsumerFilter

type SimulationOrderDeliveryPreferencesCollectFilter

type SimulationOrderDeliveryPreferencesCollectFilter struct {
	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Paid Search by paid
	Paid *BooleanFilter `json:"paid,omitempty"`
}

SimulationOrderDeliveryPreferencesCollectFilter SimulationOrderDeliveryPreferencesCollectFilter

type SimulationOrderDeliveryPreferencesCollectListFilter

type SimulationOrderDeliveryPreferencesCollectListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *SimulationOrderDeliveryPreferencesCollectFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

SimulationOrderDeliveryPreferencesCollectListFilter SimulationOrderDeliveryPreferencesCollectListFilter

type SimulationOrderDeliveryPreferencesFilter

type SimulationOrderDeliveryPreferencesFilter struct {
	// Collect Nested list search by collect
	Collect *SimulationOrderDeliveryPreferencesCollectListFilter `json:"collect,omitempty"`

	// Shipping Nested search by shipping
	Shipping *SimulationOrderDeliveryPreferencesShippingFilter `json:"shipping,omitempty"`
}

SimulationOrderDeliveryPreferencesFilter SimulationOrderDeliveryPreferencesFilter

type SimulationOrderDeliveryPreferencesShippingFilter

type SimulationOrderDeliveryPreferencesShippingFilter struct {
	// DesiredDeliveryTime Search by desiredDeliveryTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	DesiredDeliveryTime *DateFilter `json:"desiredDeliveryTime,omitempty"`

	// ServiceLevel Search by serviceLevel
	ServiceLevel *SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter `json:"serviceLevel,omitempty"`
}

SimulationOrderDeliveryPreferencesShippingFilter SimulationOrderDeliveryPreferencesShippingFilter

type SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter

type SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter struct {
	// Eq Search by serviceLevel
	Eq *SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEq `json:"eq,omitempty"`

	// In Search by serviceLevel
	In *[]SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by serviceLevel
	NotEq *SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEq `json:"notEq,omitempty"`
}

SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter

type SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEq

type SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEq string

SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEq Search by serviceLevel

const (
	SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEqDELIVERY SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEq = "DELIVERY"
	SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEqSAMEDAY  SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEq = "SAMEDAY"
)

Defines values for SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEq.

func (SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEq) Valid

Valid indicates whether the value is a known member of the SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterEq enum.

type SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterIn

type SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterIn string

SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterIn defines model for SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter.In.

const (
	SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterInDELIVERY SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterIn = "DELIVERY"
	SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterInSAMEDAY  SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterIn = "SAMEDAY"
)

Defines values for SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterIn.

func (SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterIn) Valid

Valid indicates whether the value is a known member of the SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterIn enum.

type SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEq

type SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEq string

SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEq Search by serviceLevel

const (
	SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEqDELIVERY SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEq = "DELIVERY"
	SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEqSAMEDAY  SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEq = "SAMEDAY"
)

Defines values for SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEq.

func (SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilterNotEq enum.

type SimulationOrderOrderLineItemsArticleFilter

type SimulationOrderOrderLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`

	// Title Search by title
	Title *StringFilter `json:"title,omitempty"`

	// TitleLocalized Nested search by titleLocalized
	TitleLocalized *SimulationOrderOrderLineItemsArticleTitleLocalizedFilter `json:"titleLocalized,omitempty"`
}

SimulationOrderOrderLineItemsArticleFilter SimulationOrderOrderLineItemsArticleFilter

type SimulationOrderOrderLineItemsArticleTitleLocalizedFilter

type SimulationOrderOrderLineItemsArticleTitleLocalizedFilter struct {
	// DeDE Search by de_DE
	DeDE *StringFilter `json:"de_DE,omitempty"`

	// EnUS Search by en_US
	EnUS *StringFilter `json:"en_US,omitempty"`

	// RuRU Search by ru_RU
	RuRU *StringFilter `json:"ru_RU,omitempty"`
}

SimulationOrderOrderLineItemsArticleTitleLocalizedFilter SimulationOrderOrderLineItemsArticleTitleLocalizedFilter

type SimulationOrderOrderLineItemsFilter

type SimulationOrderOrderLineItemsFilter struct {
	// Article Nested search by article
	Article *SimulationOrderOrderLineItemsArticleFilter `json:"article,omitempty"`
}

SimulationOrderOrderLineItemsFilter SimulationOrderOrderLineItemsFilter

type SimulationOrderOrderLineItemsListFilter

type SimulationOrderOrderLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *SimulationOrderOrderLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

SimulationOrderOrderLineItemsListFilter SimulationOrderOrderLineItemsListFilter

type SimulationOrderPaymentInfoFilter

type SimulationOrderPaymentInfoFilter struct {
	// Currency Search by currency
	Currency *StringFilter `json:"currency,omitempty"`

	// Method Search by method
	Method *StringFilter `json:"method,omitempty"`

	// MethodLocalized Nested search by methodLocalized
	MethodLocalized *SimulationOrderPaymentInfoMethodLocalizedFilter `json:"methodLocalized,omitempty"`
}

SimulationOrderPaymentInfoFilter SimulationOrderPaymentInfoFilter

type SimulationOrderPaymentInfoMethodLocalizedFilter

type SimulationOrderPaymentInfoMethodLocalizedFilter struct {
	// DeDE Search by de_DE
	DeDE *StringFilter `json:"de_DE,omitempty"`

	// EnUS Search by en_US
	EnUS *StringFilter `json:"en_US,omitempty"`

	// RuRU Search by ru_RU
	RuRU *StringFilter `json:"ru_RU,omitempty"`
}

SimulationOrderPaymentInfoMethodLocalizedFilter SimulationOrderPaymentInfoMethodLocalizedFilter

type SimulationOrderSearchQuery

type SimulationOrderSearchQuery struct {
	And *[]SimulationOrderSearchQuery `json:"and,omitempty"`

	// Consumer Nested search by consumer
	Consumer *SimulationOrderConsumerFilter `json:"consumer,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// DeliveryPreferences Nested search by deliveryPreferences
	DeliveryPreferences *SimulationOrderDeliveryPreferencesFilter `json:"deliveryPreferences,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter                   `json:"lastModified,omitempty"`
	Or           *[]SimulationOrderSearchQuery `json:"or,omitempty"`

	// OrderDate Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	//
	// Example: 2026-06-17T12:00:00.000Z
	OrderDate *DateFilter `json:"orderDate,omitempty"`

	// OrderLineItems Nested list search by orderLineItems
	OrderLineItems *SimulationOrderOrderLineItemsListFilter `json:"orderLineItems,omitempty"`

	// PaymentInfo Nested search by paymentInfo
	PaymentInfo *SimulationOrderPaymentInfoFilter `json:"paymentInfo,omitempty"`

	// Tags Nested list search by tags
	Tags *SimulationOrderTagsListFilter `json:"tags,omitempty"`

	// TenantOrderId Search by tenantOrderId
	//
	// Example: MY_ORDER_ID
	TenantOrderId *StringFilter `json:"tenantOrderId,omitempty"`
}

SimulationOrderSearchQuery SimulationOrderSearchQuery

type SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties

type SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties defines model for SimulationOrderSearchQuery.customAttributes.AdditionalProperties.

func (SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*SimulationOrderSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type SimulationOrderTagsFilter

type SimulationOrderTagsFilter struct {
	// Value Search by value
	Value *StringFilter `json:"value,omitempty"`
}

SimulationOrderTagsFilter SimulationOrderTagsFilter

type SimulationOrderTagsListFilter

type SimulationOrderTagsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *SimulationOrderTagsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

SimulationOrderTagsListFilter SimulationOrderTagsListFilter

type SourceRef added in v0.3.0

type SourceRef struct {
	SourceRef string `json:"sourceRef"`
}

SourceRef SourceRef

type SourcingOption added in v0.2.0

type SourcingOption struct {
	// EstimatedDeliveryDate Estimated delivery date in format YYYY-MM-DD.
	//
	// Example: 2025-02-05T00:00:00.000Z
	EstimatedDeliveryDate *openapi_types.Date `json:"estimatedDeliveryDate,omitempty"`

	// EstimatedPickupDate Estimated pickup date in format YYYY-MM-DD.
	//
	// Example: 2025-02-05T00:00:00.000Z
	EstimatedPickupDate       *openapi_types.Date             `json:"estimatedPickupDate,omitempty"`
	Id                        string                          `json:"id"`
	ListingDetails            *[]SourcingOptionListingDetails `json:"listingDetails,omitempty"`
	Nodes                     []SourcingOptionNode            `json:"nodes"`
	NonAssignedOrderLineItems *[]HandledItem                  `json:"nonAssignedOrderLineItems,omitempty"`
	PriorityRatingResults     []PriorityRatingResult          `json:"priorityRatingResults"`
	RatingResults             []RatingResult                  `json:"ratingResults"`
	RunId                     string                          `json:"runId"`

	// TotalCosts SourcingOptionCosts
	TotalCosts *SourcingOptionCosts `json:"totalCosts,omitempty"`

	// TotalPenalty The total calculated penalty we calculated for this option
	//
	// Example: 187
	TotalPenalty float32                  `json:"totalPenalty"`
	Transfers    []SourcingOptionTransfer `json:"transfers"`

	// ValidUntil The latest date at which this option is still valid, as an ISO8601 UTC timestamp string.
	//
	// Example: 2025-02-05T08:45:50.525Z
	ValidUntil *string `json:"validUntil,omitempty"`
}

SourcingOption SourcingOption

type SourcingOptionCosts added in v0.2.0

type SourcingOptionCosts struct {
	// SalesPrices Sales prices and applied discounts of the individual items in the solution. Only present if costComponentRating is enabled.
	SalesPrices []SourcingOptionSalesPrice `json:"salesPrices"`

	// TotalCosts Money
	TotalCosts *Money `json:"totalCosts,omitempty"`

	// TotalSalesPriceAmount Money
	TotalSalesPriceAmount *Money `json:"totalSalesPriceAmount,omitempty"`

	// TotalShippingCosts ShippingCosts
	TotalShippingCosts *ShippingCosts `json:"totalShippingCosts,omitempty"`
}

SourcingOptionCosts SourcingOptionCosts

type SourcingOptionListingDetails added in v0.2.0

type SourcingOptionListingDetails struct {
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// FacilityRef Example: abcd-efgh-ijkl-mnop
	FacilityRef *string `json:"facilityRef,omitempty"`

	// TenantArticleId Example: CGN-4711
	TenantArticleId *string `json:"tenantArticleId,omitempty"`
}

SourcingOptionListingDetails SourcingOptionListingDetails

type SourcingOptionNode added in v0.2.0

type SourcingOptionNode struct {
	// FacilityRef Example: DE-FAC-4711
	FacilityRef *string `json:"facilityRef,omitempty"`

	// Id id of this node, unique for this Sourcing Option Responses
	//
	// Example: f439e7b6-119e-47cc-a263-05a31baea0de
	Id string `json:"id"`

	// IsPickUpLocation Indicates if this node is a pick up location
	IsPickUpLocation *bool         `json:"isPickUpLocation,omitempty"`
	LineItems        []HandledItem `json:"lineItems"`

	// TenantFacilityId Example: DE-FAC-4711
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type NodeType
	Type NodeType `json:"type"`
}

SourcingOptionNode SourcingOptionNode

type SourcingOptionSalesPrice added in v0.2.0

type SourcingOptionSalesPrice struct {
	// Amount The amount of the item in the solution
	//
	// Example: 1
	Amount   float32                                   `json:"amount"`
	Discount *[]SourcingOptionSalesPrice_Discount_Item `json:"discount,omitempty"`

	// SalesPricePerUnitWithDiscountAmount Money
	SalesPricePerUnitWithDiscountAmount *Money `json:"salesPricePerUnitWithDiscountAmount,omitempty"`

	// SalesPricePerUnitWithoutDiscountAmount Money
	SalesPricePerUnitWithoutDiscountAmount Money `json:"salesPricePerUnitWithoutDiscountAmount"`

	// SourceFacilityRef The facility reference of the source facility
	//
	// Example: DE-FAC-4711
	SourceFacilityRef string `json:"sourceFacilityRef"`

	// SourceTenantFacilityId The tenant facility id of the source facility
	//
	// Example: facility-east
	SourceTenantFacilityId *string `json:"sourceTenantFacilityId,omitempty"`

	// TenantArticleId The tenant article id of the item
	//
	// Example: DE-ZGT-4711
	TenantArticleId string `json:"tenantArticleId"`
}

SourcingOptionSalesPrice SourcingOptionSalesPrice

type SourcingOptionSalesPrice_Discount_Item added in v0.2.0

type SourcingOptionSalesPrice_Discount_Item struct {
	// contains filtered or unexported fields
}

SourcingOptionSalesPrice_Discount_Item defines model for SourcingOptionSalesPrice.discount.Item.

func (SourcingOptionSalesPrice_Discount_Item) AsFacilityDiscountAbsoluteForCreation added in v0.2.0

func (t SourcingOptionSalesPrice_Discount_Item) AsFacilityDiscountAbsoluteForCreation() (FacilityDiscountAbsoluteForCreation, error)

AsFacilityDiscountAbsoluteForCreation returns the union data inside the SourcingOptionSalesPrice_Discount_Item as a FacilityDiscountAbsoluteForCreation

func (SourcingOptionSalesPrice_Discount_Item) AsFacilityDiscountRelative added in v0.2.0

func (t SourcingOptionSalesPrice_Discount_Item) AsFacilityDiscountRelative() (FacilityDiscountRelative, error)

AsFacilityDiscountRelative returns the union data inside the SourcingOptionSalesPrice_Discount_Item as a FacilityDiscountRelative

func (*SourcingOptionSalesPrice_Discount_Item) FromFacilityDiscountAbsoluteForCreation added in v0.2.0

func (t *SourcingOptionSalesPrice_Discount_Item) FromFacilityDiscountAbsoluteForCreation(v FacilityDiscountAbsoluteForCreation) error

FromFacilityDiscountAbsoluteForCreation overwrites any union data inside the SourcingOptionSalesPrice_Discount_Item as the provided FacilityDiscountAbsoluteForCreation

func (*SourcingOptionSalesPrice_Discount_Item) FromFacilityDiscountRelative added in v0.2.0

func (t *SourcingOptionSalesPrice_Discount_Item) FromFacilityDiscountRelative(v FacilityDiscountRelative) error

FromFacilityDiscountRelative overwrites any union data inside the SourcingOptionSalesPrice_Discount_Item as the provided FacilityDiscountRelative

func (SourcingOptionSalesPrice_Discount_Item) MarshalJSON added in v0.2.0

func (t SourcingOptionSalesPrice_Discount_Item) MarshalJSON() ([]byte, error)

func (*SourcingOptionSalesPrice_Discount_Item) MergeFacilityDiscountAbsoluteForCreation added in v0.2.0

func (t *SourcingOptionSalesPrice_Discount_Item) MergeFacilityDiscountAbsoluteForCreation(v FacilityDiscountAbsoluteForCreation) error

MergeFacilityDiscountAbsoluteForCreation performs a merge with any union data inside the SourcingOptionSalesPrice_Discount_Item, using the provided FacilityDiscountAbsoluteForCreation

func (*SourcingOptionSalesPrice_Discount_Item) MergeFacilityDiscountRelative added in v0.2.0

func (t *SourcingOptionSalesPrice_Discount_Item) MergeFacilityDiscountRelative(v FacilityDiscountRelative) error

MergeFacilityDiscountRelative performs a merge with any union data inside the SourcingOptionSalesPrice_Discount_Item, using the provided FacilityDiscountRelative

func (*SourcingOptionSalesPrice_Discount_Item) UnmarshalJSON added in v0.2.0

func (t *SourcingOptionSalesPrice_Discount_Item) UnmarshalJSON(b []byte) error

type SourcingOptionTotalRatingResult added in v0.6.0

type SourcingOptionTotalRatingResult struct {
	AvgPenalty float32 `json:"avgPenalty"`
	Id         string  `json:"id"`
	MaxPenalty float32 `json:"maxPenalty"`
	MinPenalty float32 `json:"minPenalty"`
}

SourcingOptionTotalRatingResult SourcingOptionTotalRatingResult

type SourcingOptionTransfer added in v0.2.0

type SourcingOptionTransfer struct {
	Carrier *struct {
		CarrierKey  *string `json:"carrierKey,omitempty"`
		CarrierName *string `json:"carrierName,omitempty"`
	} `json:"carrier,omitempty"`

	// CostDetails The cost components of this transfer that are not part of a packaging unit, such as transfer surcharges.
	CostDetails *[]SourcingOptionTransfer_CostDetails_Item `json:"costDetails,omitempty"`

	// ExistenceReason SourcingOptionTransferExistenceReason
	ExistenceReason *SourcingOptionTransferExistenceReason `json:"existenceReason,omitempty"`

	// FacilityConnectionRef Example: f439e7b6-119e-47cc-a263-05a31baea0de
	FacilityConnectionRef *string `json:"facilityConnectionRef,omitempty"`

	// FallbackCosts Money
	FallbackCosts        *Money                                        `json:"fallbackCosts,omitempty"`
	LineItems            []HandledItem                                 `json:"lineItems"`
	PackagingInformation []SourcingOptionsTransferPackagingInformation `json:"packagingInformation"`

	// SourceNodeRef Example: f439e7b6-119e-47cc-a263-05a31baea0de
	SourceNodeRef string `json:"sourceNodeRef"`

	// StrandId Example: f439e7b6-119e-47cc-a263-05a31baea0de
	StrandId *string `json:"strandId,omitempty"`

	// TargetNodeRef Example: ad6c5038-15ee-41b8-a180-4c86290d04c3
	TargetNodeRef string `json:"targetNodeRef"`

	// TimeLine TransferTimeLine
	TimeLine *TransferTimeLine `json:"timeLine,omitempty"`

	// TotalCosts Money
	TotalCosts *Money `json:"totalCosts,omitempty"`

	// TransferGroup The transferGroup identifying transfers that travel together in the same delivery time window. Transfers with the same transferGroup are expected to be fulfilled within the same temporal delivery slot.
	//
	// Example: 0_xyz
	TransferGroup *string `json:"transferGroup,omitempty"`
}

SourcingOptionTransfer SourcingOptionTransfer

type SourcingOptionTransferExistenceReason added in v0.3.0

type SourcingOptionTransferExistenceReason string

SourcingOptionTransferExistenceReason SourcingOptionTransferExistenceReason

const (
	KEPTFROMLASTRUN     SourcingOptionTransferExistenceReason = "KEPT_FROM_LAST_RUN"
	REDUCEDONORDERSPLIT SourcingOptionTransferExistenceReason = "REDUCED_ON_ORDER_SPLIT"
)

Defines values for SourcingOptionTransferExistenceReason.

func (SourcingOptionTransferExistenceReason) Valid added in v0.3.0

Valid indicates whether the value is a known member of the SourcingOptionTransferExistenceReason enum.

type SourcingOptionTransfer_CostDetails_Item added in v0.8.0

type SourcingOptionTransfer_CostDetails_Item struct {
	// contains filtered or unexported fields
}

SourcingOptionTransfer_CostDetails_Item defines model for SourcingOptionTransfer.costDetails.Item.

func (SourcingOptionTransfer_CostDetails_Item) AsAbsoluteSurchargeCostDetail added in v0.8.0

func (t SourcingOptionTransfer_CostDetails_Item) AsAbsoluteSurchargeCostDetail() (AbsoluteSurchargeCostDetail, error)

AsAbsoluteSurchargeCostDetail returns the union data inside the SourcingOptionTransfer_CostDetails_Item as a AbsoluteSurchargeCostDetail

func (SourcingOptionTransfer_CostDetails_Item) AsBasePriceCostDetail added in v0.8.0

AsBasePriceCostDetail returns the union data inside the SourcingOptionTransfer_CostDetails_Item as a BasePriceCostDetail

func (SourcingOptionTransfer_CostDetails_Item) AsCostCoefficientCostDetail added in v0.8.0

func (t SourcingOptionTransfer_CostDetails_Item) AsCostCoefficientCostDetail() (CostCoefficientCostDetail, error)

AsCostCoefficientCostDetail returns the union data inside the SourcingOptionTransfer_CostDetails_Item as a CostCoefficientCostDetail

func (SourcingOptionTransfer_CostDetails_Item) AsOverflowCostDetail added in v0.8.0

AsOverflowCostDetail returns the union data inside the SourcingOptionTransfer_CostDetails_Item as a OverflowCostDetail

func (SourcingOptionTransfer_CostDetails_Item) AsRelativeSurchargeCostDetail added in v0.8.0

func (t SourcingOptionTransfer_CostDetails_Item) AsRelativeSurchargeCostDetail() (RelativeSurchargeCostDetail, error)

AsRelativeSurchargeCostDetail returns the union data inside the SourcingOptionTransfer_CostDetails_Item as a RelativeSurchargeCostDetail

func (SourcingOptionTransfer_CostDetails_Item) AsThresholdSurchargeCostDetail added in v0.8.0

func (t SourcingOptionTransfer_CostDetails_Item) AsThresholdSurchargeCostDetail() (ThresholdSurchargeCostDetail, error)

AsThresholdSurchargeCostDetail returns the union data inside the SourcingOptionTransfer_CostDetails_Item as a ThresholdSurchargeCostDetail

func (SourcingOptionTransfer_CostDetails_Item) Discriminator added in v0.8.0

func (*SourcingOptionTransfer_CostDetails_Item) FromAbsoluteSurchargeCostDetail added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) FromAbsoluteSurchargeCostDetail(v AbsoluteSurchargeCostDetail) error

FromAbsoluteSurchargeCostDetail overwrites any union data inside the SourcingOptionTransfer_CostDetails_Item as the provided AbsoluteSurchargeCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) FromBasePriceCostDetail added in v0.8.0

FromBasePriceCostDetail overwrites any union data inside the SourcingOptionTransfer_CostDetails_Item as the provided BasePriceCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) FromCostCoefficientCostDetail added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) FromCostCoefficientCostDetail(v CostCoefficientCostDetail) error

FromCostCoefficientCostDetail overwrites any union data inside the SourcingOptionTransfer_CostDetails_Item as the provided CostCoefficientCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) FromOverflowCostDetail added in v0.8.0

FromOverflowCostDetail overwrites any union data inside the SourcingOptionTransfer_CostDetails_Item as the provided OverflowCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) FromRelativeSurchargeCostDetail added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) FromRelativeSurchargeCostDetail(v RelativeSurchargeCostDetail) error

FromRelativeSurchargeCostDetail overwrites any union data inside the SourcingOptionTransfer_CostDetails_Item as the provided RelativeSurchargeCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) FromThresholdSurchargeCostDetail added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) FromThresholdSurchargeCostDetail(v ThresholdSurchargeCostDetail) error

FromThresholdSurchargeCostDetail overwrites any union data inside the SourcingOptionTransfer_CostDetails_Item as the provided ThresholdSurchargeCostDetail

func (SourcingOptionTransfer_CostDetails_Item) MarshalJSON added in v0.8.0

func (t SourcingOptionTransfer_CostDetails_Item) MarshalJSON() ([]byte, error)

func (*SourcingOptionTransfer_CostDetails_Item) MergeAbsoluteSurchargeCostDetail added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) MergeAbsoluteSurchargeCostDetail(v AbsoluteSurchargeCostDetail) error

MergeAbsoluteSurchargeCostDetail performs a merge with any union data inside the SourcingOptionTransfer_CostDetails_Item, using the provided AbsoluteSurchargeCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) MergeBasePriceCostDetail added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) MergeBasePriceCostDetail(v BasePriceCostDetail) error

MergeBasePriceCostDetail performs a merge with any union data inside the SourcingOptionTransfer_CostDetails_Item, using the provided BasePriceCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) MergeCostCoefficientCostDetail added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) MergeCostCoefficientCostDetail(v CostCoefficientCostDetail) error

MergeCostCoefficientCostDetail performs a merge with any union data inside the SourcingOptionTransfer_CostDetails_Item, using the provided CostCoefficientCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) MergeOverflowCostDetail added in v0.8.0

MergeOverflowCostDetail performs a merge with any union data inside the SourcingOptionTransfer_CostDetails_Item, using the provided OverflowCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) MergeRelativeSurchargeCostDetail added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) MergeRelativeSurchargeCostDetail(v RelativeSurchargeCostDetail) error

MergeRelativeSurchargeCostDetail performs a merge with any union data inside the SourcingOptionTransfer_CostDetails_Item, using the provided RelativeSurchargeCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) MergeThresholdSurchargeCostDetail added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) MergeThresholdSurchargeCostDetail(v ThresholdSurchargeCostDetail) error

MergeThresholdSurchargeCostDetail performs a merge with any union data inside the SourcingOptionTransfer_CostDetails_Item, using the provided ThresholdSurchargeCostDetail

func (*SourcingOptionTransfer_CostDetails_Item) UnmarshalJSON added in v0.8.0

func (t *SourcingOptionTransfer_CostDetails_Item) UnmarshalJSON(b []byte) error

func (SourcingOptionTransfer_CostDetails_Item) ValueByDiscriminator added in v0.8.0

func (t SourcingOptionTransfer_CostDetails_Item) ValueByDiscriminator() (interface{}, error)

type SourcingOptionsExecutionResults added in v0.6.0

type SourcingOptionsExecutionResults struct {
	TotalRatingResults *[]SourcingOptionTotalRatingResult `json:"totalRatingResults,omitempty"`
}

SourcingOptionsExecutionResults SourcingOptionsExecutionResults

type SourcingOptionsRequest added in v0.2.0

type SourcingOptionsRequest struct {
	// AdditionalInfo SourcingOptionsRequestAdditionalInfo
	AdditionalInfo *SourcingOptionsRequestAdditionalInfo `json:"additionalInfo,omitempty"`

	// OptimizationHints OptimizationHints
	OptimizationHints *OptimizationHints `json:"optimizationHints,omitempty"`

	// Order OrderForSourcingOptionsRequest
	Order OrderForSourcingOptionsRequest `json:"order"`

	// ResourceInvestment How much resources should be invested during the optimization?
	ResourceInvestment *ResourceInvestment `json:"resourceInvestment,omitempty"`
}

SourcingOptionsRequest SourcingOptionsRequest

type SourcingOptionsRequestAdditionalInfo added in v0.2.0

type SourcingOptionsRequestAdditionalInfo struct {
	// IncludeListingCustomAttributes If true, the listing custom attributes are included in the response. This is useful for debugging purposes.
	IncludeListingCustomAttributes *bool `json:"includeListingCustomAttributes,omitempty"`
}

SourcingOptionsRequestAdditionalInfo SourcingOptionsRequestAdditionalInfo

type SourcingOptionsResponse added in v0.2.0

type SourcingOptionsResponse struct {
	// Id Id referring optimizations runId
	//
	// Example: 284f32cc-b106-487d-b633-f90d93d8c251
	Id string `json:"id"`

	// Result SourcingOptionsResult
	Result SourcingOptionsResult `json:"result"`
}

SourcingOptionsResponse SourcingOptionsResponse

type SourcingOptionsResult added in v0.2.0

type SourcingOptionsResult struct {
	Options []SourcingOption `json:"options"`
}

SourcingOptionsResult SourcingOptionsResult

type SourcingOptionsTransferDeliverCostCoefficient added in v0.2.0

type SourcingOptionsTransferDeliverCostCoefficient struct {
	// MeasurementUnit The unit of measurement for the coefficient
	MeasurementUnit CostCoefficientMeasurementUnit `json:"measurementUnit"`
	Value           float32                        `json:"value"`
}

SourcingOptionsTransferDeliverCostCoefficient SourcingOptionsTransferDeliverCostCoefficient

type SourcingOptionsTransferDeliveryCost added in v0.2.0

type SourcingOptionsTransferDeliveryCost struct {
	// Currency The currency code is a three-letter code that represents a currency in the ISO 4217 standard.
	Currency      CurrencyCode `json:"currency"`
	DecimalPlaces *float32     `json:"decimalPlaces,omitempty"`

	// DeliveryCostCoefficient SourcingOptionsTransferDeliverCostCoefficient
	DeliveryCostCoefficient *SourcingOptionsTransferDeliverCostCoefficient `json:"deliveryCostCoefficient,omitempty"`
	Value                   float32                                        `json:"value"`
}

SourcingOptionsTransferDeliveryCost SourcingOptionsTransferDeliveryCost

type SourcingOptionsTransferPackagingInformation added in v0.2.0

type SourcingOptionsTransferPackagingInformation struct {
	// CostDetails The cost components that add up to totalCosts
	CostDetails *[]SourcingOptionsTransferPackagingInformation_CostDetails_Item `json:"costDetails,omitempty"`

	// PackagingUnit SourcingOptionsTransferPackagingUnit
	PackagingUnit SourcingOptionsTransferPackagingUnit `json:"packagingUnit"`
	PackedItems   []HandledItem                        `json:"packedItems"`

	// TotalCosts Money
	TotalCosts Money `json:"totalCosts"`
}

SourcingOptionsTransferPackagingInformation SourcingOptionsTransferPackagingInformation

type SourcingOptionsTransferPackagingInformation_CostDetails_Item added in v0.8.0

type SourcingOptionsTransferPackagingInformation_CostDetails_Item struct {
	// contains filtered or unexported fields
}

SourcingOptionsTransferPackagingInformation_CostDetails_Item defines model for SourcingOptionsTransferPackagingInformation.costDetails.Item.

func (SourcingOptionsTransferPackagingInformation_CostDetails_Item) AsAbsoluteSurchargeCostDetail added in v0.8.0

AsAbsoluteSurchargeCostDetail returns the union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as a AbsoluteSurchargeCostDetail

func (SourcingOptionsTransferPackagingInformation_CostDetails_Item) AsBasePriceCostDetail added in v0.8.0

AsBasePriceCostDetail returns the union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as a BasePriceCostDetail

func (SourcingOptionsTransferPackagingInformation_CostDetails_Item) AsCostCoefficientCostDetail added in v0.8.0

AsCostCoefficientCostDetail returns the union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as a CostCoefficientCostDetail

func (SourcingOptionsTransferPackagingInformation_CostDetails_Item) AsOverflowCostDetail added in v0.8.0

AsOverflowCostDetail returns the union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as a OverflowCostDetail

func (SourcingOptionsTransferPackagingInformation_CostDetails_Item) AsRelativeSurchargeCostDetail added in v0.8.0

AsRelativeSurchargeCostDetail returns the union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as a RelativeSurchargeCostDetail

func (SourcingOptionsTransferPackagingInformation_CostDetails_Item) AsThresholdSurchargeCostDetail added in v0.8.0

AsThresholdSurchargeCostDetail returns the union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as a ThresholdSurchargeCostDetail

func (SourcingOptionsTransferPackagingInformation_CostDetails_Item) Discriminator added in v0.8.0

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) FromAbsoluteSurchargeCostDetail added in v0.8.0

FromAbsoluteSurchargeCostDetail overwrites any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as the provided AbsoluteSurchargeCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) FromBasePriceCostDetail added in v0.8.0

FromBasePriceCostDetail overwrites any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as the provided BasePriceCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) FromCostCoefficientCostDetail added in v0.8.0

FromCostCoefficientCostDetail overwrites any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as the provided CostCoefficientCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) FromOverflowCostDetail added in v0.8.0

FromOverflowCostDetail overwrites any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as the provided OverflowCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) FromRelativeSurchargeCostDetail added in v0.8.0

FromRelativeSurchargeCostDetail overwrites any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as the provided RelativeSurchargeCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) FromThresholdSurchargeCostDetail added in v0.8.0

FromThresholdSurchargeCostDetail overwrites any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item as the provided ThresholdSurchargeCostDetail

func (SourcingOptionsTransferPackagingInformation_CostDetails_Item) MarshalJSON added in v0.8.0

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) MergeAbsoluteSurchargeCostDetail added in v0.8.0

MergeAbsoluteSurchargeCostDetail performs a merge with any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item, using the provided AbsoluteSurchargeCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) MergeBasePriceCostDetail added in v0.8.0

MergeBasePriceCostDetail performs a merge with any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item, using the provided BasePriceCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) MergeCostCoefficientCostDetail added in v0.8.0

MergeCostCoefficientCostDetail performs a merge with any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item, using the provided CostCoefficientCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) MergeOverflowCostDetail added in v0.8.0

MergeOverflowCostDetail performs a merge with any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item, using the provided OverflowCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) MergeRelativeSurchargeCostDetail added in v0.8.0

MergeRelativeSurchargeCostDetail performs a merge with any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item, using the provided RelativeSurchargeCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) MergeThresholdSurchargeCostDetail added in v0.8.0

MergeThresholdSurchargeCostDetail performs a merge with any union data inside the SourcingOptionsTransferPackagingInformation_CostDetails_Item, using the provided ThresholdSurchargeCostDetail

func (*SourcingOptionsTransferPackagingInformation_CostDetails_Item) UnmarshalJSON added in v0.8.0

func (SourcingOptionsTransferPackagingInformation_CostDetails_Item) ValueByDiscriminator added in v0.8.0

func (t SourcingOptionsTransferPackagingInformation_CostDetails_Item) ValueByDiscriminator() (interface{}, error)

type SourcingOptionsTransferPackagingUnit added in v0.2.0

type SourcingOptionsTransferPackagingUnit struct {
	// Dimensions SourcingOptionsTransferPackagingUnitDimensions
	Dimensions *SourcingOptionsTransferPackagingUnitDimensions `json:"dimensions,omitempty"`

	// MaxItemQuantity The maximum number of items that can be packed in this packaging unit
	//
	// Example: 10
	MaxItemQuantity *int `json:"maxItemQuantity,omitempty"`

	// Name Example: Small Box
	Name             string                                 `json:"name"`
	PackagingUnitRef *string                                `json:"packagingUnitRef,omitempty"`
	Prices           *[]SourcingOptionsTransferDeliveryCost `json:"prices,omitempty"`

	// Priority The priority of this packaging unit, lower values are preferred
	//
	// Example: 1
	Priority              int     `json:"priority"`
	TenantPackagingUnitId *string `json:"tenantPackagingUnitId,omitempty"`

	// TransitTime SourcingOptionsTransferTransitTime
	TransitTime *SourcingOptionsTransferTransitTime `json:"transitTime,omitempty"`

	// VolumeBufferInPercent The volume buffer in percent for this packaging unit
	//
	// Example: 10
	VolumeBufferInPercent *float32 `json:"volumeBufferInPercent,omitempty"`
}

SourcingOptionsTransferPackagingUnit SourcingOptionsTransferPackagingUnit

type SourcingOptionsTransferPackagingUnitDimensions added in v0.2.0

type SourcingOptionsTransferPackagingUnitDimensions struct {
	Height          *float32 `json:"height,omitempty"`
	Length          *float32 `json:"length,omitempty"`
	MaxWeightInGram *float32 `json:"maxWeightInGram,omitempty"`
	Width           *float32 `json:"width,omitempty"`
}

SourcingOptionsTransferPackagingUnitDimensions SourcingOptionsTransferPackagingUnitDimensions

type SourcingOptionsTransferTransitTime added in v0.2.0

type SourcingOptionsTransferTransitTime struct {
	MaxTransitDays float32 `json:"maxTransitDays"`
	MinTransitDays float32 `json:"minTransitDays"`
}

SourcingOptionsTransferTransitTime SourcingOptionsTransferTransitTime

type Status

type Status struct {
	// Status The current state of the API
	Status StatusStatus `json:"status"`
}

Status Status

type StatusResponse

type StatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Status
}

func ParseStatusResponse

func ParseStatusResponse(rsp *http.Response) (*StatusResponse, error)

ParseStatusResponse parses an HTTP response from a StatusWithResponse call

func (StatusResponse) ContentType

func (r StatusResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (StatusResponse) GetBody added in v0.8.0

func (r StatusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (StatusResponse) GetJSON200 added in v0.8.0

func (r StatusResponse) GetJSON200() *Status

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (StatusResponse) Status

func (r StatusResponse) Status() string

Status returns HTTPResponse.Status

func (StatusResponse) StatusCode

func (r StatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StatusStatus

type StatusStatus string

StatusStatus The current state of the API

const (
	StatusStatusDEGRADED StatusStatus = "DEGRADED"
	StatusStatusDOWN     StatusStatus = "DOWN"
	StatusStatusUP       StatusStatus = "UP"
)

Defines values for StatusStatus.

func (StatusStatus) Valid

func (e StatusStatus) Valid() bool

Valid indicates whether the value is a known member of the StatusStatus enum.

type Sticker added in v0.2.0

type Sticker struct {
	// Color optional color coding for the sticker
	//
	// Example: #19b6b5
	Color *string `json:"color,omitempty"`

	// Key unique identifier
	//
	// Example: LGMl2DuvPnfPoSHhYFOm
	Key string `json:"key"`

	// Name Translated display name
	//
	// Example: SomeName
	Name *string `json:"name,omitempty"`

	// NameLocalized Dictionary of possible translations, min 1 entry, max 14 characters per description
	//
	// Example: { en_US: 'SomeName' }
	NameLocalized LocaleString `json:"nameLocalized"`

	// Priority priority of the given sticker
	//
	// Example: 100
	Priority int64 `json:"priority"`
}

Sticker Sticker

type Stock

type Stock struct {
	Available float32 `json:"available"`

	// AvailableUntil defines until when a stock is included in the stock availability as available and used for routing
	AvailableUntil *time.Time `json:"availableUntil,omitempty"`

	// Conditions Describes conditions of a stock
	//     *`DEFECTIVE` - stock is defective, not usable for customer orders
	Conditions *[]StockConditions `json:"conditions,omitempty"`
	Created    time.Time          `json:"created"`

	// CustomAttributes 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.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Facility StockFacilityReferences
	Facility StockFacilityReferences `json:"facility"`

	// FacilityRef facility in which the stock is located
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef string `json:"facilityRef"`
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	FacilityWideReserved float32   `json:"facilityWideReserved"`
	Id                   string    `json:"id"`
	LastModified         time.Time `json:"lastModified"`

	// LocationRef location on which the stock is placed
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	LocationRef *string `json:"locationRef,omitempty"`

	// Properties allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see "customAttributes" for that).
	Properties *Stock_Properties `json:"properties,omitempty"`

	// ReceiptDate date-time when stock has entered the system, defaults to the creation date
	//
	// Example: 2026-06-17T12:00:00.000Z
	ReceiptDate *time.Time `json:"receiptDate,omitempty"`

	// Reserved amount of this stock reserved for customer orders
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Reserved float32 `json:"reserved"`

	// ScannableCodes scannableCodes such as barcodes that identify this stock
	ScannableCodes *[]string `json:"scannableCodes,omitempty"`

	// Scores stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.
	Scores *[]Score `json:"scores,omitempty"`

	// SerializedProperties properties object serialized as JSON string, sorted alphabetically by key
	SerializedProperties string `json:"serializedProperties"`

	// TenantArticleId tenantArticleId of the stock
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId string `json:"tenantArticleId"`

	// TenantStockId tenantStockId is an optional identifier for the stock in the tenant system.
	//
	// Example: MY_STOCK_ID
	TenantStockId *string `json:"tenantStockId,omitempty"`

	// TraitConfig defines the traits of the stock, overrules the storage location traits
	TraitConfig *[]StorageLocationTraitConfigEntry `json:"traitConfig,omitempty"`

	// Traits provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation.
	Traits []StockTraits `json:"traits"`

	// Value Example: 42
	Value   int32   `json:"value"`
	Version float32 `json:"version"`
}

Stock Stock

type StockAction

type StockAction struct {
	// Action Action to be performed on the stock. If a user has specific facility context limitations, only stocks located in the referenced facilities will be affected
	Action *StockAction_Action `json:"action,omitempty"`

	// Actions Deprecated. Use 'action' with a single action input instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Actions *[]StockAction_Actions_Item `json:"actions,omitempty"`
}

StockAction StockAction

type StockActionResult

type StockActionResult struct {
	Name   StockActionResultName    `json:"name"`
	Result StockActionResult_Result `json:"result"`
}

StockActionResult StockActionResult

type StockActionResultName

type StockActionResultName string

StockActionResultName defines model for StockActionResult.Name.

const (
	StockActionResultNameDELETEBYIDS       StockActionResultName = "DELETE_BY_IDS"
	StockActionResultNameDELETEBYLOCATIONS StockActionResultName = "DELETE_BY_LOCATIONS"
	StockActionResultNameDELETEBYPRODUCTS  StockActionResultName = "DELETE_BY_PRODUCTS"
	StockActionResultNameMOVETOLOCATION    StockActionResultName = "MOVE_TO_LOCATION"
	StockActionResultNameUPDATEVERSIONLESS StockActionResultName = "UPDATE_VERSIONLESS"
)

Defines values for StockActionResultName.

func (StockActionResultName) Valid

func (e StockActionResultName) Valid() bool

Valid indicates whether the value is a known member of the StockActionResultName enum.

type StockActionResult_Result

type StockActionResult_Result struct {
	// contains filtered or unexported fields
}

StockActionResult_Result defines model for StockActionResult.Result.

func (StockActionResult_Result) AsStockDeleteActionResult

func (t StockActionResult_Result) AsStockDeleteActionResult() (StockDeleteActionResult, error)

AsStockDeleteActionResult returns the union data inside the StockActionResult_Result as a StockDeleteActionResult

func (StockActionResult_Result) AsStockMoveToLocationActionResult

func (t StockActionResult_Result) AsStockMoveToLocationActionResult() (StockMoveToLocationActionResult, error)

AsStockMoveToLocationActionResult returns the union data inside the StockActionResult_Result as a StockMoveToLocationActionResult

func (StockActionResult_Result) AsStockVersionlessUpsertActionResult

func (t StockActionResult_Result) AsStockVersionlessUpsertActionResult() (StockVersionlessUpsertActionResult, error)

AsStockVersionlessUpsertActionResult returns the union data inside the StockActionResult_Result as a StockVersionlessUpsertActionResult

func (*StockActionResult_Result) FromStockDeleteActionResult

func (t *StockActionResult_Result) FromStockDeleteActionResult(v StockDeleteActionResult) error

FromStockDeleteActionResult overwrites any union data inside the StockActionResult_Result as the provided StockDeleteActionResult

func (*StockActionResult_Result) FromStockMoveToLocationActionResult

func (t *StockActionResult_Result) FromStockMoveToLocationActionResult(v StockMoveToLocationActionResult) error

FromStockMoveToLocationActionResult overwrites any union data inside the StockActionResult_Result as the provided StockMoveToLocationActionResult

func (*StockActionResult_Result) FromStockVersionlessUpsertActionResult

func (t *StockActionResult_Result) FromStockVersionlessUpsertActionResult(v StockVersionlessUpsertActionResult) error

FromStockVersionlessUpsertActionResult overwrites any union data inside the StockActionResult_Result as the provided StockVersionlessUpsertActionResult

func (StockActionResult_Result) MarshalJSON

func (t StockActionResult_Result) MarshalJSON() ([]byte, error)

func (*StockActionResult_Result) MergeStockDeleteActionResult

func (t *StockActionResult_Result) MergeStockDeleteActionResult(v StockDeleteActionResult) error

MergeStockDeleteActionResult performs a merge with any union data inside the StockActionResult_Result, using the provided StockDeleteActionResult

func (*StockActionResult_Result) MergeStockMoveToLocationActionResult

func (t *StockActionResult_Result) MergeStockMoveToLocationActionResult(v StockMoveToLocationActionResult) error

MergeStockMoveToLocationActionResult performs a merge with any union data inside the StockActionResult_Result, using the provided StockMoveToLocationActionResult

func (*StockActionResult_Result) MergeStockVersionlessUpsertActionResult

func (t *StockActionResult_Result) MergeStockVersionlessUpsertActionResult(v StockVersionlessUpsertActionResult) error

MergeStockVersionlessUpsertActionResult performs a merge with any union data inside the StockActionResult_Result, using the provided StockVersionlessUpsertActionResult

func (*StockActionResult_Result) UnmarshalJSON

func (t *StockActionResult_Result) UnmarshalJSON(b []byte) error

type StockAction_Action

type StockAction_Action struct {
	// contains filtered or unexported fields
}

StockAction_Action Action to be performed on the stock. If a user has specific facility context limitations, only stocks located in the referenced facilities will be affected

func (StockAction_Action) AsStockDeleteByIds

func (t StockAction_Action) AsStockDeleteByIds() (StockDeleteByIds, error)

AsStockDeleteByIds returns the union data inside the StockAction_Action as a StockDeleteByIds

func (StockAction_Action) AsStockDeleteByLocations

func (t StockAction_Action) AsStockDeleteByLocations() (StockDeleteByLocations, error)

AsStockDeleteByLocations returns the union data inside the StockAction_Action as a StockDeleteByLocations

func (StockAction_Action) AsStockDeleteByProducts

func (t StockAction_Action) AsStockDeleteByProducts() (StockDeleteByProducts, error)

AsStockDeleteByProducts returns the union data inside the StockAction_Action as a StockDeleteByProducts

func (StockAction_Action) AsStockMoveToLocation

func (t StockAction_Action) AsStockMoveToLocation() (StockMoveToLocation, error)

AsStockMoveToLocation returns the union data inside the StockAction_Action as a StockMoveToLocation

func (StockAction_Action) AsVersionlessUpdateStock

func (t StockAction_Action) AsVersionlessUpdateStock() (VersionlessUpdateStock, error)

AsVersionlessUpdateStock returns the union data inside the StockAction_Action as a VersionlessUpdateStock

func (StockAction_Action) Discriminator

func (t StockAction_Action) Discriminator() (string, error)

func (*StockAction_Action) FromStockDeleteByIds

func (t *StockAction_Action) FromStockDeleteByIds(v StockDeleteByIds) error

FromStockDeleteByIds overwrites any union data inside the StockAction_Action as the provided StockDeleteByIds

func (*StockAction_Action) FromStockDeleteByLocations

func (t *StockAction_Action) FromStockDeleteByLocations(v StockDeleteByLocations) error

FromStockDeleteByLocations overwrites any union data inside the StockAction_Action as the provided StockDeleteByLocations

func (*StockAction_Action) FromStockDeleteByProducts

func (t *StockAction_Action) FromStockDeleteByProducts(v StockDeleteByProducts) error

FromStockDeleteByProducts overwrites any union data inside the StockAction_Action as the provided StockDeleteByProducts

func (*StockAction_Action) FromStockMoveToLocation

func (t *StockAction_Action) FromStockMoveToLocation(v StockMoveToLocation) error

FromStockMoveToLocation overwrites any union data inside the StockAction_Action as the provided StockMoveToLocation

func (*StockAction_Action) FromVersionlessUpdateStock

func (t *StockAction_Action) FromVersionlessUpdateStock(v VersionlessUpdateStock) error

FromVersionlessUpdateStock overwrites any union data inside the StockAction_Action as the provided VersionlessUpdateStock

func (StockAction_Action) MarshalJSON

func (t StockAction_Action) MarshalJSON() ([]byte, error)

func (*StockAction_Action) MergeStockDeleteByIds

func (t *StockAction_Action) MergeStockDeleteByIds(v StockDeleteByIds) error

MergeStockDeleteByIds performs a merge with any union data inside the StockAction_Action, using the provided StockDeleteByIds

func (*StockAction_Action) MergeStockDeleteByLocations

func (t *StockAction_Action) MergeStockDeleteByLocations(v StockDeleteByLocations) error

MergeStockDeleteByLocations performs a merge with any union data inside the StockAction_Action, using the provided StockDeleteByLocations

func (*StockAction_Action) MergeStockDeleteByProducts

func (t *StockAction_Action) MergeStockDeleteByProducts(v StockDeleteByProducts) error

MergeStockDeleteByProducts performs a merge with any union data inside the StockAction_Action, using the provided StockDeleteByProducts

func (*StockAction_Action) MergeStockMoveToLocation

func (t *StockAction_Action) MergeStockMoveToLocation(v StockMoveToLocation) error

MergeStockMoveToLocation performs a merge with any union data inside the StockAction_Action, using the provided StockMoveToLocation

func (*StockAction_Action) MergeVersionlessUpdateStock

func (t *StockAction_Action) MergeVersionlessUpdateStock(v VersionlessUpdateStock) error

MergeVersionlessUpdateStock performs a merge with any union data inside the StockAction_Action, using the provided VersionlessUpdateStock

func (*StockAction_Action) UnmarshalJSON

func (t *StockAction_Action) UnmarshalJSON(b []byte) error

func (StockAction_Action) ValueByDiscriminator

func (t StockAction_Action) ValueByDiscriminator() (interface{}, error)

type StockAction_Actions_Item

type StockAction_Actions_Item struct {
	// contains filtered or unexported fields
}

StockAction_Actions_Item defines model for StockAction.actions.Item.

func (StockAction_Actions_Item) AsStockDeleteByIds

func (t StockAction_Actions_Item) AsStockDeleteByIds() (StockDeleteByIds, error)

AsStockDeleteByIds returns the union data inside the StockAction_Actions_Item as a StockDeleteByIds

func (StockAction_Actions_Item) AsStockDeleteByLocations

func (t StockAction_Actions_Item) AsStockDeleteByLocations() (StockDeleteByLocations, error)

AsStockDeleteByLocations returns the union data inside the StockAction_Actions_Item as a StockDeleteByLocations

func (StockAction_Actions_Item) AsStockDeleteByProducts

func (t StockAction_Actions_Item) AsStockDeleteByProducts() (StockDeleteByProducts, error)

AsStockDeleteByProducts returns the union data inside the StockAction_Actions_Item as a StockDeleteByProducts

func (*StockAction_Actions_Item) FromStockDeleteByIds

func (t *StockAction_Actions_Item) FromStockDeleteByIds(v StockDeleteByIds) error

FromStockDeleteByIds overwrites any union data inside the StockAction_Actions_Item as the provided StockDeleteByIds

func (*StockAction_Actions_Item) FromStockDeleteByLocations

func (t *StockAction_Actions_Item) FromStockDeleteByLocations(v StockDeleteByLocations) error

FromStockDeleteByLocations overwrites any union data inside the StockAction_Actions_Item as the provided StockDeleteByLocations

func (*StockAction_Actions_Item) FromStockDeleteByProducts

func (t *StockAction_Actions_Item) FromStockDeleteByProducts(v StockDeleteByProducts) error

FromStockDeleteByProducts overwrites any union data inside the StockAction_Actions_Item as the provided StockDeleteByProducts

func (StockAction_Actions_Item) MarshalJSON

func (t StockAction_Actions_Item) MarshalJSON() ([]byte, error)

func (*StockAction_Actions_Item) MergeStockDeleteByIds

func (t *StockAction_Actions_Item) MergeStockDeleteByIds(v StockDeleteByIds) error

MergeStockDeleteByIds performs a merge with any union data inside the StockAction_Actions_Item, using the provided StockDeleteByIds

func (*StockAction_Actions_Item) MergeStockDeleteByLocations

func (t *StockAction_Actions_Item) MergeStockDeleteByLocations(v StockDeleteByLocations) error

MergeStockDeleteByLocations performs a merge with any union data inside the StockAction_Actions_Item, using the provided StockDeleteByLocations

func (*StockAction_Actions_Item) MergeStockDeleteByProducts

func (t *StockAction_Actions_Item) MergeStockDeleteByProducts(v StockDeleteByProducts) error

MergeStockDeleteByProducts performs a merge with any union data inside the StockAction_Actions_Item, using the provided StockDeleteByProducts

func (*StockAction_Actions_Item) UnmarshalJSON

func (t *StockAction_Actions_Item) UnmarshalJSON(b []byte) error

type StockAvailabilityThreshold added in v0.8.0

type StockAvailabilityThreshold struct {
	// Config StockAvailabilityThresholdTransitionConfig
	Config StockAvailabilityThresholdTransitionConfig `json:"config"`

	// ThresholdLevel TriggeredThresholdLevel
	ThresholdLevel   TriggeredThresholdLevel                    `json:"thresholdLevel"`
	ThresholdOnValue StockAvailabilityThresholdThresholdOnValue `json:"thresholdOnValue"`
}

StockAvailabilityThreshold StockAvailabilityThreshold

type StockAvailabilityThresholdThresholdOnValue added in v0.8.0

type StockAvailabilityThresholdThresholdOnValue string

StockAvailabilityThresholdThresholdOnValue defines model for StockAvailabilityThreshold.ThresholdOnValue.

const (
	AVAILABLEFORPICKING StockAvailabilityThresholdThresholdOnValue = "AVAILABLE_FOR_PICKING"
	STOCKONHAND         StockAvailabilityThresholdThresholdOnValue = "STOCK_ON_HAND"
)

Defines values for StockAvailabilityThresholdThresholdOnValue.

func (StockAvailabilityThresholdThresholdOnValue) Valid added in v0.8.0

Valid indicates whether the value is a known member of the StockAvailabilityThresholdThresholdOnValue enum.

type StockAvailabilityThresholdTransitionConfig added in v0.8.0

type StockAvailabilityThresholdTransitionConfig struct {
	Id                string  `json:"id"`
	TenantThresholdId *string `json:"tenantThresholdId,omitempty"`
	Version           float32 `json:"version"`
}

StockAvailabilityThresholdTransitionConfig StockAvailabilityThresholdTransitionConfig

type StockConditionEnumFilter

type StockConditionEnumFilter struct {
	// Eq Search by conditions
	Eq *StockConditionEnumFilterEq `json:"eq,omitempty"`

	// In Search by conditions
	In *[]StockConditionEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by conditions
	NotEq *StockConditionEnumFilterNotEq `json:"notEq,omitempty"`
}

StockConditionEnumFilter StockConditionEnumFilter

type StockConditionEnumFilterEq

type StockConditionEnumFilterEq string

StockConditionEnumFilterEq Search by conditions

const (
	StockConditionEnumFilterEqDEFECTIVE StockConditionEnumFilterEq = "DEFECTIVE"
)

Defines values for StockConditionEnumFilterEq.

func (StockConditionEnumFilterEq) Valid

func (e StockConditionEnumFilterEq) Valid() bool

Valid indicates whether the value is a known member of the StockConditionEnumFilterEq enum.

type StockConditionEnumFilterIn

type StockConditionEnumFilterIn string

StockConditionEnumFilterIn defines model for StockConditionEnumFilter.In.

const (
	StockConditionEnumFilterInDEFECTIVE StockConditionEnumFilterIn = "DEFECTIVE"
)

Defines values for StockConditionEnumFilterIn.

func (StockConditionEnumFilterIn) Valid

func (e StockConditionEnumFilterIn) Valid() bool

Valid indicates whether the value is a known member of the StockConditionEnumFilterIn enum.

type StockConditionEnumFilterNotEq

type StockConditionEnumFilterNotEq string

StockConditionEnumFilterNotEq Search by conditions

const (
	StockConditionEnumFilterNotEqDEFECTIVE StockConditionEnumFilterNotEq = "DEFECTIVE"
)

Defines values for StockConditionEnumFilterNotEq.

func (StockConditionEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the StockConditionEnumFilterNotEq enum.

type StockConditionEnumListFilter

type StockConditionEnumListFilter struct {
	// Contains Search by conditions
	Contains *StockConditionEnumFilter `json:"contains,omitempty"`
}

StockConditionEnumListFilter StockConditionEnumListFilter

type StockConditions

type StockConditions string

StockConditions defines model for Stock.Conditions.

const (
	StockConditionsDEFECTIVE StockConditions = "DEFECTIVE"
)

Defines values for StockConditions.

func (StockConditions) Valid

func (e StockConditions) Valid() bool

Valid indicates whether the value is a known member of the StockConditions enum.

type StockDeleteActionResult

type StockDeleteActionResult struct {
	Ids []string `json:"ids"`
}

StockDeleteActionResult StockDeleteActionResult

type StockDeleteByIds

type StockDeleteByIds struct {
	Ids  []string             `json:"ids"`
	Name StockDeleteByIdsName `json:"name"`
}

StockDeleteByIds StockDeleteByIds

type StockDeleteByIdsName

type StockDeleteByIdsName string

StockDeleteByIdsName defines model for StockDeleteByIds.Name.

const (
	StockDeleteByIdsNameDELETEBYIDS StockDeleteByIdsName = "DELETE_BY_IDS"
)

Defines values for StockDeleteByIdsName.

func (StockDeleteByIdsName) Valid

func (e StockDeleteByIdsName) Valid() bool

Valid indicates whether the value is a known member of the StockDeleteByIdsName enum.

type StockDeleteByLocations

type StockDeleteByLocations struct {
	// LocationRefs Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	LocationRefs []string                   `json:"locationRefs"`
	Name         StockDeleteByLocationsName `json:"name"`
}

StockDeleteByLocations StockDeleteByLocations

type StockDeleteByLocationsName

type StockDeleteByLocationsName string

StockDeleteByLocationsName defines model for StockDeleteByLocations.Name.

const (
	StockDeleteByLocationsNameDELETEBYLOCATIONS StockDeleteByLocationsName = "DELETE_BY_LOCATIONS"
)

Defines values for StockDeleteByLocationsName.

func (StockDeleteByLocationsName) Valid

func (e StockDeleteByLocationsName) Valid() bool

Valid indicates whether the value is a known member of the StockDeleteByLocationsName enum.

type StockDeleteByProducts

type StockDeleteByProducts struct {
	FacilityRef      string                    `json:"facilityRef"`
	Name             StockDeleteByProductsName `json:"name"`
	TenantArticleIds []string                  `json:"tenantArticleIds"`
}

StockDeleteByProducts StockDeleteByProducts

type StockDeleteByProductsName

type StockDeleteByProductsName string

StockDeleteByProductsName defines model for StockDeleteByProducts.Name.

const (
	StockDeleteByProductsNameDELETEBYPRODUCTS StockDeleteByProductsName = "DELETE_BY_PRODUCTS"
)

Defines values for StockDeleteByProductsName.

func (StockDeleteByProductsName) Valid

func (e StockDeleteByProductsName) Valid() bool

Valid indicates whether the value is a known member of the StockDeleteByProductsName enum.

type StockDistribution

type StockDistribution struct {
	FacilityStocks []FacilityStockDistribution `json:"facilityStocks"`

	// Summary StockSummaryDetails
	Summary         StockSummaryDetails `json:"summary"`
	TenantArticleId string              `json:"tenantArticleId"`
}

StockDistribution StockDistribution

type StockFacilityReferences

type StockFacilityReferences struct {
	// FacilityRef facility in which the stock is located
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef string `json:"facilityRef"`

	// TenantFacilityId tenantFacilityId in which the stock is located
	//
	// Example: MY_FACILITY_ID
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`
}

StockFacilityReferences StockFacilityReferences

type StockForCreation

type StockForCreation struct {
	// AvailableUntil defines until when a stock is included in the stock availability as available and used for routing
	AvailableUntil *time.Time `json:"availableUntil,omitempty"`

	// Conditions Describes conditions of a stock
	//     *`DEFECTIVE` - stock is defective, not usable for customer orders
	Conditions *[]StockForCreationConditions `json:"conditions,omitempty"`

	// CustomAttributes 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.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Facility Selector for the facility. Either a facility reference or a tenant facility ID must be provided.
	Facility *StockForCreation_Facility `json:"facility,omitempty"`

	// FacilityRef facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	FacilityRef *string `json:"facilityRef,omitempty"`

	// LocationRef location on which the stock is placed
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	LocationRef *string `json:"locationRef,omitempty"`

	// Properties allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see "customAttributes" for that).
	Properties *StockForCreation_Properties `json:"properties,omitempty"`

	// ReceiptDate date-time when stock has entered the system, defaults to the creation date
	//
	// Example: 2026-06-17T12:00:00.000Z
	ReceiptDate *time.Time `json:"receiptDate,omitempty"`

	// TenantArticleId tenantArticleId of the stock
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId string `json:"tenantArticleId"`

	// TenantFacilityId tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead
	//
	// Example: MY_FACILITY_ID
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// TenantStockId tenantStockId is an optional identifier for the stock in the tenant system.
	//
	// Example: MY_STOCK_ID
	TenantStockId *string `json:"tenantStockId,omitempty"`

	// TraitConfig defines the traits of the stock, overrules the storage location traits
	TraitConfig *[]StorageLocationTraitConfigEntry `json:"traitConfig,omitempty"`

	// Value Example: 42
	Value int32 `json:"value"`
}

StockForCreation StockForCreation

type StockForCreationConditions

type StockForCreationConditions string

StockForCreationConditions defines model for StockForCreation.Conditions.

const (
	StockForCreationConditionsDEFECTIVE StockForCreationConditions = "DEFECTIVE"
)

Defines values for StockForCreationConditions.

func (StockForCreationConditions) Valid

func (e StockForCreationConditions) Valid() bool

Valid indicates whether the value is a known member of the StockForCreationConditions enum.

type StockForCreationVersionless

type StockForCreationVersionless struct {
	// AvailableUntil defines until when a stock is included in the stock availability as available and used for routing
	AvailableUntil *time.Time `json:"availableUntil,omitempty"`

	// Conditions Describes conditions of a stock
	//     *`DEFECTIVE` - stock is defective, not usable for customer orders
	Conditions *[]StockForCreationVersionlessConditions `json:"conditions,omitempty"`

	// CustomAttributes 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.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Facility Selector for the facility. Either a facility reference or a tenant facility ID must be provided.
	Facility *StockForCreationVersionless_Facility `json:"facility,omitempty"`

	// FacilityRef facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	FacilityRef *string `json:"facilityRef,omitempty"`

	// LocationRef location on which the stock is placed
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	LocationRef   *string                                  `json:"locationRef,omitempty"`
	OperationType StockForCreationVersionlessOperationType `json:"operationType"`

	// Properties allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see "customAttributes" for that).
	Properties *StockForCreationVersionless_Properties `json:"properties,omitempty"`

	// ReceiptDate date-time when stock has entered the system, defaults to the creation date
	//
	// Example: 2026-06-17T12:00:00.000Z
	ReceiptDate *time.Time `json:"receiptDate,omitempty"`

	// TenantArticleId tenantArticleId of the stock
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId string `json:"tenantArticleId"`

	// TenantFacilityId tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead
	//
	// Example: MY_FACILITY_ID
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// TenantStockId tenantStockId is an optional identifier for the stock in the tenant system.
	//
	// Example: MY_STOCK_ID
	TenantStockId *string `json:"tenantStockId,omitempty"`

	// TraitConfig defines the traits of the stock, overrules the storage location traits
	TraitConfig *[]StorageLocationTraitConfigEntry `json:"traitConfig,omitempty"`

	// Value Example: 42
	Value int32 `json:"value"`
}

StockForCreationVersionless StockForCreationVersionless

type StockForCreationVersionlessConditions

type StockForCreationVersionlessConditions string

StockForCreationVersionlessConditions defines model for StockForCreationVersionless.Conditions.

const (
	StockForCreationVersionlessConditionsDEFECTIVE StockForCreationVersionlessConditions = "DEFECTIVE"
)

Defines values for StockForCreationVersionlessConditions.

func (StockForCreationVersionlessConditions) Valid

Valid indicates whether the value is a known member of the StockForCreationVersionlessConditions enum.

type StockForCreationVersionlessOperationType

type StockForCreationVersionlessOperationType string

StockForCreationVersionlessOperationType defines model for StockForCreationVersionless.OperationType.

const (
	StockForCreationVersionlessOperationTypeCREATE StockForCreationVersionlessOperationType = "CREATE"
)

Defines values for StockForCreationVersionlessOperationType.

func (StockForCreationVersionlessOperationType) Valid

Valid indicates whether the value is a known member of the StockForCreationVersionlessOperationType enum.

type StockForCreationVersionless_Facility

type StockForCreationVersionless_Facility struct {
	// contains filtered or unexported fields
}

StockForCreationVersionless_Facility Selector for the facility. Either a facility reference or a tenant facility ID must be provided.

func (StockForCreationVersionless_Facility) AsFacilityRefSelector

func (t StockForCreationVersionless_Facility) AsFacilityRefSelector() (FacilityRefSelector, error)

AsFacilityRefSelector returns the union data inside the StockForCreationVersionless_Facility as a FacilityRefSelector

func (StockForCreationVersionless_Facility) AsTenantFacilityIdSelector

func (t StockForCreationVersionless_Facility) AsTenantFacilityIdSelector() (TenantFacilityIdSelector, error)

AsTenantFacilityIdSelector returns the union data inside the StockForCreationVersionless_Facility as a TenantFacilityIdSelector

func (*StockForCreationVersionless_Facility) FromFacilityRefSelector

func (t *StockForCreationVersionless_Facility) FromFacilityRefSelector(v FacilityRefSelector) error

FromFacilityRefSelector overwrites any union data inside the StockForCreationVersionless_Facility as the provided FacilityRefSelector

func (*StockForCreationVersionless_Facility) FromTenantFacilityIdSelector

func (t *StockForCreationVersionless_Facility) FromTenantFacilityIdSelector(v TenantFacilityIdSelector) error

FromTenantFacilityIdSelector overwrites any union data inside the StockForCreationVersionless_Facility as the provided TenantFacilityIdSelector

func (StockForCreationVersionless_Facility) MarshalJSON

func (t StockForCreationVersionless_Facility) MarshalJSON() ([]byte, error)

func (*StockForCreationVersionless_Facility) MergeFacilityRefSelector

func (t *StockForCreationVersionless_Facility) MergeFacilityRefSelector(v FacilityRefSelector) error

MergeFacilityRefSelector performs a merge with any union data inside the StockForCreationVersionless_Facility, using the provided FacilityRefSelector

func (*StockForCreationVersionless_Facility) MergeTenantFacilityIdSelector

func (t *StockForCreationVersionless_Facility) MergeTenantFacilityIdSelector(v TenantFacilityIdSelector) error

MergeTenantFacilityIdSelector performs a merge with any union data inside the StockForCreationVersionless_Facility, using the provided TenantFacilityIdSelector

func (*StockForCreationVersionless_Facility) UnmarshalJSON

func (t *StockForCreationVersionless_Facility) UnmarshalJSON(b []byte) error

type StockForCreationVersionless_Properties

type StockForCreationVersionless_Properties struct {
	Expiry               *string           `json:"expiry,omitempty"`
	AdditionalProperties map[string]string `json:"-"`
}

StockForCreationVersionless_Properties allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see "customAttributes" for that).

func (StockForCreationVersionless_Properties) Get

func (a StockForCreationVersionless_Properties) Get(fieldName string) (value string, found bool)

Getter for additional properties for StockForCreationVersionless_Properties. Returns the specified element and whether it was found

func (StockForCreationVersionless_Properties) MarshalJSON

func (a StockForCreationVersionless_Properties) MarshalJSON() ([]byte, error)

Override default JSON handling for StockForCreationVersionless_Properties to handle AdditionalProperties

func (*StockForCreationVersionless_Properties) Set

func (a *StockForCreationVersionless_Properties) Set(fieldName string, value string)

Setter for additional properties for StockForCreationVersionless_Properties

func (*StockForCreationVersionless_Properties) UnmarshalJSON

func (a *StockForCreationVersionless_Properties) UnmarshalJSON(b []byte) error

Override default JSON handling for StockForCreationVersionless_Properties to handle AdditionalProperties

type StockForCreation_Facility

type StockForCreation_Facility struct {
	// contains filtered or unexported fields
}

StockForCreation_Facility Selector for the facility. Either a facility reference or a tenant facility ID must be provided.

func (StockForCreation_Facility) AsFacilityRefSelector

func (t StockForCreation_Facility) AsFacilityRefSelector() (FacilityRefSelector, error)

AsFacilityRefSelector returns the union data inside the StockForCreation_Facility as a FacilityRefSelector

func (StockForCreation_Facility) AsTenantFacilityIdSelector

func (t StockForCreation_Facility) AsTenantFacilityIdSelector() (TenantFacilityIdSelector, error)

AsTenantFacilityIdSelector returns the union data inside the StockForCreation_Facility as a TenantFacilityIdSelector

func (*StockForCreation_Facility) FromFacilityRefSelector

func (t *StockForCreation_Facility) FromFacilityRefSelector(v FacilityRefSelector) error

FromFacilityRefSelector overwrites any union data inside the StockForCreation_Facility as the provided FacilityRefSelector

func (*StockForCreation_Facility) FromTenantFacilityIdSelector

func (t *StockForCreation_Facility) FromTenantFacilityIdSelector(v TenantFacilityIdSelector) error

FromTenantFacilityIdSelector overwrites any union data inside the StockForCreation_Facility as the provided TenantFacilityIdSelector

func (StockForCreation_Facility) MarshalJSON

func (t StockForCreation_Facility) MarshalJSON() ([]byte, error)

func (*StockForCreation_Facility) MergeFacilityRefSelector

func (t *StockForCreation_Facility) MergeFacilityRefSelector(v FacilityRefSelector) error

MergeFacilityRefSelector performs a merge with any union data inside the StockForCreation_Facility, using the provided FacilityRefSelector

func (*StockForCreation_Facility) MergeTenantFacilityIdSelector

func (t *StockForCreation_Facility) MergeTenantFacilityIdSelector(v TenantFacilityIdSelector) error

MergeTenantFacilityIdSelector performs a merge with any union data inside the StockForCreation_Facility, using the provided TenantFacilityIdSelector

func (*StockForCreation_Facility) UnmarshalJSON

func (t *StockForCreation_Facility) UnmarshalJSON(b []byte) error

type StockForCreation_Properties

type StockForCreation_Properties struct {
	Expiry               *string           `json:"expiry,omitempty"`
	AdditionalProperties map[string]string `json:"-"`
}

StockForCreation_Properties allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see "customAttributes" for that).

func (StockForCreation_Properties) Get

func (a StockForCreation_Properties) Get(fieldName string) (value string, found bool)

Getter for additional properties for StockForCreation_Properties. Returns the specified element and whether it was found

func (StockForCreation_Properties) MarshalJSON

func (a StockForCreation_Properties) MarshalJSON() ([]byte, error)

Override default JSON handling for StockForCreation_Properties to handle AdditionalProperties

func (*StockForCreation_Properties) Set

func (a *StockForCreation_Properties) Set(fieldName string, value string)

Setter for additional properties for StockForCreation_Properties

func (*StockForCreation_Properties) UnmarshalJSON

func (a *StockForCreation_Properties) UnmarshalJSON(b []byte) error

Override default JSON handling for StockForCreation_Properties to handle AdditionalProperties

type StockForUpdate

type StockForUpdate struct {
	// Conditions Describes conditions of a stock
	//     *`DEFECTIVE` - stock is defective, not usable for customer orders
	Conditions *[]StockForUpdateConditions `json:"conditions,omitempty"`

	// CustomAttributes 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.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// LocationRef Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	LocationRef *string `json:"locationRef,omitempty"`

	// TenantStockId tenantStockId is an optional identifier for the stock in the tenant system.
	//
	// Example: MY_STOCK_ID
	TenantStockId *string `json:"tenantStockId,omitempty"`

	// TraitConfig defines the traits of the stock, overrules the storage location traits
	TraitConfig *[]StorageLocationTraitConfigEntry `json:"traitConfig,omitempty"`

	// Value Example: 42
	Value   int32   `json:"value"`
	Version float32 `json:"version"`
}

StockForUpdate StockForUpdate

type StockForUpdateConditions

type StockForUpdateConditions string

StockForUpdateConditions defines model for StockForUpdate.Conditions.

const (
	StockForUpdateConditionsDEFECTIVE StockForUpdateConditions = "DEFECTIVE"
)

Defines values for StockForUpdateConditions.

func (StockForUpdateConditions) Valid

func (e StockForUpdateConditions) Valid() bool

Valid indicates whether the value is a known member of the StockForUpdateConditions enum.

type StockForUpdateVersionless

type StockForUpdateVersionless struct {
	// Conditions Describes conditions of a stock
	//     *`DEFECTIVE` - stock is defective, not usable for customer orders
	Conditions *[]StockForUpdateVersionlessConditions `json:"conditions,omitempty"`

	// CustomAttributes 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.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`
	Id               string                  `json:"id"`

	// LocationRef Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	LocationRef   *string                                `json:"locationRef,omitempty"`
	OperationType StockForUpdateVersionlessOperationType `json:"operationType"`

	// TenantStockId tenantStockId is an optional identifier for the stock in the tenant system.
	//
	// Example: MY_STOCK_ID
	TenantStockId *string `json:"tenantStockId,omitempty"`

	// TraitConfig defines the traits of the stock, overrules the storage location traits
	TraitConfig *[]StorageLocationTraitConfigEntry `json:"traitConfig,omitempty"`

	// Value Example: 42
	Value int32 `json:"value"`
}

StockForUpdateVersionless StockForUpdateVersionless

type StockForUpdateVersionlessConditions

type StockForUpdateVersionlessConditions string

StockForUpdateVersionlessConditions defines model for StockForUpdateVersionless.Conditions.

const (
	StockForUpdateVersionlessConditionsDEFECTIVE StockForUpdateVersionlessConditions = "DEFECTIVE"
)

Defines values for StockForUpdateVersionlessConditions.

func (StockForUpdateVersionlessConditions) Valid

Valid indicates whether the value is a known member of the StockForUpdateVersionlessConditions enum.

type StockForUpdateVersionlessOperationType

type StockForUpdateVersionlessOperationType string

StockForUpdateVersionlessOperationType defines model for StockForUpdateVersionless.OperationType.

const (
	UPDATE StockForUpdateVersionlessOperationType = "UPDATE"
)

Defines values for StockForUpdateVersionlessOperationType.

func (StockForUpdateVersionlessOperationType) Valid

Valid indicates whether the value is a known member of the StockForUpdateVersionlessOperationType enum.

type StockForUpsertUpdate

type StockForUpsertUpdate struct {
	// Conditions Describes conditions of a stock
	//     *`DEFECTIVE` - stock is defective, not usable for customer orders
	Conditions *[]StockForUpsertUpdateConditions `json:"conditions,omitempty"`

	// CustomAttributes 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.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`
	Id               string                  `json:"id"`

	// LocationRef Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	LocationRef *string `json:"locationRef,omitempty"`

	// TenantStockId tenantStockId is an optional identifier for the stock in the tenant system.
	//
	// Example: MY_STOCK_ID
	TenantStockId *string `json:"tenantStockId,omitempty"`

	// TraitConfig defines the traits of the stock, overrules the storage location traits
	TraitConfig *[]StorageLocationTraitConfigEntry `json:"traitConfig,omitempty"`

	// Value Example: 42
	Value   int32   `json:"value"`
	Version float32 `json:"version"`
}

StockForUpsertUpdate StockForUpsertUpdate

type StockForUpsertUpdateConditions

type StockForUpsertUpdateConditions string

StockForUpsertUpdateConditions defines model for StockForUpsertUpdate.Conditions.

const (
	StockForUpsertUpdateConditionsDEFECTIVE StockForUpsertUpdateConditions = "DEFECTIVE"
)

Defines values for StockForUpsertUpdateConditions.

func (StockForUpsertUpdateConditions) Valid

Valid indicates whether the value is a known member of the StockForUpsertUpdateConditions enum.

type StockInformation

type StockInformation struct {
	// Available The actual available amount for this stock
	//
	// Example: 24
	Available float32 `json:"available"`

	// Reserved Example: 24
	Reserved *float32 `json:"reserved,omitempty"`

	// Stock This the amount of the given article that is in stock for the given facility
	//
	// Example: 42
	Stock float32 `json:"stock"`
}

StockInformation @deprecated This object is deprecated since 11th of September 2023.

type StockInformationForCreation deprecated

type StockInformationForCreation struct {
	// Reserved This part of the API is deprecated. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.
	// Reserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)
	// Any Value provided will be ignored upon arrival.
	//
	// Example: 24
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Reserved *float32 `json:"reserved,omitempty"`

	// Stock This the amount of the given article that is in stock for the given facility
	//
	// Example: 42
	Stock float32 `json:"stock"`
}

StockInformationForCreation @deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type StockMoveToLocation

type StockMoveToLocation struct {
	Amount      float32                 `json:"amount"`
	FromStockId string                  `json:"fromStockId"`
	Name        StockMoveToLocationName `json:"name"`

	// Options MoveStockToLocationOptions
	Options       *MoveStockToLocationOptions `json:"options,omitempty"`
	ToLocationRef string                      `json:"toLocationRef"`
}

StockMoveToLocation This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />StockMoveToLocation

type StockMoveToLocationActionResult

type StockMoveToLocationActionResult struct {
	// FromStock Stock
	FromStock *Stock `json:"fromStock,omitempty"`

	// ToStock Stock
	ToStock Stock `json:"toStock"`
}

StockMoveToLocationActionResult StockMoveToLocationActionResult

type StockMoveToLocationName

type StockMoveToLocationName string

StockMoveToLocationName defines model for StockMoveToLocation.Name.

const (
	StockMoveToLocationNameMOVETOLOCATION StockMoveToLocationName = "MOVE_TO_LOCATION"
)

Defines values for StockMoveToLocationName.

func (StockMoveToLocationName) Valid

func (e StockMoveToLocationName) Valid() bool

Valid indicates whether the value is a known member of the StockMoveToLocationName enum.

type StockPaginatedResult

type StockPaginatedResult struct {
	// PageInfo Pagination information for the search result.
	PageInfo PageInfo `json:"pageInfo"`
	Stocks   []Stock  `json:"stocks"`

	// Total The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
	Total *float32 `json:"total,omitempty"`
}

StockPaginatedResult StockPaginatedResult

type StockPropertyDefinition

type StockPropertyDefinition struct {
	// DefaultValue This part of the API is in Alpha status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.
	DefaultValue *string `json:"defaultValue,omitempty"`

	// InputType Input Type for this property, used for clients.
	//
	// Example: DATE
	InputType StockPropertyInputType `json:"inputType"`

	// Required Indicates if this property is required.
	Required bool `json:"required"`
}

StockPropertyDefinition StockPropertyDefinition

type StockPropertyInputType

type StockPropertyInputType string

StockPropertyInputType Input Type for this property, used for clients.

Example: DATE

const (
	DATE StockPropertyInputType = "DATE"
	TEXT StockPropertyInputType = "TEXT"
)

Defines values for StockPropertyInputType.

func (StockPropertyInputType) Valid

func (e StockPropertyInputType) Valid() bool

Valid indicates whether the value is a known member of the StockPropertyInputType enum.

type StockPropertyPreset

type StockPropertyPreset struct {
	Expiry *string `json:"expiry,omitempty"`
}

StockPropertyPreset StockPropertyPreset

type StockSearchPayload

type StockSearchPayload struct {
	// After 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`.
	After *string `json:"after,omitempty"`

	// Before 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).
	Before *string `json:"before,omitempty"`

	// Last Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
	Last *float32 `json:"last,omitempty"`

	// Options SearchOptions
	Options *SearchOptions `json:"options,omitempty"`

	// Query StockSearchQuery
	Query StockSearchQuery `json:"query"`

	// Size Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
	//
	// Example: 10
	Size *float32 `json:"size,omitempty"`

	// Sort Use for sorting the result.
	Sort *[]StockSort `json:"sort,omitempty"`

	// StartAfterId The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	StartAfterId *string `json:"startAfterId,omitempty"`
}

StockSearchPayload StockSearchPayload

type StockSearchQuery

type StockSearchQuery struct {
	And *[]StockSearchQuery `json:"and,omitempty"`

	// AvailableUntil Search by availableUntil
	AvailableUntil *DateFilter `json:"availableUntil,omitempty"`

	// Conditions Search by conditions
	Conditions *StockConditionEnumListFilter `json:"conditions,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]StockSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// LocationRef Search by locationRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	LocationRef *StringFilter       `json:"locationRef,omitempty"`
	Or          *[]StockSearchQuery `json:"or,omitempty"`

	// Properties Search by properties
	Properties *map[string]StockSearchQuery_Properties_AdditionalProperties `json:"properties,omitempty"`

	// ReceiptDate Search by receiptDate
	//
	// Example: 2026-06-17T12:00:00.000Z
	ReceiptDate *DateFilter `json:"receiptDate,omitempty"`

	// ScannableCodes Search by scannableCodes
	ScannableCodes *StringListFilter `json:"scannableCodes,omitempty"`

	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`

	// TenantFacilityId tenantFacilityId is handled like facilityRef filter, if you want to search by both you should wrap that filter in an "or" filter
	//
	// Example: MY_FACILITY_ID
	TenantFacilityId *StringFilter `json:"tenantFacilityId,omitempty"`

	// TenantStockId Search by tenantStockId
	//
	// Example: MY_STOCK_ID
	TenantStockId *StringFilter `json:"tenantStockId,omitempty"`

	// Traits Search by traits
	Traits *StockStorageLocationTraitEnumListFilter `json:"traits,omitempty"`

	// Value Search by value
	Value *NumberFilter `json:"value,omitempty"`
}

StockSearchQuery StockSearchQuery

type StockSearchQuery_CustomAttributes_AdditionalProperties

type StockSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

StockSearchQuery_CustomAttributes_AdditionalProperties defines model for StockSearchQuery.customAttributes.AdditionalProperties.

func (StockSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (StockSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (StockSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (StockSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*StockSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*StockSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*StockSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*StockSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (StockSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*StockSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*StockSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*StockSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*StockSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the StockSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*StockSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type StockSearchQuery_Properties_AdditionalProperties

type StockSearchQuery_Properties_AdditionalProperties struct {
	// contains filtered or unexported fields
}

StockSearchQuery_Properties_AdditionalProperties defines model for StockSearchQuery.properties.AdditionalProperties.

func (StockSearchQuery_Properties_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the StockSearchQuery_Properties_AdditionalProperties as a DateFilter

func (StockSearchQuery_Properties_AdditionalProperties) AsKeyExistsFilter

AsKeyExistsFilter returns the union data inside the StockSearchQuery_Properties_AdditionalProperties as a KeyExistsFilter

func (StockSearchQuery_Properties_AdditionalProperties) AsStringFilter

AsStringFilter returns the union data inside the StockSearchQuery_Properties_AdditionalProperties as a StringFilter

func (*StockSearchQuery_Properties_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the StockSearchQuery_Properties_AdditionalProperties as the provided DateFilter

func (*StockSearchQuery_Properties_AdditionalProperties) FromKeyExistsFilter

FromKeyExistsFilter overwrites any union data inside the StockSearchQuery_Properties_AdditionalProperties as the provided KeyExistsFilter

func (*StockSearchQuery_Properties_AdditionalProperties) FromStringFilter

FromStringFilter overwrites any union data inside the StockSearchQuery_Properties_AdditionalProperties as the provided StringFilter

func (StockSearchQuery_Properties_AdditionalProperties) MarshalJSON

func (*StockSearchQuery_Properties_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the StockSearchQuery_Properties_AdditionalProperties, using the provided DateFilter

func (*StockSearchQuery_Properties_AdditionalProperties) MergeKeyExistsFilter

MergeKeyExistsFilter performs a merge with any union data inside the StockSearchQuery_Properties_AdditionalProperties, using the provided KeyExistsFilter

func (*StockSearchQuery_Properties_AdditionalProperties) MergeStringFilter

MergeStringFilter performs a merge with any union data inside the StockSearchQuery_Properties_AdditionalProperties, using the provided StringFilter

func (*StockSearchQuery_Properties_AdditionalProperties) UnmarshalJSON

type StockSort

type StockSort struct {
	CustomAttributes *map[string]interface{}   `json:"customAttributes,omitempty"`
	LastModified     *StockSortLastModified    `json:"lastModified,omitempty"`
	LocationName     *StockSortLocationName    `json:"locationName,omitempty"`
	TenantArticleId  *StockSortTenantArticleId `json:"tenantArticleId,omitempty"`
	Value            *StockSortValue           `json:"value,omitempty"`
}

StockSort StockSort

type StockSortLastModified

type StockSortLastModified string

StockSortLastModified defines model for StockSort.LastModified.

const (
	StockSortLastModifiedASC  StockSortLastModified = "ASC"
	StockSortLastModifiedDESC StockSortLastModified = "DESC"
)

Defines values for StockSortLastModified.

func (StockSortLastModified) Valid

func (e StockSortLastModified) Valid() bool

Valid indicates whether the value is a known member of the StockSortLastModified enum.

type StockSortLocationName

type StockSortLocationName string

StockSortLocationName defines model for StockSort.LocationName.

const (
	StockSortLocationNameASC  StockSortLocationName = "ASC"
	StockSortLocationNameDESC StockSortLocationName = "DESC"
)

Defines values for StockSortLocationName.

func (StockSortLocationName) Valid

func (e StockSortLocationName) Valid() bool

Valid indicates whether the value is a known member of the StockSortLocationName enum.

type StockSortTenantArticleId

type StockSortTenantArticleId string

StockSortTenantArticleId defines model for StockSort.TenantArticleId.

const (
	StockSortTenantArticleIdASC  StockSortTenantArticleId = "ASC"
	StockSortTenantArticleIdDESC StockSortTenantArticleId = "DESC"
)

Defines values for StockSortTenantArticleId.

func (StockSortTenantArticleId) Valid

func (e StockSortTenantArticleId) Valid() bool

Valid indicates whether the value is a known member of the StockSortTenantArticleId enum.

type StockSortValue

type StockSortValue string

StockSortValue defines model for StockSort.Value.

const (
	StockSortValueASC  StockSortValue = "ASC"
	StockSortValueDESC StockSortValue = "DESC"
)

Defines values for StockSortValue.

func (StockSortValue) Valid

func (e StockSortValue) Valid() bool

Valid indicates whether the value is a known member of the StockSortValue enum.

type StockStorageLocationTraitEnumFilter

type StockStorageLocationTraitEnumFilter struct {
	// Eq Search by traits
	Eq *StockStorageLocationTraitEnumFilterEq `json:"eq,omitempty"`

	// In Search by traits
	In *[]StockStorageLocationTraitEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by traits
	NotEq *StockStorageLocationTraitEnumFilterNotEq `json:"notEq,omitempty"`
}

StockStorageLocationTraitEnumFilter StockStorageLocationTraitEnumFilter

type StockStorageLocationTraitEnumFilterEq

type StockStorageLocationTraitEnumFilterEq string

StockStorageLocationTraitEnumFilterEq Search by traits

const (
	StockStorageLocationTraitEnumFilterEqACCESSIBLE StockStorageLocationTraitEnumFilterEq = "ACCESSIBLE"
	StockStorageLocationTraitEnumFilterEqINMOTION   StockStorageLocationTraitEnumFilterEq = "IN_MOTION"
	StockStorageLocationTraitEnumFilterEqKEEPONZERO StockStorageLocationTraitEnumFilterEq = "KEEP_ON_ZERO"
	StockStorageLocationTraitEnumFilterEqOUTBOUND   StockStorageLocationTraitEnumFilterEq = "OUTBOUND"
	StockStorageLocationTraitEnumFilterEqPICKABLE   StockStorageLocationTraitEnumFilterEq = "PICKABLE"
)

Defines values for StockStorageLocationTraitEnumFilterEq.

func (StockStorageLocationTraitEnumFilterEq) Valid

Valid indicates whether the value is a known member of the StockStorageLocationTraitEnumFilterEq enum.

type StockStorageLocationTraitEnumFilterIn

type StockStorageLocationTraitEnumFilterIn string

StockStorageLocationTraitEnumFilterIn defines model for StockStorageLocationTraitEnumFilter.In.

const (
	StockStorageLocationTraitEnumFilterInACCESSIBLE StockStorageLocationTraitEnumFilterIn = "ACCESSIBLE"
	StockStorageLocationTraitEnumFilterInINMOTION   StockStorageLocationTraitEnumFilterIn = "IN_MOTION"
	StockStorageLocationTraitEnumFilterInKEEPONZERO StockStorageLocationTraitEnumFilterIn = "KEEP_ON_ZERO"
	StockStorageLocationTraitEnumFilterInOUTBOUND   StockStorageLocationTraitEnumFilterIn = "OUTBOUND"
	StockStorageLocationTraitEnumFilterInPICKABLE   StockStorageLocationTraitEnumFilterIn = "PICKABLE"
)

Defines values for StockStorageLocationTraitEnumFilterIn.

func (StockStorageLocationTraitEnumFilterIn) Valid

Valid indicates whether the value is a known member of the StockStorageLocationTraitEnumFilterIn enum.

type StockStorageLocationTraitEnumFilterNotEq

type StockStorageLocationTraitEnumFilterNotEq string

StockStorageLocationTraitEnumFilterNotEq Search by traits

const (
	StockStorageLocationTraitEnumFilterNotEqACCESSIBLE StockStorageLocationTraitEnumFilterNotEq = "ACCESSIBLE"
	StockStorageLocationTraitEnumFilterNotEqINMOTION   StockStorageLocationTraitEnumFilterNotEq = "IN_MOTION"
	StockStorageLocationTraitEnumFilterNotEqKEEPONZERO StockStorageLocationTraitEnumFilterNotEq = "KEEP_ON_ZERO"
	StockStorageLocationTraitEnumFilterNotEqOUTBOUND   StockStorageLocationTraitEnumFilterNotEq = "OUTBOUND"
	StockStorageLocationTraitEnumFilterNotEqPICKABLE   StockStorageLocationTraitEnumFilterNotEq = "PICKABLE"
)

Defines values for StockStorageLocationTraitEnumFilterNotEq.

func (StockStorageLocationTraitEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the StockStorageLocationTraitEnumFilterNotEq enum.

type StockStorageLocationTraitEnumListFilter

type StockStorageLocationTraitEnumListFilter struct {
	// Contains Search by traits
	Contains *StockStorageLocationTraitEnumFilter `json:"contains,omitempty"`
}

StockStorageLocationTraitEnumListFilter StockStorageLocationTraitEnumListFilter

type StockSummaries

type StockSummaries struct {
	StockSummaries []StockSummary `json:"stockSummaries"`
	Total          float32        `json:"total"`
}

StockSummaries StockSummaries

type StockSummary

type StockSummary struct {
	// Article StockSummaryArticle
	Article StockSummaryArticle `json:"article"`

	// Details StockSummaryDetails
	Details StockSummaryDetails `json:"details"`

	// IncludedFacilityRefs ALPHA Status!. The facilityRefs that are included in the stock summary.
	//
	// Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
	IncludedFacilityRefs []string `json:"includedFacilityRefs"`
}

StockSummary StockSummary

type StockSummaryArticle

type StockSummaryArticle struct {
	ImageUrl        *string `json:"imageUrl,omitempty"`
	TenantArticleId string  `json:"tenantArticleId"`
	Title           string  `json:"title"`
}

StockSummaryArticle StockSummaryArticle

type StockSummaryDetails

type StockSummaryDetails struct {
	// Available This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Available           float32 `json:"available"`
	AvailableForPicking float32 `json:"availableForPicking"`
	AvailableOnStock    float32 `json:"availableOnStock"`

	// AvailableToPromise This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AvailableToPromise float32 `json:"availableToPromise"`

	// ByTrait ByTrait
	ByTrait         ByTrait                     `json:"byTrait"`
	ChannelAdjusted *[]ChannelStockAvailability `json:"channelAdjusted,omitempty"`

	// ReadyToPick This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ReadyToPick float32 `json:"readyToPick"`
	Reserved    float32 `json:"reserved"`
	SafetyStock float32 `json:"safetyStock"`
	StockOnHand float32 `json:"stockOnHand"`
	TotalAmount float32 `json:"totalAmount"`
}

StockSummaryDetails StockSummaryDetails

type StockTraits

type StockTraits string

StockTraits defines model for Stock.Traits.

const (
	StockTraitsACCESSIBLE StockTraits = "ACCESSIBLE"
	StockTraitsINMOTION   StockTraits = "IN_MOTION"
	StockTraitsKEEPONZERO StockTraits = "KEEP_ON_ZERO"
	StockTraitsOUTBOUND   StockTraits = "OUTBOUND"
	StockTraitsPICKABLE   StockTraits = "PICKABLE"
)

Defines values for StockTraits.

func (StockTraits) Valid

func (e StockTraits) Valid() bool

Valid indicates whether the value is a known member of the StockTraits enum.

type StockUpsertOperationResult

type StockUpsertOperationResult struct {
	Status StockUpsertOperationResultStatus `json:"status"`

	// Stock Stock
	Stock Stock `json:"stock"`
}

StockUpsertOperationResult StockUpsertOperationResult

type StockUpsertOperationResultStatus

type StockUpsertOperationResultStatus string

StockUpsertOperationResultStatus defines model for StockUpsertOperationResult.Status.

const (
	StockUpsertOperationResultStatusCREATED   StockUpsertOperationResultStatus = "CREATED"
	StockUpsertOperationResultStatusUNCHANGED StockUpsertOperationResultStatus = "UNCHANGED"
	StockUpsertOperationResultStatusUPDATED   StockUpsertOperationResultStatus = "UPDATED"
)

Defines values for StockUpsertOperationResultStatus.

func (StockUpsertOperationResultStatus) Valid

Valid indicates whether the value is a known member of the StockUpsertOperationResultStatus enum.

type StockVersionlessUpsertActionResult

type StockVersionlessUpsertActionResult struct {
	// OperationResults StockUpsertOperationResult
	OperationResults StockUpsertOperationResult `json:"operationResults"`
}

StockVersionlessUpsertActionResult StockVersionlessUpsertActionResult

type Stock_Properties added in v0.8.0

type Stock_Properties struct {
	Expiry               *string           `json:"expiry,omitempty"`
	AdditionalProperties map[string]string `json:"-"`
}

Stock_Properties allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see "customAttributes" for that).

func (Stock_Properties) Get added in v0.8.0

func (a Stock_Properties) Get(fieldName string) (value string, found bool)

Getter for additional properties for Stock_Properties. Returns the specified element and whether it was found

func (Stock_Properties) MarshalJSON added in v0.8.0

func (a Stock_Properties) MarshalJSON() ([]byte, error)

Override default JSON handling for Stock_Properties to handle AdditionalProperties

func (*Stock_Properties) Set added in v0.8.0

func (a *Stock_Properties) Set(fieldName string, value string)

Setter for additional properties for Stock_Properties

func (*Stock_Properties) UnmarshalJSON added in v0.8.0

func (a *Stock_Properties) UnmarshalJSON(b []byte) error

Override default JSON handling for Stock_Properties to handle AdditionalProperties

type StocksForUpsert

type StocksForUpsert struct {
	// Stocks Please be sure to include each stock (by ID) only once, when updating. Otherwise the whole batch is rejected with an error.
	Stocks []StocksForUpsert_Stocks_Item `json:"stocks"`
}

StocksForUpsert StocksForUpsert

type StocksForUpsertStocks2

type StocksForUpsertStocks2 struct {
	Id          string  `json:"id"`
	LocationRef *string `json:"locationRef,omitempty"`
	Value       int32   `json:"value"`
}

StocksForUpsertStocks2 defines model for StocksForUpsert.Stocks.2.

type StocksForUpsert_Stocks_Item

type StocksForUpsert_Stocks_Item struct {
	// contains filtered or unexported fields
}

StocksForUpsert_Stocks_Item defines model for StocksForUpsert.stocks.Item.

func (StocksForUpsert_Stocks_Item) AsStockForCreation

func (t StocksForUpsert_Stocks_Item) AsStockForCreation() (StockForCreation, error)

AsStockForCreation returns the union data inside the StocksForUpsert_Stocks_Item as a StockForCreation

func (StocksForUpsert_Stocks_Item) AsStockForUpsertUpdate

func (t StocksForUpsert_Stocks_Item) AsStockForUpsertUpdate() (StockForUpsertUpdate, error)

AsStockForUpsertUpdate returns the union data inside the StocksForUpsert_Stocks_Item as a StockForUpsertUpdate

func (StocksForUpsert_Stocks_Item) AsStocksForUpsertStocks2

func (t StocksForUpsert_Stocks_Item) AsStocksForUpsertStocks2() (StocksForUpsertStocks2, error)

AsStocksForUpsertStocks2 returns the union data inside the StocksForUpsert_Stocks_Item as a StocksForUpsertStocks2

func (*StocksForUpsert_Stocks_Item) FromStockForCreation

func (t *StocksForUpsert_Stocks_Item) FromStockForCreation(v StockForCreation) error

FromStockForCreation overwrites any union data inside the StocksForUpsert_Stocks_Item as the provided StockForCreation

func (*StocksForUpsert_Stocks_Item) FromStockForUpsertUpdate

func (t *StocksForUpsert_Stocks_Item) FromStockForUpsertUpdate(v StockForUpsertUpdate) error

FromStockForUpsertUpdate overwrites any union data inside the StocksForUpsert_Stocks_Item as the provided StockForUpsertUpdate

func (*StocksForUpsert_Stocks_Item) FromStocksForUpsertStocks2

func (t *StocksForUpsert_Stocks_Item) FromStocksForUpsertStocks2(v StocksForUpsertStocks2) error

FromStocksForUpsertStocks2 overwrites any union data inside the StocksForUpsert_Stocks_Item as the provided StocksForUpsertStocks2

func (StocksForUpsert_Stocks_Item) MarshalJSON

func (t StocksForUpsert_Stocks_Item) MarshalJSON() ([]byte, error)

func (*StocksForUpsert_Stocks_Item) MergeStockForCreation

func (t *StocksForUpsert_Stocks_Item) MergeStockForCreation(v StockForCreation) error

MergeStockForCreation performs a merge with any union data inside the StocksForUpsert_Stocks_Item, using the provided StockForCreation

func (*StocksForUpsert_Stocks_Item) MergeStockForUpsertUpdate

func (t *StocksForUpsert_Stocks_Item) MergeStockForUpsertUpdate(v StockForUpsertUpdate) error

MergeStockForUpsertUpdate performs a merge with any union data inside the StocksForUpsert_Stocks_Item, using the provided StockForUpsertUpdate

func (*StocksForUpsert_Stocks_Item) MergeStocksForUpsertStocks2

func (t *StocksForUpsert_Stocks_Item) MergeStocksForUpsertStocks2(v StocksForUpsertStocks2) error

MergeStocksForUpsertStocks2 performs a merge with any union data inside the StocksForUpsert_Stocks_Item, using the provided StocksForUpsertStocks2

func (*StocksForUpsert_Stocks_Item) UnmarshalJSON

func (t *StocksForUpsert_Stocks_Item) UnmarshalJSON(b []byte) error

type StorageLocationReferencedFilter

type StorageLocationReferencedFilter struct {
	// Stock Nested search by stock
	Stock *StorageLocationReferencedStockFilter `json:"stock,omitempty"`
}

StorageLocationReferencedFilter StorageLocationReferencedFilter

type StorageLocationReferencedStockFilter

type StorageLocationReferencedStockFilter struct {
	// HasStocks Whether the storage locations has any stocks on it.
	HasStocks *BooleanFilter `json:"hasStocks,omitempty"`

	// SumOfValues The sum of all stock values in this storage location, i.e. how much stock is stored in this location.
	SumOfValues *NumberFilter `json:"sumOfValues,omitempty"`
}

StorageLocationReferencedStockFilter StorageLocationReferencedStockFilter

type StorageLocationSearchQuery

type StorageLocationSearchQuery struct {
	And *[]StorageLocationSearchQuery `json:"and,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]StorageLocationSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Name Search by name
	Name *StringFilter                 `json:"name,omitempty"`
	Or   *[]StorageLocationSearchQuery `json:"or,omitempty"`

	// Referenced Nested search by referenced
	Referenced *StorageLocationReferencedFilter `json:"referenced,omitempty"`

	// ScannableCodes Search by scannableCodes
	ScannableCodes *StringListFilter `json:"scannableCodes,omitempty"`

	// TenantLocationId Search by tenantLocationId
	//
	// Example: MY_LOCATION_ID
	TenantLocationId *StringFilter `json:"tenantLocationId,omitempty"`

	// Traits Search by traits
	Traits *StorageLocationTraitEnumListFilter `json:"traits,omitempty"`

	// Type Search by type
	Type *StorageLocationTypeEnumFilter `json:"type,omitempty"`

	// ZoneRef Search by zoneRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	ZoneRef *StringFilter `json:"zoneRef,omitempty"`
}

StorageLocationSearchQuery StorageLocationSearchQuery

type StorageLocationSearchQuery_CustomAttributes_AdditionalProperties

type StorageLocationSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

StorageLocationSearchQuery_CustomAttributes_AdditionalProperties defines model for StorageLocationSearchQuery.customAttributes.AdditionalProperties.

func (StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the StorageLocationSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*StorageLocationSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type StorageLocationTraitConfigEntry

type StorageLocationTraitConfigEntry struct {
	// Enabled whether the trait is enabled or not
	Enabled bool `json:"enabled"`

	// Trait Describes what kind of actions this stock is available for
	//      * `PICKABLE`- The stock is available for picking
	//      * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)
	//      * `KEEP_ON_ZERO`- The stock will not be deleted when emptied
	//      * `OUTBOUND`- The stock is intended for outbound processes
	Trait string `json:"trait"`
}

StorageLocationTraitConfigEntry StorageLocationTraitConfigEntry

type StorageLocationTraitEnumFilter

type StorageLocationTraitEnumFilter struct {
	// Eq Search by traits
	Eq *StorageLocationTraitEnumFilterEq `json:"eq,omitempty"`

	// In Search by traits
	In *[]StorageLocationTraitEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by traits
	NotEq *StorageLocationTraitEnumFilterNotEq `json:"notEq,omitempty"`
}

StorageLocationTraitEnumFilter StorageLocationTraitEnumFilter

type StorageLocationTraitEnumFilterEq

type StorageLocationTraitEnumFilterEq string

StorageLocationTraitEnumFilterEq Search by traits

const (
	StorageLocationTraitEnumFilterEqACCESSIBLE StorageLocationTraitEnumFilterEq = "ACCESSIBLE"
	StorageLocationTraitEnumFilterEqINMOTION   StorageLocationTraitEnumFilterEq = "IN_MOTION"
	StorageLocationTraitEnumFilterEqKEEPONZERO StorageLocationTraitEnumFilterEq = "KEEP_ON_ZERO"
	StorageLocationTraitEnumFilterEqOUTBOUND   StorageLocationTraitEnumFilterEq = "OUTBOUND"
	StorageLocationTraitEnumFilterEqPICKABLE   StorageLocationTraitEnumFilterEq = "PICKABLE"
)

Defines values for StorageLocationTraitEnumFilterEq.

func (StorageLocationTraitEnumFilterEq) Valid

Valid indicates whether the value is a known member of the StorageLocationTraitEnumFilterEq enum.

type StorageLocationTraitEnumFilterIn

type StorageLocationTraitEnumFilterIn string

StorageLocationTraitEnumFilterIn defines model for StorageLocationTraitEnumFilter.In.

const (
	StorageLocationTraitEnumFilterInACCESSIBLE StorageLocationTraitEnumFilterIn = "ACCESSIBLE"
	StorageLocationTraitEnumFilterInINMOTION   StorageLocationTraitEnumFilterIn = "IN_MOTION"
	StorageLocationTraitEnumFilterInKEEPONZERO StorageLocationTraitEnumFilterIn = "KEEP_ON_ZERO"
	StorageLocationTraitEnumFilterInOUTBOUND   StorageLocationTraitEnumFilterIn = "OUTBOUND"
	StorageLocationTraitEnumFilterInPICKABLE   StorageLocationTraitEnumFilterIn = "PICKABLE"
)

Defines values for StorageLocationTraitEnumFilterIn.

func (StorageLocationTraitEnumFilterIn) Valid

Valid indicates whether the value is a known member of the StorageLocationTraitEnumFilterIn enum.

type StorageLocationTraitEnumFilterNotEq

type StorageLocationTraitEnumFilterNotEq string

StorageLocationTraitEnumFilterNotEq Search by traits

const (
	StorageLocationTraitEnumFilterNotEqACCESSIBLE StorageLocationTraitEnumFilterNotEq = "ACCESSIBLE"
	StorageLocationTraitEnumFilterNotEqINMOTION   StorageLocationTraitEnumFilterNotEq = "IN_MOTION"
	StorageLocationTraitEnumFilterNotEqKEEPONZERO StorageLocationTraitEnumFilterNotEq = "KEEP_ON_ZERO"
	StorageLocationTraitEnumFilterNotEqOUTBOUND   StorageLocationTraitEnumFilterNotEq = "OUTBOUND"
	StorageLocationTraitEnumFilterNotEqPICKABLE   StorageLocationTraitEnumFilterNotEq = "PICKABLE"
)

Defines values for StorageLocationTraitEnumFilterNotEq.

func (StorageLocationTraitEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the StorageLocationTraitEnumFilterNotEq enum.

type StorageLocationTraitEnumListFilter

type StorageLocationTraitEnumListFilter struct {
	// Contains Search by traits
	Contains *StorageLocationTraitEnumFilter `json:"contains,omitempty"`
}

StorageLocationTraitEnumListFilter StorageLocationTraitEnumListFilter

type StorageLocationTypeEnumFilter

type StorageLocationTypeEnumFilter struct {
	// Eq Search by type
	Eq *StorageLocationTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by type
	In *[]StorageLocationTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by type
	NotEq *StorageLocationTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

StorageLocationTypeEnumFilter StorageLocationTypeEnumFilter

type StorageLocationTypeEnumFilterEq

type StorageLocationTypeEnumFilterEq string

StorageLocationTypeEnumFilterEq Search by type

const (
	StorageLocationTypeEnumFilterEqBULKSTORAGE   StorageLocationTypeEnumFilterEq = "BULK_STORAGE"
	StorageLocationTypeEnumFilterEqSINGLESTORAGE StorageLocationTypeEnumFilterEq = "SINGLE_STORAGE"
)

Defines values for StorageLocationTypeEnumFilterEq.

func (StorageLocationTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the StorageLocationTypeEnumFilterEq enum.

type StorageLocationTypeEnumFilterIn

type StorageLocationTypeEnumFilterIn string

StorageLocationTypeEnumFilterIn defines model for StorageLocationTypeEnumFilter.In.

const (
	StorageLocationTypeEnumFilterInBULKSTORAGE   StorageLocationTypeEnumFilterIn = "BULK_STORAGE"
	StorageLocationTypeEnumFilterInSINGLESTORAGE StorageLocationTypeEnumFilterIn = "SINGLE_STORAGE"
)

Defines values for StorageLocationTypeEnumFilterIn.

func (StorageLocationTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the StorageLocationTypeEnumFilterIn enum.

type StorageLocationTypeEnumFilterNotEq

type StorageLocationTypeEnumFilterNotEq string

StorageLocationTypeEnumFilterNotEq Search by type

const (
	StorageLocationTypeEnumFilterNotEqBULKSTORAGE   StorageLocationTypeEnumFilterNotEq = "BULK_STORAGE"
	StorageLocationTypeEnumFilterNotEqSINGLESTORAGE StorageLocationTypeEnumFilterNotEq = "SINGLE_STORAGE"
)

Defines values for StorageLocationTypeEnumFilterNotEq.

func (StorageLocationTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the StorageLocationTypeEnumFilterNotEq enum.

type StowJobSearchQuery

type StowJobSearchQuery struct {
	And *[]StowJobSearchQuery `json:"and,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	//
	// Example: {"after":"-P1W"}
	Created *DateFilter `json:"created,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]StowJobSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter         `json:"id,omitempty"`
	Or *[]StowJobSearchQuery `json:"or,omitempty"`

	// Priority Search by priority
	Priority *NumberFilter `json:"priority,omitempty"`

	// ShortId Search by shortId
	ShortId *StringFilter `json:"shortId,omitempty"`

	// Status Search by status
	Status *StowJobStatusTypeEnumFilter `json:"status,omitempty"`

	// StowLineItems Nested list search by stowLineItems
	StowLineItems *StowJobStowLineItemsListFilter `json:"stowLineItems,omitempty"`

	// TargetTime Search by targetTime
	//
	// Example: 2026-06-17T12:00:00.000Z
	TargetTime *DateFilter `json:"targetTime,omitempty"`
}

StowJobSearchQuery StowJobSearchQuery

type StowJobSearchQuery_CustomAttributes_AdditionalProperties

type StowJobSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

StowJobSearchQuery_CustomAttributes_AdditionalProperties defines model for StowJobSearchQuery.customAttributes.AdditionalProperties.

func (StowJobSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (StowJobSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (StowJobSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (StowJobSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*StowJobSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*StowJobSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*StowJobSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*StowJobSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (StowJobSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*StowJobSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*StowJobSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*StowJobSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*StowJobSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the StowJobSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*StowJobSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type StowJobStatusTypeEnumFilter

type StowJobStatusTypeEnumFilter struct {
	// Eq Search by status
	Eq *StowJobStatusTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by status
	In *[]StowJobStatusTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by status
	NotEq *StowJobStatusTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

StowJobStatusTypeEnumFilter StowJobStatusTypeEnumFilter

type StowJobStatusTypeEnumFilterEq

type StowJobStatusTypeEnumFilterEq string

StowJobStatusTypeEnumFilterEq Search by status

const (
	StowJobStatusTypeEnumFilterEqCANCELED   StowJobStatusTypeEnumFilterEq = "CANCELED"
	StowJobStatusTypeEnumFilterEqCLOSED     StowJobStatusTypeEnumFilterEq = "CLOSED"
	StowJobStatusTypeEnumFilterEqINPROGRESS StowJobStatusTypeEnumFilterEq = "IN_PROGRESS"
	StowJobStatusTypeEnumFilterEqOPEN       StowJobStatusTypeEnumFilterEq = "OPEN"
	StowJobStatusTypeEnumFilterEqPAUSED     StowJobStatusTypeEnumFilterEq = "PAUSED"
)

Defines values for StowJobStatusTypeEnumFilterEq.

func (StowJobStatusTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the StowJobStatusTypeEnumFilterEq enum.

type StowJobStatusTypeEnumFilterIn

type StowJobStatusTypeEnumFilterIn string

StowJobStatusTypeEnumFilterIn defines model for StowJobStatusTypeEnumFilter.In.

const (
	StowJobStatusTypeEnumFilterInCANCELED   StowJobStatusTypeEnumFilterIn = "CANCELED"
	StowJobStatusTypeEnumFilterInCLOSED     StowJobStatusTypeEnumFilterIn = "CLOSED"
	StowJobStatusTypeEnumFilterInINPROGRESS StowJobStatusTypeEnumFilterIn = "IN_PROGRESS"
	StowJobStatusTypeEnumFilterInOPEN       StowJobStatusTypeEnumFilterIn = "OPEN"
	StowJobStatusTypeEnumFilterInPAUSED     StowJobStatusTypeEnumFilterIn = "PAUSED"
)

Defines values for StowJobStatusTypeEnumFilterIn.

func (StowJobStatusTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the StowJobStatusTypeEnumFilterIn enum.

type StowJobStatusTypeEnumFilterNotEq

type StowJobStatusTypeEnumFilterNotEq string

StowJobStatusTypeEnumFilterNotEq Search by status

const (
	StowJobStatusTypeEnumFilterNotEqCANCELED   StowJobStatusTypeEnumFilterNotEq = "CANCELED"
	StowJobStatusTypeEnumFilterNotEqCLOSED     StowJobStatusTypeEnumFilterNotEq = "CLOSED"
	StowJobStatusTypeEnumFilterNotEqINPROGRESS StowJobStatusTypeEnumFilterNotEq = "IN_PROGRESS"
	StowJobStatusTypeEnumFilterNotEqOPEN       StowJobStatusTypeEnumFilterNotEq = "OPEN"
	StowJobStatusTypeEnumFilterNotEqPAUSED     StowJobStatusTypeEnumFilterNotEq = "PAUSED"
)

Defines values for StowJobStatusTypeEnumFilterNotEq.

func (StowJobStatusTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the StowJobStatusTypeEnumFilterNotEq enum.

type StowJobStowLineItemsArticleFilter

type StowJobStowLineItemsArticleFilter struct {
	// TenantArticleId Search by tenantArticleId
	//
	// Example: MY_ARTICLE_ID
	TenantArticleId *StringFilter `json:"tenantArticleId,omitempty"`
}

StowJobStowLineItemsArticleFilter StowJobStowLineItemsArticleFilter

type StowJobStowLineItemsFilter

type StowJobStowLineItemsFilter struct {
	// Article Nested search by article
	Article *StowJobStowLineItemsArticleFilter `json:"article,omitempty"`

	// HeldStockRef Search by heldStockRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	HeldStockRef *StringFilter `json:"heldStockRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// StowTo Nested list search by stowTo
	StowTo *StowJobStowLineItemsStowToListFilter `json:"stowTo,omitempty"`

	// TakeFrom Nested search by takeFrom
	TakeFrom *StowJobStowLineItemsTakeFromFilter `json:"takeFrom,omitempty"`
}

StowJobStowLineItemsFilter StowJobStowLineItemsFilter

type StowJobStowLineItemsListFilter

type StowJobStowLineItemsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *StowJobStowLineItemsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

StowJobStowLineItemsListFilter StowJobStowLineItemsListFilter

type StowJobStowLineItemsStowToFilter

type StowJobStowLineItemsStowToFilter struct {
	// StorageLocationRef Search by storageLocationRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	StorageLocationRef *StringFilter `json:"storageLocationRef,omitempty"`

	// Stowed Nested search by stowed
	Stowed *StowJobStowLineItemsStowToStowedFilter `json:"stowed,omitempty"`

	// Type Search by type
	Type *StringFilter `json:"type,omitempty"`
}

StowJobStowLineItemsStowToFilter StowJobStowLineItemsStowToFilter

type StowJobStowLineItemsStowToListFilter

type StowJobStowLineItemsStowToListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *StowJobStowLineItemsStowToFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

StowJobStowLineItemsStowToListFilter StowJobStowLineItemsStowToListFilter

type StowJobStowLineItemsStowToStowedFilter

type StowJobStowLineItemsStowToStowedFilter struct {
	// StowedStockRef Search by stowedStockRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	StowedStockRef *StringFilter `json:"stowedStockRef,omitempty"`

	// StowedStorageLocationRef Search by stowedStorageLocationRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	StowedStorageLocationRef *StringFilter `json:"stowedStorageLocationRef,omitempty"`
}

StowJobStowLineItemsStowToStowedFilter StowJobStowLineItemsStowToStowedFilter

type StowJobStowLineItemsTakeFromFilter

type StowJobStowLineItemsTakeFromFilter struct {
	// StorageLocationRef Search by storageLocationRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	StorageLocationRef *StringFilter `json:"storageLocationRef,omitempty"`

	// Taken Nested search by taken
	Taken *StowJobStowLineItemsTakeFromTakenFilter `json:"taken,omitempty"`

	// Type Search by type
	Type *StringFilter `json:"type,omitempty"`
}

StowJobStowLineItemsTakeFromFilter StowJobStowLineItemsTakeFromFilter

type StowJobStowLineItemsTakeFromTakenFilter

type StowJobStowLineItemsTakeFromTakenFilter struct {
	// TakenStockRef Search by takenStockRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	TakenStockRef *StringFilter `json:"takenStockRef,omitempty"`
}

StowJobStowLineItemsTakeFromTakenFilter StowJobStowLineItemsTakeFromTakenFilter

type StringEqFilter

type StringEqFilter struct {
	Eq    *string `json:"eq,omitempty"`
	NotEq *string `json:"notEq,omitempty"`
}

StringEqFilter StringEqFilter

type StringFilter

type StringFilter struct {
	Eq    *string   `json:"eq,omitempty"`
	In    *[]string `json:"in,omitempty"`
	NotEq *string   `json:"notEq,omitempty"`
	NotIn *[]string `json:"notIn,omitempty"`
}

StringFilter StringFilter

type StringListExistsFilter

type StringListExistsFilter struct {
	// Contains StringEqFilter
	Contains *StringEqFilter `json:"contains,omitempty"`

	// Exists Search all entities which have or do not have this key defined
	Exists *bool `json:"exists,omitempty"`
}

StringListExistsFilter StringListExistsFilter

type StringListFilter

type StringListFilter struct {
	// Contains StringEqFilter
	Contains *StringEqFilter `json:"contains,omitempty"`
}

StringListFilter StringListFilter

type StringSearchFilter

type StringSearchFilter struct {
	Eq *string   `json:"eq,omitempty"`
	In *[]string `json:"in,omitempty"`

	// Like Search by regex pattern
	Like  *string   `json:"like,omitempty"`
	NotEq *string   `json:"notEq,omitempty"`
	NotIn *[]string `json:"notIn,omitempty"`
}

StringSearchFilter StringSearchFilter

type StrippedCarrier

type StrippedCarrier struct {
	// Created The date this entity was created at the platform. This value is generated by the service.
	Created *time.Time `json:"created,omitempty"`

	// DeliveryType The delivery type of this carrier
	DeliveryType *StrippedCarrierDeliveryType `json:"deliveryType,omitempty"`

	// Id The id of the carrier
	//
	// Example: LGMl2DuvPnfPoSHhYFOm
	Id string `json:"id"`

	// Key References the KEP. Currently allowed values are DHL_V2, DPD_CH, DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.
	//
	// Example: DHL_V2
	Key string `json:"key"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Lifecycle The lifecycle of this carrier
	Lifecycle *StrippedCarrierLifecycle `json:"lifecycle,omitempty"`

	// Name This is the well known name for a supported CEP partner. Can be adapted to the clients needs.
	//
	// Example: DHL
	Name string `json:"name"`

	// Status The status of this carrier
	Status *StrippedCarrierStatus `json:"status,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int `json:"version"`
}

StrippedCarrier StrippedCarrier

type StrippedCarrierDeliveryType

type StrippedCarrierDeliveryType string

StrippedCarrierDeliveryType The delivery type of this carrier

const (
	StrippedCarrierDeliveryTypeDELIVERY StrippedCarrierDeliveryType = "DELIVERY"
	StrippedCarrierDeliveryTypeSAMEDAY  StrippedCarrierDeliveryType = "SAMEDAY"
)

Defines values for StrippedCarrierDeliveryType.

func (StrippedCarrierDeliveryType) Valid

Valid indicates whether the value is a known member of the StrippedCarrierDeliveryType enum.

type StrippedCarrierLifecycle

type StrippedCarrierLifecycle string

StrippedCarrierLifecycle The lifecycle of this carrier

const (
	StrippedCarrierLifecycleALPHA StrippedCarrierLifecycle = "ALPHA"
	StrippedCarrierLifecycleBETA  StrippedCarrierLifecycle = "BETA"
	StrippedCarrierLifecycleGA    StrippedCarrierLifecycle = "GA"
)

Defines values for StrippedCarrierLifecycle.

func (StrippedCarrierLifecycle) Valid

func (e StrippedCarrierLifecycle) Valid() bool

Valid indicates whether the value is a known member of the StrippedCarrierLifecycle enum.

type StrippedCarrierStatus

type StrippedCarrierStatus string

StrippedCarrierStatus The status of this carrier

const (
	StrippedCarrierStatusACTIVE   StrippedCarrierStatus = "ACTIVE"
	StrippedCarrierStatusINACTIVE StrippedCarrierStatus = "INACTIVE"
)

Defines values for StrippedCarrierStatus.

func (StrippedCarrierStatus) Valid

func (e StrippedCarrierStatus) Valid() bool

Valid indicates whether the value is a known member of the StrippedCarrierStatus enum.

type StrippedCarriers

type StrippedCarriers struct {
	// Carriers List of carriers
	Carriers *[]StrippedCarrier `json:"carriers,omitempty"`

	// Total Total number of found entities for this query
	//
	// Example: 42
	Total *int `json:"total,omitempty"`
}

StrippedCarriers StrippedCarriers

type StrippedFacilities

type StrippedFacilities struct {
	Facilities *[]StrippedFacilities_Facilities_Item `json:"facilities,omitempty"`

	// Total Total number of found entities for this query
	//
	// Example: 42
	Total *int `json:"total,omitempty"`
}

StrippedFacilities StrippedFacilities

type StrippedFacilities_Facilities_Item

type StrippedFacilities_Facilities_Item struct {
	// contains filtered or unexported fields
}

StrippedFacilities_Facilities_Item defines model for StrippedFacilities.facilities.Item.

func (StrippedFacilities_Facilities_Item) AsStrippedManagedFacility

func (t StrippedFacilities_Facilities_Item) AsStrippedManagedFacility() (StrippedManagedFacility, error)

AsStrippedManagedFacility returns the union data inside the StrippedFacilities_Facilities_Item as a StrippedManagedFacility

func (StrippedFacilities_Facilities_Item) AsSupplier

AsSupplier returns the union data inside the StrippedFacilities_Facilities_Item as a Supplier

func (*StrippedFacilities_Facilities_Item) FromStrippedManagedFacility

func (t *StrippedFacilities_Facilities_Item) FromStrippedManagedFacility(v StrippedManagedFacility) error

FromStrippedManagedFacility overwrites any union data inside the StrippedFacilities_Facilities_Item as the provided StrippedManagedFacility

func (*StrippedFacilities_Facilities_Item) FromSupplier

FromSupplier overwrites any union data inside the StrippedFacilities_Facilities_Item as the provided Supplier

func (StrippedFacilities_Facilities_Item) MarshalJSON

func (t StrippedFacilities_Facilities_Item) MarshalJSON() ([]byte, error)

func (*StrippedFacilities_Facilities_Item) MergeStrippedManagedFacility

func (t *StrippedFacilities_Facilities_Item) MergeStrippedManagedFacility(v StrippedManagedFacility) error

MergeStrippedManagedFacility performs a merge with any union data inside the StrippedFacilities_Facilities_Item, using the provided StrippedManagedFacility

func (*StrippedFacilities_Facilities_Item) MergeSupplier

MergeSupplier performs a merge with any union data inside the StrippedFacilities_Facilities_Item, using the provided Supplier

func (*StrippedFacilities_Facilities_Item) UnmarshalJSON

func (t *StrippedFacilities_Facilities_Item) UnmarshalJSON(b []byte) error

type StrippedListing

type StrippedListing struct {
	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// Id Example: fsfdsf87fsd
	Id string `json:"id"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time            `json:"lastModified,omitempty"`
	Status       StrippedListingStatus `json:"status"`

	// TenantArticleId This is a reference to an article Id
	//
	// Example: 4711
	TenantArticleId string `json:"tenantArticleId"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

StrippedListing StrippedListing

type StrippedListingStatus

type StrippedListingStatus string

StrippedListingStatus defines model for StrippedListing.Status.

const (
	StrippedListingStatusACTIVE   StrippedListingStatus = "ACTIVE"
	StrippedListingStatusINACTIVE StrippedListingStatus = "INACTIVE"
)

Defines values for StrippedListingStatus.

func (StrippedListingStatus) Valid

func (e StrippedListingStatus) Valid() bool

Valid indicates whether the value is a known member of the StrippedListingStatus enum.

type StrippedListings

type StrippedListings struct {
	Listings *[]StrippedListing `json:"listings,omitempty"`

	// Total Total number of found entities for this query
	//
	// Example: 42
	Total *int `json:"total,omitempty"`
}

StrippedListings StrippedListings

type StrippedManagedFacility

type StrippedManagedFacility struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// City Example: Langenfeld
	City string `json:"city"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country string `json:"country"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber *string `json:"houseNumber,omitempty"`
	Id          string  `json:"id"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Name name of the facility
	//
	// Example: Köln store
	Name         *string `json:"name,omitempty"`
	PhoneNumbers *[]struct {
		// CustomAttributes Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
		CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

		// Label Can be used to give a description for the number, like "private", "business number", etc.
		Label *string                                 `json:"label,omitempty"`
		Type  StrippedManagedFacilityPhoneNumbersType `json:"type"`

		// Value The number itself. We do not enforce any format (yet).
		Value string `json:"value"`
	} `json:"phoneNumbers,omitempty"`

	// PostalCode Example: 40764
	PostalCode string `json:"postalCode"`

	// Province Example: NRW
	Province *string `json:"province,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status FacilityStatus `json:"status"`

	// Street Example: Hauptstr.
	Street string `json:"street"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type FacilityType `json:"type"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

StrippedManagedFacility StrippedManagedFacility

type StrippedManagedFacilityPhoneNumbersType

type StrippedManagedFacilityPhoneNumbersType string

StrippedManagedFacilityPhoneNumbersType defines model for StrippedManagedFacility.PhoneNumbers.Type.

const (
	StrippedManagedFacilityPhoneNumbersTypeMOBILE StrippedManagedFacilityPhoneNumbersType = "MOBILE"
	StrippedManagedFacilityPhoneNumbersTypePHONE  StrippedManagedFacilityPhoneNumbersType = "PHONE"
)

Defines values for StrippedManagedFacilityPhoneNumbersType.

func (StrippedManagedFacilityPhoneNumbersType) Valid

Valid indicates whether the value is a known member of the StrippedManagedFacilityPhoneNumbersType enum.

type StrippedOrder added in v0.3.0

type StrippedOrder struct {
	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// Id The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.
	//
	// Example: LGMl2DuvPnfPoSHhYFOm
	Id string `json:"id"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// OrderDate The date this order was created at the supplying system.
	//
	// Example: 2020-02-03T08:45:50.525Z
	OrderDate      time.Time `json:"orderDate"`
	OrderLineItems *[]struct {
		// Quantity quantity of the specific article that has been ordered
		//
		// Example: 21
		Quantity int64 `json:"quantity"`

		// Title Example: Cologne Water
		Title string `json:"title"`
	} `json:"orderLineItems,omitempty"`
	ProcessRef *string `json:"processRef,omitempty"`

	// Status The state of the order. Initially it is OPEN.
	Status   OrderStatus `json:"status"`
	Stickers *[]Sticker  `json:"stickers,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

StrippedOrder StrippedOrder

type StrippedOrders added in v0.3.0

type StrippedOrders struct {
	Orders *[]StrippedOrder `json:"orders,omitempty"`

	// Total Total number of found entities for this query
	//
	// Example: 42
	Total *int `json:"total,omitempty"`
}

StrippedOrders StrippedOrders

type Substitute added in v0.2.0

type Substitute struct {
	Attributes *[]SubstituteAttributeItem `json:"attributes,omitempty"`
	ImageUrl   *string                    `json:"imageUrl,omitempty"`

	// MeasurementUnitKey Identifier for items unit of measurement.
	//
	// Example: liter
	MeasurementUnitKey *string `json:"measurementUnitKey,omitempty"`

	// MeasurementValidation MeasurementValidation
	MeasurementValidation *MeasurementValidation `json:"measurementValidation,omitempty"`

	// Priority This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.
	Priority       *float32  `json:"priority,omitempty"`
	ScannableCodes *[]string `json:"scannableCodes,omitempty"`

	// SecondaryMeasurementUnitKey Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram
	//
	// Example: gram
	SecondaryMeasurementUnitKey *string `json:"secondaryMeasurementUnitKey,omitempty"`
	TenantArticleId             string  `json:"tenantArticleId"`
	Title                       string  `json:"title"`
}

Substitute Substitute

type SubstituteAttributeItem added in v0.2.0

type SubstituteAttributeItem = ArticleAttributeItem

SubstituteAttributeItem SubstituteAttributeItem

type Supplier

type Supplier struct {
	// Address SupplierAddress
	Address *SupplierAddress `json:"address,omitempty"`

	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Name Example: Hamburg NW2
	Name           string                              `json:"name"`
	OperativeCosts *[]FacilityOperativeCostForCreation `json:"operativeCosts,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status *FacilityStatus `json:"status,omitempty"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type *FacilityType `json:"type,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

Supplier Supplier

type SupplierAddress

type SupplierAddress struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// City Example: Langenfeld
	City *string `json:"city,omitempty"`

	// CompanyName Example: Speedy Boxales Ltd.
	CompanyName string `json:"companyName"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country string `json:"country"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{}        `json:"customAttributes,omitempty"`
	EmailAddresses   *[]SupplierAddressEmailAddress `json:"emailAddresses,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber  *string                       `json:"houseNumber,omitempty"`
	PhoneNumbers *[]SupplierAddressPhoneNumber `json:"phoneNumbers,omitempty"`

	// PostalCode Example: 40764
	PostalCode *string `json:"postalCode,omitempty"`

	// Province Example: NRW
	Province *string `json:"province,omitempty"`

	// ResolvedCoordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
	ResolvedCoordinates *Coordinates `json:"resolvedCoordinates,omitempty"`

	// ResolvedTimeZone Timezone for information retrieved e.g. by the Google Maps API
	ResolvedTimeZone *TimeZone `json:"resolvedTimeZone,omitempty"`

	// Street Example: Hauptstr.
	Street *string `json:"street,omitempty"`
}

SupplierAddress SupplierAddress

type SupplierAddressEmailAddress

type SupplierAddressEmailAddress struct {
	// Recipient Human readable information who is the recipient for emails sent to this address.
	//
	// Example: 'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.
	Recipient *string             `json:"recipient,omitempty"`
	Value     openapi_types.Email `json:"value"`
}

SupplierAddressEmailAddress SupplierAddressEmailAddress

type SupplierAddressForCreation

type SupplierAddressForCreation struct {
	// AdditionalAddressInfo Example: to care of: Mrs. Müller
	AdditionalAddressInfo *string `json:"additionalAddressInfo,omitempty"`

	// City Example: Langenfeld
	City *string `json:"city,omitempty"`

	// CompanyName Example: Speedy Boxales Ltd.
	CompanyName string `json:"companyName"`

	// Country A two-digit country code as per ISO 3166-1 alpha-2
	//
	// Example: DE
	Country string `json:"country"`

	// CustomAttributes Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{}        `json:"customAttributes,omitempty"`
	EmailAddresses   *[]SupplierAddressEmailAddress `json:"emailAddresses,omitempty"`

	// HouseNumber Example: 42a
	HouseNumber  *string                       `json:"houseNumber,omitempty"`
	PhoneNumbers *[]SupplierAddressPhoneNumber `json:"phoneNumbers,omitempty"`

	// PostalCode Example: 40764
	PostalCode *string `json:"postalCode,omitempty"`

	// Province Example: NRW
	Province *string `json:"province,omitempty"`

	// ResolvedCoordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
	ResolvedCoordinates *Coordinates `json:"resolvedCoordinates,omitempty"`

	// ResolvedTimeZone Self-provided timezone for determining the local time of a facility
	ResolvedTimeZone *TimeZoneForCreation `json:"resolvedTimeZone,omitempty"`

	// Street Example: Hauptstr.
	Street *string `json:"street,omitempty"`
}

SupplierAddressForCreation SupplierAddressForCreation

type SupplierAddressPhoneNumber

type SupplierAddressPhoneNumber struct {
	// CustomAttributes Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Label Can be used to give a description for the number, like "private", "business number", etc.
	Label *string                        `json:"label,omitempty"`
	Type  SupplierAddressPhoneNumberType `json:"type"`

	// Value The number itself. We do not enforce any format (yet).
	Value string `json:"value"`
}

SupplierAddressPhoneNumber SupplierAddressPhoneNumber

type SupplierAddressPhoneNumberType

type SupplierAddressPhoneNumberType string

SupplierAddressPhoneNumberType defines model for SupplierAddressPhoneNumber.Type.

const (
	SupplierAddressPhoneNumberTypeMOBILE SupplierAddressPhoneNumberType = "MOBILE"
	SupplierAddressPhoneNumberTypePHONE  SupplierAddressPhoneNumberType = "PHONE"
)

Defines values for SupplierAddressPhoneNumberType.

func (SupplierAddressPhoneNumberType) Valid

Valid indicates whether the value is a known member of the SupplierAddressPhoneNumberType enum.

type SupplierForCreation

type SupplierForCreation struct {
	// Address SupplierAddressForCreation
	Address *SupplierAddressForCreation `json:"address,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Name Example: Hamburg NW2
	Name           string                              `json:"name"`
	OperativeCosts *[]FacilityOperativeCostForCreation `json:"operativeCosts,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status *FacilityStatus `json:"status,omitempty"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type *FacilityType `json:"type,omitempty"`
}

SupplierForCreation SupplierForCreation

type SupplierForModification

type SupplierForModification struct {
	Address *SupplierAddressForCreation `json:"address,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Name Example: Hamburg NW2
	Name *string `json:"name,omitempty"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status *FacilityStatus `json:"status,omitempty"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type FacilityType `json:"type"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

SupplierForModification SupplierForModification

type SupplierForReplacement

type SupplierForReplacement struct {
	// Address SupplierAddressForCreation
	Address *SupplierAddressForCreation `json:"address,omitempty"`

	// CustomAttributes Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Name Example: Hamburg NW2
	Name string `json:"name"`

	// Status The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
	Status FacilityStatus  `json:"status"`
	Tags   *[]TagReference `json:"tags,omitempty"`

	// TenantFacilityId The id of the facility in the tenants own system
	//
	// Example: K12345
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`

	// Type FacilityType
	Type FacilityType `json:"type"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

SupplierForReplacement SupplierForReplacement

type SupplyingFacilityConfiguration added in v0.2.0

type SupplyingFacilityConfiguration struct {
	DeliveryEvents []DeliveryEvent `json:"deliveryEvents"`

	// FacilityRef ID of the facility.
	FacilityRef *string `json:"facilityRef,omitempty"`

	// TenantFacilityId Reference to the facility.
	TenantFacilityId *string `json:"tenantFacilityId,omitempty"`
	// contains filtered or unexported fields
}

SupplyingFacilityConfiguration SupplyingFacilityConfiguration

func (SupplyingFacilityConfiguration) AsSupplyingFacilityConfiguration0 added in v0.2.0

func (t SupplyingFacilityConfiguration) AsSupplyingFacilityConfiguration0() (SupplyingFacilityConfiguration0, error)

AsSupplyingFacilityConfiguration0 returns the union data inside the SupplyingFacilityConfiguration as a SupplyingFacilityConfiguration0

func (SupplyingFacilityConfiguration) AsSupplyingFacilityConfiguration1 added in v0.2.0

func (t SupplyingFacilityConfiguration) AsSupplyingFacilityConfiguration1() (SupplyingFacilityConfiguration1, error)

AsSupplyingFacilityConfiguration1 returns the union data inside the SupplyingFacilityConfiguration as a SupplyingFacilityConfiguration1

func (*SupplyingFacilityConfiguration) FromSupplyingFacilityConfiguration0 added in v0.2.0

func (t *SupplyingFacilityConfiguration) FromSupplyingFacilityConfiguration0(v SupplyingFacilityConfiguration0) error

FromSupplyingFacilityConfiguration0 overwrites any union data inside the SupplyingFacilityConfiguration as the provided SupplyingFacilityConfiguration0

func (*SupplyingFacilityConfiguration) FromSupplyingFacilityConfiguration1 added in v0.2.0

func (t *SupplyingFacilityConfiguration) FromSupplyingFacilityConfiguration1(v SupplyingFacilityConfiguration1) error

FromSupplyingFacilityConfiguration1 overwrites any union data inside the SupplyingFacilityConfiguration as the provided SupplyingFacilityConfiguration1

func (SupplyingFacilityConfiguration) MarshalJSON added in v0.2.0

func (t SupplyingFacilityConfiguration) MarshalJSON() ([]byte, error)

func (*SupplyingFacilityConfiguration) MergeSupplyingFacilityConfiguration0 added in v0.2.0

func (t *SupplyingFacilityConfiguration) MergeSupplyingFacilityConfiguration0(v SupplyingFacilityConfiguration0) error

MergeSupplyingFacilityConfiguration0 performs a merge with any union data inside the SupplyingFacilityConfiguration, using the provided SupplyingFacilityConfiguration0

func (*SupplyingFacilityConfiguration) MergeSupplyingFacilityConfiguration1 added in v0.2.0

func (t *SupplyingFacilityConfiguration) MergeSupplyingFacilityConfiguration1(v SupplyingFacilityConfiguration1) error

MergeSupplyingFacilityConfiguration1 performs a merge with any union data inside the SupplyingFacilityConfiguration, using the provided SupplyingFacilityConfiguration1

func (*SupplyingFacilityConfiguration) UnmarshalJSON added in v0.2.0

func (t *SupplyingFacilityConfiguration) UnmarshalJSON(b []byte) error

type SupplyingFacilityConfiguration0 added in v0.2.0

type SupplyingFacilityConfiguration0 = interface{}

SupplyingFacilityConfiguration0 defines model for SupplyingFacilityConfiguration.0.

type SupplyingFacilityConfiguration1 added in v0.2.0

type SupplyingFacilityConfiguration1 = interface{}

SupplyingFacilityConfiguration1 defines model for SupplyingFacilityConfiguration.1.

type SupportedLocale

type SupportedLocale string

SupportedLocale This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)

Example: de_DE

const (
	BgBG SupportedLocale = "bg_BG"
	CsCZ SupportedLocale = "cs_CZ"
	DeDE SupportedLocale = "de_DE"
	EnUS SupportedLocale = "en_US"
	EsES SupportedLocale = "es_ES"
	FrFR SupportedLocale = "fr_FR"
	HrHR SupportedLocale = "hr_HR"
	HuHU SupportedLocale = "hu_HU"
	ItIT SupportedLocale = "it_IT"
	NbNO SupportedLocale = "nb_NO"
	NlNL SupportedLocale = "nl_NL"
	PlPL SupportedLocale = "pl_PL"
	PtPT SupportedLocale = "pt_PT"
	RoRO SupportedLocale = "ro_RO"
	RuRU SupportedLocale = "ru_RU"
	SkSK SupportedLocale = "sk_SK"
	SlSI SupportedLocale = "sl_SI"
	TrTR SupportedLocale = "tr_TR"
)

Defines values for SupportedLocale.

func (SupportedLocale) Valid

func (e SupportedLocale) Valid() bool

Valid indicates whether the value is a known member of the SupportedLocale enum.

type TagReference

type TagReference struct {
	Id    string `json:"id"`
	Value string `json:"value"`
}

TagReference TagReference

type TagSearchQuery

type TagSearchQuery struct {
	// AllowedValues Search by allowedValues
	AllowedValues *StringSearchFilter `json:"allowedValues,omitempty"`
	And           *[]TagSearchQuery   `json:"and,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringSearchFilter `json:"id,omitempty"`
	Or *[]TagSearchQuery   `json:"or,omitempty"`
}

TagSearchQuery TagSearchQuery

type TenantFacilityIdSelector

type TenantFacilityIdSelector struct {
	// TenantFacilityId Resolves a facility by its tenantFacilityId.
	//
	// Example: MY_FACILITY_ID
	TenantFacilityId string `json:"tenantFacilityId"`
}

TenantFacilityIdSelector TenantFacilityIdSelector

type TenantSourceId added in v0.3.0

type TenantSourceId struct {
	TenantSourceId string `json:"tenantSourceId"`
}

TenantSourceId TenantSourceId

type ThresholdSurchargeCostDetail added in v0.8.0

type ThresholdSurchargeCostDetail struct {
	// Amount Money
	Amount Money `json:"amount"`

	// AppliedToCostDetailIds The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.
	AppliedToCostDetailIds *[]string `json:"appliedToCostDetailIds,omitempty"`

	// CalculationBaseAmount Money
	CalculationBaseAmount Money `json:"calculationBaseAmount"`

	// Id Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds
	//
	// Example: 0
	Id string `json:"id"`

	// MinimumAmount Money
	MinimumAmount Money `json:"minimumAmount"`

	// Percentage The configured percentage
	//
	// Example: 3
	Percentage float32 `json:"percentage"`

	// TenantSurchargeType The tenant surcharge id
	//
	// Example: cashOnDelivery
	TenantSurchargeType string                           `json:"tenantSurchargeType"`
	Type                ThresholdSurchargeCostDetailType `json:"type"`
}

ThresholdSurchargeCostDetail A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.

type ThresholdSurchargeCostDetailType added in v0.8.0

type ThresholdSurchargeCostDetailType string

ThresholdSurchargeCostDetailType defines model for ThresholdSurchargeCostDetail.Type.

const (
	THRESHOLDSURCHARGE ThresholdSurchargeCostDetailType = "THRESHOLD_SURCHARGE"
)

Defines values for ThresholdSurchargeCostDetailType.

func (ThresholdSurchargeCostDetailType) Valid added in v0.8.0

Valid indicates whether the value is a known member of the ThresholdSurchargeCostDetailType enum.

type TimeRange

type TimeRange struct {
	Capacity *float32 `json:"capacity,omitempty"`

	// End TimeStamp
	End TimeStamp `json:"end"`

	// Start TimeStamp
	Start TimeStamp `json:"start"`
}

TimeRange TimeRange

type TimeStamp

type TimeStamp struct {
	Hour   float32 `json:"hour"`
	Minute float32 `json:"minute"`
}

TimeStamp TimeStamp

type TimeTriggeredConfigContextType added in v0.6.0

type TimeTriggeredConfigContextType string

TimeTriggeredConfigContextType TimeTriggeredConfigContextType

const (
	TimeTriggeredConfigContextTypeFACILITY      TimeTriggeredConfigContextType = "FACILITY"
	TimeTriggeredConfigContextTypeFACILITYGROUP TimeTriggeredConfigContextType = "FACILITY_GROUP"
)

Defines values for TimeTriggeredConfigContextType.

func (TimeTriggeredConfigContextType) Valid added in v0.6.0

Valid indicates whether the value is a known member of the TimeTriggeredConfigContextType enum.

type TimeTriggeredConfigurationContext added in v0.6.0

type TimeTriggeredConfigurationContext struct {
	Priority float32 `json:"priority"`

	// TimeTriggered RoutingStrategyRerouteTimeTriggeredConfig
	TimeTriggered RoutingStrategyRerouteTimeTriggeredConfig `json:"timeTriggered"`

	// Type TimeTriggeredConfigContextType
	Type TimeTriggeredConfigContextType `json:"type"`

	// Values The id of the context values. For example, if the type is FACILITY, then the values are the ids of the facilities.
	Values []openapi_types.UUID `json:"values"`
}

TimeTriggeredConfigurationContext TimeTriggeredConfigurationContext

type TimeZone

type TimeZone struct {
	// OffsetInSeconds offset in seconds to standard time. Does not account for daylight saving time.
	//
	// Example: 28800
	OffsetInSeconds float32 `json:"offsetInSeconds"`

	// Source source of the timezone information
	//
	// Example: Google Maps API
	Source *string `json:"source,omitempty"`

	// TimeZoneId official id of the timezone
	//
	// Example: America/Los_Angeles
	TimeZoneId string `json:"timeZoneId"`

	// TimeZoneName descriptive name of the timezone
	//
	// Example: Pacific Standard Time
	TimeZoneName string `json:"timeZoneName"`
}

TimeZone Timezone for information retrieved e.g. by the Google Maps API

type TimeZoneForCreation

type TimeZoneForCreation struct {
	// TimeZoneId official id of the timezone
	//
	// Example: America/Los_Angeles
	TimeZoneId string `json:"timeZoneId"`
}

TimeZoneForCreation Self-provided timezone for determining the local time of a facility

type ToolkitAllowedEntities

type ToolkitAllowedEntities string

ToolkitAllowedEntities The entities that can be compared by the toolkit fence or rating

  • `ORDER`
  • `FACILITY`
  • `CARRIERCONNECTION`
  • `LISTING`
  • `ORDERING_FACILITY` - left side only
  • `ORDERING_FACILITY_GROUPS` - left side only
const (
	ToolkitAllowedEntitiesCARRIERCONNECTION      ToolkitAllowedEntities = "CARRIERCONNECTION"
	ToolkitAllowedEntitiesFACILITY               ToolkitAllowedEntities = "FACILITY"
	ToolkitAllowedEntitiesLISTING                ToolkitAllowedEntities = "LISTING"
	ToolkitAllowedEntitiesORDER                  ToolkitAllowedEntities = "ORDER"
	ToolkitAllowedEntitiesORDERINGFACILITY       ToolkitAllowedEntities = "ORDERING_FACILITY"
	ToolkitAllowedEntitiesORDERINGFACILITYGROUPS ToolkitAllowedEntities = "ORDERING_FACILITY_GROUPS"
)

Defines values for ToolkitAllowedEntities.

func (ToolkitAllowedEntities) Valid

func (e ToolkitAllowedEntities) Valid() bool

Valid indicates whether the value is a known member of the ToolkitAllowedEntities enum.

type ToolkitComparisonPredicate

type ToolkitComparisonPredicate struct {
	// EntityOperator The type of the rule operator applied to the results of evaluating the left predicates and the right predicates
	EntityOperator ToolkitRuleComparisonOperatorType `json:"entityOperator"`

	// LeftEntity The entities that can be compared by the toolkit fence or rating
	//   * `ORDER`
	//   * `FACILITY`
	//   * `CARRIERCONNECTION`
	//   * `LISTING`
	//   * `ORDERING_FACILITY` - left side only
	//   * `ORDERING_FACILITY_GROUPS` - left side only
	LeftEntity       ToolkitAllowedEntities `json:"leftEntity"`
	LeftPropertyPath string                 `json:"leftPropertyPath"`

	// LeftTransformation The transformations available to apply on the entity property value before a predicate is evaluated
	LeftTransformation     *ToolkitTransformationType                                `json:"leftTransformation,omitempty"`
	LeftTransformationArgs *[]ToolkitComparisonPredicate_LeftTransformationArgs_Item `json:"leftTransformationArgs,omitempty"`

	// RightEntity The entities that can be compared by the toolkit fence or rating
	//   * `ORDER`
	//   * `FACILITY`
	//   * `CARRIERCONNECTION`
	//   * `LISTING`
	//   * `ORDERING_FACILITY` - left side only
	//   * `ORDERING_FACILITY_GROUPS` - left side only
	RightEntity       ToolkitAllowedEntities `json:"rightEntity"`
	RightPropertyPath string                 `json:"rightPropertyPath"`

	// RightTransformation The transformations available to apply on the entity property value before a predicate is evaluated
	RightTransformation     *ToolkitTransformationType                                 `json:"rightTransformation,omitempty"`
	RightTransformationArgs *[]ToolkitComparisonPredicate_RightTransformationArgs_Item `json:"rightTransformationArgs,omitempty"`
}

ToolkitComparisonPredicate The predicate for a Toolkit V2 Fence that defines how conditions are constructed

type ToolkitComparisonPredicateLeftTransformationArgs0

type ToolkitComparisonPredicateLeftTransformationArgs0 = string

ToolkitComparisonPredicateLeftTransformationArgs0 defines model for ToolkitComparisonPredicate.LeftTransformationArgs.0.

type ToolkitComparisonPredicateLeftTransformationArgs1

type ToolkitComparisonPredicateLeftTransformationArgs1 = float32

ToolkitComparisonPredicateLeftTransformationArgs1 defines model for ToolkitComparisonPredicate.LeftTransformationArgs.1.

type ToolkitComparisonPredicateLeftTransformationArgs2

type ToolkitComparisonPredicateLeftTransformationArgs2 = bool

ToolkitComparisonPredicateLeftTransformationArgs2 defines model for ToolkitComparisonPredicate.LeftTransformationArgs.2.

type ToolkitComparisonPredicateRightTransformationArgs0

type ToolkitComparisonPredicateRightTransformationArgs0 = string

ToolkitComparisonPredicateRightTransformationArgs0 defines model for ToolkitComparisonPredicate.RightTransformationArgs.0.

type ToolkitComparisonPredicateRightTransformationArgs1

type ToolkitComparisonPredicateRightTransformationArgs1 = float32

ToolkitComparisonPredicateRightTransformationArgs1 defines model for ToolkitComparisonPredicate.RightTransformationArgs.1.

type ToolkitComparisonPredicateRightTransformationArgs2

type ToolkitComparisonPredicateRightTransformationArgs2 = bool

ToolkitComparisonPredicateRightTransformationArgs2 defines model for ToolkitComparisonPredicate.RightTransformationArgs.2.

type ToolkitComparisonPredicate_LeftTransformationArgs_Item

type ToolkitComparisonPredicate_LeftTransformationArgs_Item struct {
	// contains filtered or unexported fields
}

ToolkitComparisonPredicate_LeftTransformationArgs_Item defines model for ToolkitComparisonPredicate.leftTransformationArgs.Item.

func (ToolkitComparisonPredicate_LeftTransformationArgs_Item) AsToolkitComparisonPredicateLeftTransformationArgs0

AsToolkitComparisonPredicateLeftTransformationArgs0 returns the union data inside the ToolkitComparisonPredicate_LeftTransformationArgs_Item as a ToolkitComparisonPredicateLeftTransformationArgs0

func (ToolkitComparisonPredicate_LeftTransformationArgs_Item) AsToolkitComparisonPredicateLeftTransformationArgs1

AsToolkitComparisonPredicateLeftTransformationArgs1 returns the union data inside the ToolkitComparisonPredicate_LeftTransformationArgs_Item as a ToolkitComparisonPredicateLeftTransformationArgs1

func (ToolkitComparisonPredicate_LeftTransformationArgs_Item) AsToolkitComparisonPredicateLeftTransformationArgs2

AsToolkitComparisonPredicateLeftTransformationArgs2 returns the union data inside the ToolkitComparisonPredicate_LeftTransformationArgs_Item as a ToolkitComparisonPredicateLeftTransformationArgs2

func (*ToolkitComparisonPredicate_LeftTransformationArgs_Item) FromToolkitComparisonPredicateLeftTransformationArgs0

FromToolkitComparisonPredicateLeftTransformationArgs0 overwrites any union data inside the ToolkitComparisonPredicate_LeftTransformationArgs_Item as the provided ToolkitComparisonPredicateLeftTransformationArgs0

func (*ToolkitComparisonPredicate_LeftTransformationArgs_Item) FromToolkitComparisonPredicateLeftTransformationArgs1

FromToolkitComparisonPredicateLeftTransformationArgs1 overwrites any union data inside the ToolkitComparisonPredicate_LeftTransformationArgs_Item as the provided ToolkitComparisonPredicateLeftTransformationArgs1

func (*ToolkitComparisonPredicate_LeftTransformationArgs_Item) FromToolkitComparisonPredicateLeftTransformationArgs2

FromToolkitComparisonPredicateLeftTransformationArgs2 overwrites any union data inside the ToolkitComparisonPredicate_LeftTransformationArgs_Item as the provided ToolkitComparisonPredicateLeftTransformationArgs2

func (ToolkitComparisonPredicate_LeftTransformationArgs_Item) MarshalJSON

func (*ToolkitComparisonPredicate_LeftTransformationArgs_Item) MergeToolkitComparisonPredicateLeftTransformationArgs0

func (t *ToolkitComparisonPredicate_LeftTransformationArgs_Item) MergeToolkitComparisonPredicateLeftTransformationArgs0(v ToolkitComparisonPredicateLeftTransformationArgs0) error

MergeToolkitComparisonPredicateLeftTransformationArgs0 performs a merge with any union data inside the ToolkitComparisonPredicate_LeftTransformationArgs_Item, using the provided ToolkitComparisonPredicateLeftTransformationArgs0

func (*ToolkitComparisonPredicate_LeftTransformationArgs_Item) MergeToolkitComparisonPredicateLeftTransformationArgs1

func (t *ToolkitComparisonPredicate_LeftTransformationArgs_Item) MergeToolkitComparisonPredicateLeftTransformationArgs1(v ToolkitComparisonPredicateLeftTransformationArgs1) error

MergeToolkitComparisonPredicateLeftTransformationArgs1 performs a merge with any union data inside the ToolkitComparisonPredicate_LeftTransformationArgs_Item, using the provided ToolkitComparisonPredicateLeftTransformationArgs1

func (*ToolkitComparisonPredicate_LeftTransformationArgs_Item) MergeToolkitComparisonPredicateLeftTransformationArgs2

func (t *ToolkitComparisonPredicate_LeftTransformationArgs_Item) MergeToolkitComparisonPredicateLeftTransformationArgs2(v ToolkitComparisonPredicateLeftTransformationArgs2) error

MergeToolkitComparisonPredicateLeftTransformationArgs2 performs a merge with any union data inside the ToolkitComparisonPredicate_LeftTransformationArgs_Item, using the provided ToolkitComparisonPredicateLeftTransformationArgs2

func (*ToolkitComparisonPredicate_LeftTransformationArgs_Item) UnmarshalJSON

type ToolkitComparisonPredicate_RightTransformationArgs_Item

type ToolkitComparisonPredicate_RightTransformationArgs_Item struct {
	// contains filtered or unexported fields
}

ToolkitComparisonPredicate_RightTransformationArgs_Item defines model for ToolkitComparisonPredicate.rightTransformationArgs.Item.

func (ToolkitComparisonPredicate_RightTransformationArgs_Item) AsToolkitComparisonPredicateRightTransformationArgs0

AsToolkitComparisonPredicateRightTransformationArgs0 returns the union data inside the ToolkitComparisonPredicate_RightTransformationArgs_Item as a ToolkitComparisonPredicateRightTransformationArgs0

func (ToolkitComparisonPredicate_RightTransformationArgs_Item) AsToolkitComparisonPredicateRightTransformationArgs1

AsToolkitComparisonPredicateRightTransformationArgs1 returns the union data inside the ToolkitComparisonPredicate_RightTransformationArgs_Item as a ToolkitComparisonPredicateRightTransformationArgs1

func (ToolkitComparisonPredicate_RightTransformationArgs_Item) AsToolkitComparisonPredicateRightTransformationArgs2

AsToolkitComparisonPredicateRightTransformationArgs2 returns the union data inside the ToolkitComparisonPredicate_RightTransformationArgs_Item as a ToolkitComparisonPredicateRightTransformationArgs2

func (*ToolkitComparisonPredicate_RightTransformationArgs_Item) FromToolkitComparisonPredicateRightTransformationArgs0

FromToolkitComparisonPredicateRightTransformationArgs0 overwrites any union data inside the ToolkitComparisonPredicate_RightTransformationArgs_Item as the provided ToolkitComparisonPredicateRightTransformationArgs0

func (*ToolkitComparisonPredicate_RightTransformationArgs_Item) FromToolkitComparisonPredicateRightTransformationArgs1

FromToolkitComparisonPredicateRightTransformationArgs1 overwrites any union data inside the ToolkitComparisonPredicate_RightTransformationArgs_Item as the provided ToolkitComparisonPredicateRightTransformationArgs1

func (*ToolkitComparisonPredicate_RightTransformationArgs_Item) FromToolkitComparisonPredicateRightTransformationArgs2

FromToolkitComparisonPredicateRightTransformationArgs2 overwrites any union data inside the ToolkitComparisonPredicate_RightTransformationArgs_Item as the provided ToolkitComparisonPredicateRightTransformationArgs2

func (ToolkitComparisonPredicate_RightTransformationArgs_Item) MarshalJSON

func (*ToolkitComparisonPredicate_RightTransformationArgs_Item) MergeToolkitComparisonPredicateRightTransformationArgs0

MergeToolkitComparisonPredicateRightTransformationArgs0 performs a merge with any union data inside the ToolkitComparisonPredicate_RightTransformationArgs_Item, using the provided ToolkitComparisonPredicateRightTransformationArgs0

func (*ToolkitComparisonPredicate_RightTransformationArgs_Item) MergeToolkitComparisonPredicateRightTransformationArgs1

MergeToolkitComparisonPredicateRightTransformationArgs1 performs a merge with any union data inside the ToolkitComparisonPredicate_RightTransformationArgs_Item, using the provided ToolkitComparisonPredicateRightTransformationArgs1

func (*ToolkitComparisonPredicate_RightTransformationArgs_Item) MergeToolkitComparisonPredicateRightTransformationArgs2

MergeToolkitComparisonPredicateRightTransformationArgs2 performs a merge with any union data inside the ToolkitComparisonPredicate_RightTransformationArgs_Item, using the provided ToolkitComparisonPredicateRightTransformationArgs2

func (*ToolkitComparisonPredicate_RightTransformationArgs_Item) UnmarshalJSON

type ToolkitComparisonRule

type ToolkitComparisonRule struct {
	// EvaluationScope ToolkitRuleScope
	EvaluationScope ToolkitRuleScope `json:"evaluationScope"`

	// PredicateConnector The allowed operators for connecting multiple predicates
	PredicateConnector *ToolkitPredicateConnector   `json:"predicateConnector,omitempty"`
	Predicates         []ToolkitComparisonPredicate `json:"predicates"`
}

ToolkitComparisonRule The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator

type ToolkitEntityOperatorType

type ToolkitEntityOperatorType string

ToolkitEntityOperatorType The possible operator types that can be used on given entities

const (
	ANYVALUECONTAINS        ToolkitEntityOperatorType = "ANY_VALUE_CONTAINS"
	ANYVALUEEQUALS          ToolkitEntityOperatorType = "ANY_VALUE_EQUALS"
	ANYVALUEGREATEREQUALS   ToolkitEntityOperatorType = "ANY_VALUE_GREATER_EQUALS"
	ANYVALUEGREATERTHAN     ToolkitEntityOperatorType = "ANY_VALUE_GREATER_THAN"
	ANYVALUELESSEQUALS      ToolkitEntityOperatorType = "ANY_VALUE_LESS_EQUALS"
	ANYVALUELESSTHAN        ToolkitEntityOperatorType = "ANY_VALUE_LESS_THAN"
	ANYVALUENOTCONTAINS     ToolkitEntityOperatorType = "ANY_VALUE_NOT_CONTAINS"
	EVERYVALUECONTAINS      ToolkitEntityOperatorType = "EVERY_VALUE_CONTAINS"
	EVERYVALUEEQUALS        ToolkitEntityOperatorType = "EVERY_VALUE_EQUALS"
	EVERYVALUEGREATEREQUALS ToolkitEntityOperatorType = "EVERY_VALUE_GREATER_EQUALS"
	EVERYVALUEGREATERTHAN   ToolkitEntityOperatorType = "EVERY_VALUE_GREATER_THAN"
	EVERYVALUELESSEQUALS    ToolkitEntityOperatorType = "EVERY_VALUE_LESS_EQUALS"
	EVERYVALUELESSTHAN      ToolkitEntityOperatorType = "EVERY_VALUE_LESS_THAN"
	EVERYVALUENOTCONTAINS   ToolkitEntityOperatorType = "EVERY_VALUE_NOT_CONTAINS"
	GREATEREQUALS           ToolkitEntityOperatorType = "GREATER_EQUALS"
	GREATERTHAN             ToolkitEntityOperatorType = "GREATER_THAN"
	LESSEQUALS              ToolkitEntityOperatorType = "LESS_EQUALS"
	LESSTHAN                ToolkitEntityOperatorType = "LESS_THAN"
	NOVALUECONTAINS         ToolkitEntityOperatorType = "NO_VALUE_CONTAINS"
	NOVALUEEQUALS           ToolkitEntityOperatorType = "NO_VALUE_EQUALS"
	NOVALUEGREATEREQUALS    ToolkitEntityOperatorType = "NO_VALUE_GREATER_EQUALS"
	NOVALUEGREATERTHAN      ToolkitEntityOperatorType = "NO_VALUE_GREATER_THAN"
	NOVALUELESSEQUALS       ToolkitEntityOperatorType = "NO_VALUE_LESS_EQUALS"
	NOVALUELESSTHAN         ToolkitEntityOperatorType = "NO_VALUE_LESS_THAN"
	NOVALUENOTCONTAINS      ToolkitEntityOperatorType = "NO_VALUE_NOT_CONTAINS"
	VALUECONTAINS           ToolkitEntityOperatorType = "VALUE_CONTAINS"
	VALUEEQUALS             ToolkitEntityOperatorType = "VALUE_EQUALS"
	VALUENOTCONTAINS        ToolkitEntityOperatorType = "VALUE_NOT_CONTAINS"
	VALUENOTEQUALS          ToolkitEntityOperatorType = "VALUE_NOT_EQUALS"
)

Defines values for ToolkitEntityOperatorType.

func (ToolkitEntityOperatorType) Valid

func (e ToolkitEntityOperatorType) Valid() bool

Valid indicates whether the value is a known member of the ToolkitEntityOperatorType enum.

type ToolkitPredicate

type ToolkitPredicate struct {
	// Entity The entities that can be compared by the toolkit fence or rating
	//   * `ORDER`
	//   * `FACILITY`
	//   * `CARRIERCONNECTION`
	//   * `LISTING`
	//   * `ORDERING_FACILITY` - left side only
	//   * `ORDERING_FACILITY_GROUPS` - left side only
	Entity ToolkitAllowedEntities `json:"entity"`

	// EntityOperator The possible operator types that can be used on given entities
	EntityOperator ToolkitEntityOperatorType       `json:"entityOperator"`
	ExpectedValue  *ToolkitPredicate_ExpectedValue `json:"expectedValue,omitempty"`
	PropertyPath   string                          `json:"propertyPath"`

	// Transformation The transformations available to apply on the entity property value before a predicate is evaluated
	Transformation     *ToolkitTransformationType                  `json:"transformation,omitempty"`
	TransformationArgs *[]ToolkitPredicate_TransformationArgs_Item `json:"transformationArgs,omitempty"`
}

ToolkitPredicate The predicate for a Toolkit V2 Fence that defines how conditions are constructed

type ToolkitPredicateConnector

type ToolkitPredicateConnector string

ToolkitPredicateConnector The allowed operators for connecting multiple predicates

const (
	AND ToolkitPredicateConnector = "AND"
	OR  ToolkitPredicateConnector = "OR"
)

Defines values for ToolkitPredicateConnector.

func (ToolkitPredicateConnector) Valid

func (e ToolkitPredicateConnector) Valid() bool

Valid indicates whether the value is a known member of the ToolkitPredicateConnector enum.

type ToolkitPredicateExpectedValue0

type ToolkitPredicateExpectedValue0 = string

ToolkitPredicateExpectedValue0 defines model for ToolkitPredicate.ExpectedValue.0.

type ToolkitPredicateExpectedValue1

type ToolkitPredicateExpectedValue1 = float32

ToolkitPredicateExpectedValue1 defines model for ToolkitPredicate.ExpectedValue.1.

type ToolkitPredicateExpectedValue2

type ToolkitPredicateExpectedValue2 = bool

ToolkitPredicateExpectedValue2 defines model for ToolkitPredicate.ExpectedValue.2.

type ToolkitPredicateTransformationArgs0

type ToolkitPredicateTransformationArgs0 = string

ToolkitPredicateTransformationArgs0 defines model for ToolkitPredicate.TransformationArgs.0.

type ToolkitPredicateTransformationArgs1

type ToolkitPredicateTransformationArgs1 = float32

ToolkitPredicateTransformationArgs1 defines model for ToolkitPredicate.TransformationArgs.1.

type ToolkitPredicateTransformationArgs2

type ToolkitPredicateTransformationArgs2 = bool

ToolkitPredicateTransformationArgs2 defines model for ToolkitPredicate.TransformationArgs.2.

type ToolkitPredicate_ExpectedValue

type ToolkitPredicate_ExpectedValue struct {
	// contains filtered or unexported fields
}

ToolkitPredicate_ExpectedValue defines model for ToolkitPredicate.ExpectedValue.

func (ToolkitPredicate_ExpectedValue) AsToolkitPredicateExpectedValue0

func (t ToolkitPredicate_ExpectedValue) AsToolkitPredicateExpectedValue0() (ToolkitPredicateExpectedValue0, error)

AsToolkitPredicateExpectedValue0 returns the union data inside the ToolkitPredicate_ExpectedValue as a ToolkitPredicateExpectedValue0

func (ToolkitPredicate_ExpectedValue) AsToolkitPredicateExpectedValue1

func (t ToolkitPredicate_ExpectedValue) AsToolkitPredicateExpectedValue1() (ToolkitPredicateExpectedValue1, error)

AsToolkitPredicateExpectedValue1 returns the union data inside the ToolkitPredicate_ExpectedValue as a ToolkitPredicateExpectedValue1

func (ToolkitPredicate_ExpectedValue) AsToolkitPredicateExpectedValue2

func (t ToolkitPredicate_ExpectedValue) AsToolkitPredicateExpectedValue2() (ToolkitPredicateExpectedValue2, error)

AsToolkitPredicateExpectedValue2 returns the union data inside the ToolkitPredicate_ExpectedValue as a ToolkitPredicateExpectedValue2

func (*ToolkitPredicate_ExpectedValue) FromToolkitPredicateExpectedValue0

func (t *ToolkitPredicate_ExpectedValue) FromToolkitPredicateExpectedValue0(v ToolkitPredicateExpectedValue0) error

FromToolkitPredicateExpectedValue0 overwrites any union data inside the ToolkitPredicate_ExpectedValue as the provided ToolkitPredicateExpectedValue0

func (*ToolkitPredicate_ExpectedValue) FromToolkitPredicateExpectedValue1

func (t *ToolkitPredicate_ExpectedValue) FromToolkitPredicateExpectedValue1(v ToolkitPredicateExpectedValue1) error

FromToolkitPredicateExpectedValue1 overwrites any union data inside the ToolkitPredicate_ExpectedValue as the provided ToolkitPredicateExpectedValue1

func (*ToolkitPredicate_ExpectedValue) FromToolkitPredicateExpectedValue2

func (t *ToolkitPredicate_ExpectedValue) FromToolkitPredicateExpectedValue2(v ToolkitPredicateExpectedValue2) error

FromToolkitPredicateExpectedValue2 overwrites any union data inside the ToolkitPredicate_ExpectedValue as the provided ToolkitPredicateExpectedValue2

func (ToolkitPredicate_ExpectedValue) MarshalJSON

func (t ToolkitPredicate_ExpectedValue) MarshalJSON() ([]byte, error)

func (*ToolkitPredicate_ExpectedValue) MergeToolkitPredicateExpectedValue0

func (t *ToolkitPredicate_ExpectedValue) MergeToolkitPredicateExpectedValue0(v ToolkitPredicateExpectedValue0) error

MergeToolkitPredicateExpectedValue0 performs a merge with any union data inside the ToolkitPredicate_ExpectedValue, using the provided ToolkitPredicateExpectedValue0

func (*ToolkitPredicate_ExpectedValue) MergeToolkitPredicateExpectedValue1

func (t *ToolkitPredicate_ExpectedValue) MergeToolkitPredicateExpectedValue1(v ToolkitPredicateExpectedValue1) error

MergeToolkitPredicateExpectedValue1 performs a merge with any union data inside the ToolkitPredicate_ExpectedValue, using the provided ToolkitPredicateExpectedValue1

func (*ToolkitPredicate_ExpectedValue) MergeToolkitPredicateExpectedValue2

func (t *ToolkitPredicate_ExpectedValue) MergeToolkitPredicateExpectedValue2(v ToolkitPredicateExpectedValue2) error

MergeToolkitPredicateExpectedValue2 performs a merge with any union data inside the ToolkitPredicate_ExpectedValue, using the provided ToolkitPredicateExpectedValue2

func (*ToolkitPredicate_ExpectedValue) UnmarshalJSON

func (t *ToolkitPredicate_ExpectedValue) UnmarshalJSON(b []byte) error

type ToolkitPredicate_TransformationArgs_Item

type ToolkitPredicate_TransformationArgs_Item struct {
	// contains filtered or unexported fields
}

ToolkitPredicate_TransformationArgs_Item defines model for ToolkitPredicate.transformationArgs.Item.

func (ToolkitPredicate_TransformationArgs_Item) AsToolkitPredicateTransformationArgs0

func (t ToolkitPredicate_TransformationArgs_Item) AsToolkitPredicateTransformationArgs0() (ToolkitPredicateTransformationArgs0, error)

AsToolkitPredicateTransformationArgs0 returns the union data inside the ToolkitPredicate_TransformationArgs_Item as a ToolkitPredicateTransformationArgs0

func (ToolkitPredicate_TransformationArgs_Item) AsToolkitPredicateTransformationArgs1

func (t ToolkitPredicate_TransformationArgs_Item) AsToolkitPredicateTransformationArgs1() (ToolkitPredicateTransformationArgs1, error)

AsToolkitPredicateTransformationArgs1 returns the union data inside the ToolkitPredicate_TransformationArgs_Item as a ToolkitPredicateTransformationArgs1

func (ToolkitPredicate_TransformationArgs_Item) AsToolkitPredicateTransformationArgs2

func (t ToolkitPredicate_TransformationArgs_Item) AsToolkitPredicateTransformationArgs2() (ToolkitPredicateTransformationArgs2, error)

AsToolkitPredicateTransformationArgs2 returns the union data inside the ToolkitPredicate_TransformationArgs_Item as a ToolkitPredicateTransformationArgs2

func (*ToolkitPredicate_TransformationArgs_Item) FromToolkitPredicateTransformationArgs0

func (t *ToolkitPredicate_TransformationArgs_Item) FromToolkitPredicateTransformationArgs0(v ToolkitPredicateTransformationArgs0) error

FromToolkitPredicateTransformationArgs0 overwrites any union data inside the ToolkitPredicate_TransformationArgs_Item as the provided ToolkitPredicateTransformationArgs0

func (*ToolkitPredicate_TransformationArgs_Item) FromToolkitPredicateTransformationArgs1

func (t *ToolkitPredicate_TransformationArgs_Item) FromToolkitPredicateTransformationArgs1(v ToolkitPredicateTransformationArgs1) error

FromToolkitPredicateTransformationArgs1 overwrites any union data inside the ToolkitPredicate_TransformationArgs_Item as the provided ToolkitPredicateTransformationArgs1

func (*ToolkitPredicate_TransformationArgs_Item) FromToolkitPredicateTransformationArgs2

func (t *ToolkitPredicate_TransformationArgs_Item) FromToolkitPredicateTransformationArgs2(v ToolkitPredicateTransformationArgs2) error

FromToolkitPredicateTransformationArgs2 overwrites any union data inside the ToolkitPredicate_TransformationArgs_Item as the provided ToolkitPredicateTransformationArgs2

func (ToolkitPredicate_TransformationArgs_Item) MarshalJSON

func (*ToolkitPredicate_TransformationArgs_Item) MergeToolkitPredicateTransformationArgs0

func (t *ToolkitPredicate_TransformationArgs_Item) MergeToolkitPredicateTransformationArgs0(v ToolkitPredicateTransformationArgs0) error

MergeToolkitPredicateTransformationArgs0 performs a merge with any union data inside the ToolkitPredicate_TransformationArgs_Item, using the provided ToolkitPredicateTransformationArgs0

func (*ToolkitPredicate_TransformationArgs_Item) MergeToolkitPredicateTransformationArgs1

func (t *ToolkitPredicate_TransformationArgs_Item) MergeToolkitPredicateTransformationArgs1(v ToolkitPredicateTransformationArgs1) error

MergeToolkitPredicateTransformationArgs1 performs a merge with any union data inside the ToolkitPredicate_TransformationArgs_Item, using the provided ToolkitPredicateTransformationArgs1

func (*ToolkitPredicate_TransformationArgs_Item) MergeToolkitPredicateTransformationArgs2

func (t *ToolkitPredicate_TransformationArgs_Item) MergeToolkitPredicateTransformationArgs2(v ToolkitPredicateTransformationArgs2) error

MergeToolkitPredicateTransformationArgs2 performs a merge with any union data inside the ToolkitPredicate_TransformationArgs_Item, using the provided ToolkitPredicateTransformationArgs2

func (*ToolkitPredicate_TransformationArgs_Item) UnmarshalJSON

func (t *ToolkitPredicate_TransformationArgs_Item) UnmarshalJSON(b []byte) error

type ToolkitRule

type ToolkitRule struct {
	// EvaluationScope ToolkitRuleScope
	EvaluationScope ToolkitRuleScope `json:"evaluationScope"`

	// LeftPart One half of the rule, containing either the left or right predicates and booleanOperator.
	LeftPart ToolkitRulePart `json:"leftPart"`

	// Operator The type of the rule operator applied to the results of evaluating the left predicates and the right predicates
	Operator ToolkitRuleOperatorType `json:"operator"`

	// RightPart One half of the rule, containing either the left or right predicates and booleanOperator.
	RightPart ToolkitRulePart `json:"rightPart"`
}

ToolkitRule The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator

type ToolkitRuleComparisonOperatorType

type ToolkitRuleComparisonOperatorType string

ToolkitRuleComparisonOperatorType The type of the rule operator applied to the results of evaluating the left predicates and the right predicates

const (
	ALLMATCHES        ToolkitRuleComparisonOperatorType = "ALL_MATCHES"
	LEFTCONTAINSRIGHT ToolkitRuleComparisonOperatorType = "LEFT_CONTAINS_RIGHT"
	NOMATCHES         ToolkitRuleComparisonOperatorType = "NO_MATCHES"
	RIGHTCONTAINSLEFT ToolkitRuleComparisonOperatorType = "RIGHT_CONTAINS_LEFT"
)

Defines values for ToolkitRuleComparisonOperatorType.

func (ToolkitRuleComparisonOperatorType) Valid

Valid indicates whether the value is a known member of the ToolkitRuleComparisonOperatorType enum.

type ToolkitRuleOperatorType

type ToolkitRuleOperatorType string

ToolkitRuleOperatorType The type of the rule operator applied to the results of evaluating the left predicates and the right predicates

const (
	EQUALS ToolkitRuleOperatorType = "EQUALS"
)

Defines values for ToolkitRuleOperatorType.

func (ToolkitRuleOperatorType) Valid

func (e ToolkitRuleOperatorType) Valid() bool

Valid indicates whether the value is a known member of the ToolkitRuleOperatorType enum.

type ToolkitRulePart

type ToolkitRulePart struct {
	// PredicateConnector The allowed operators for connecting multiple predicates
	PredicateConnector *ToolkitPredicateConnector `json:"predicateConnector,omitempty"`
	Predicates         []ToolkitPredicate         `json:"predicates"`
}

ToolkitRulePart One half of the rule, containing either the left or right predicates and booleanOperator.

type ToolkitRuleScope

type ToolkitRuleScope string

ToolkitRuleScope ToolkitRuleScope

const (
	ToolkitRuleScopeLINEITEM    ToolkitRuleScope = "LINE_ITEM"
	ToolkitRuleScopeWHOLEENTITY ToolkitRuleScope = "WHOLE_ENTITY"
)

Defines values for ToolkitRuleScope.

func (ToolkitRuleScope) Valid

func (e ToolkitRuleScope) Valid() bool

Valid indicates whether the value is a known member of the ToolkitRuleScope enum.

type ToolkitTransformationType

type ToolkitTransformationType string

ToolkitTransformationType The transformations available to apply on the entity property value before a predicate is evaluated

const (
	COUNT     ToolkitTransformationType = "COUNT"
	LAST      ToolkitTransformationType = "LAST"
	SUBSTRING ToolkitTransformationType = "SUBSTRING"
	SUM       ToolkitTransformationType = "SUM"
)

Defines values for ToolkitTransformationType.

func (ToolkitTransformationType) Valid

func (e ToolkitTransformationType) Valid() bool

Valid indicates whether the value is a known member of the ToolkitTransformationType enum.

type TrackingInformationSearchQuery added in v0.5.0

type TrackingInformationSearchQuery struct {
	And *[]TrackingInformationSearchQuery `json:"and,omitempty"`

	// CarrierRef Search by carrierRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	CarrierRef *StringFilter `json:"carrierRef,omitempty"`

	// Created Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets.
	Created *DateFilter `json:"created,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// LabelRef Search by labelRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	LabelRef *StringFilter `json:"labelRef,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter                       `json:"lastModified,omitempty"`
	Or           *[]TrackingInformationSearchQuery `json:"or,omitempty"`

	// ShippingInformationRef Search by shippingInformationRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	ShippingInformationRef *StringFilter `json:"shippingInformationRef,omitempty"`

	// TrackingNumber Search by trackingNumber
	TrackingNumber *StringFilter `json:"trackingNumber,omitempty"`
}

TrackingInformationSearchQuery TrackingInformationSearchQuery

type TransferTimeLine added in v0.2.0

type TransferTimeLine struct {
	// CalculationStartPoint The date and time from which all time-related calculations for the corresponding items are based.
	//
	// Example: 2020-02-03T08:45:50.525Z
	CalculationStartPoint time.Time `json:"calculationStartPoint"`

	// EarliestPickingStart The earliest date and time when picking for the corresponding items can begin.
	//
	// Example: 2020-02-03T08:45:50.525Z
	EarliestPickingStart time.Time `json:"earliestPickingStart"`

	// EarliestPossibleDeliveryTime The earliest date at which the corresponding items can be delivered to the recipient.
	//
	// Example: 2020-02-03T00:00:00.000Z
	EarliestPossibleDeliveryTime *time.Time `json:"earliestPossibleDeliveryTime,omitempty"`

	// LatestPickingStart The latest date and time when picking for the corresponding items can begin.
	//
	// Example: 2020-02-03T08:45:50.525Z
	LatestPickingStart time.Time `json:"latestPickingStart"`

	// TargetTime The desired date and time by which the corresponding items should be fulfilled.
	//
	// Example: 2020-02-03T08:45:50.525Z
	TargetTime time.Time `json:"targetTime"`

	// UsedTransitTimeInDays The raw amount of transit days used for timeline calculation
	//
	// Example: 3
	UsedTransitTimeInDays *int `json:"usedTransitTimeInDays,omitempty"`
}

TransferTimeLine TransferTimeLine

type TransportDetails added in v0.8.0

type TransportDetails struct {
	VehicleWidthInMeters *float32 `json:"vehicleWidthInMeters,omitempty"`
}

TransportDetails TransportDetails

type TriggeredThresholdLevel added in v0.8.0

type TriggeredThresholdLevel struct {
	Actual float32 `json:"actual"`
	Key    string  `json:"key"`
	Limit  float32 `json:"limit"`
}

TriggeredThresholdLevel TriggeredThresholdLevel

type UpdateDiscountForFacilityJSONRequestBody

type UpdateDiscountForFacilityJSONRequestBody = FacilityDiscountForUpdate

UpdateDiscountForFacilityJSONRequestBody defines body for UpdateDiscountForFacility for application/json ContentType.

type UpdateDiscountForFacilityResponse

type UpdateDiscountForFacilityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FacilityDiscount
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ApiError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseUpdateDiscountForFacilityResponse

func ParseUpdateDiscountForFacilityResponse(rsp *http.Response) (*UpdateDiscountForFacilityResponse, error)

ParseUpdateDiscountForFacilityResponse parses an HTTP response from a UpdateDiscountForFacilityWithResponse call

func (UpdateDiscountForFacilityResponse) ContentType

func (r UpdateDiscountForFacilityResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateDiscountForFacilityResponse) GetBody added in v0.8.0

GetBody returns the raw response body bytes

func (UpdateDiscountForFacilityResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateDiscountForFacilityResponse) GetJSON400 added in v0.8.0

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (UpdateDiscountForFacilityResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateDiscountForFacilityResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpdateDiscountForFacilityResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (UpdateDiscountForFacilityResponse) Status

Status returns HTTPResponse.Status

func (UpdateDiscountForFacilityResponse) StatusCode

func (r UpdateDiscountForFacilityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateFacilityConnectionJSONBody

type UpdateFacilityConnectionJSONBody struct {
	// contains filtered or unexported fields
}

UpdateFacilityConnectionJSONBody defines parameters for UpdateFacilityConnection.

func (UpdateFacilityConnectionJSONBody) AsInterFacilityConnectionToCustomerForUpdate

func (t UpdateFacilityConnectionJSONBody) AsInterFacilityConnectionToCustomerForUpdate() (InterFacilityConnectionToCustomerForUpdate, error)

AsInterFacilityConnectionToCustomerForUpdate returns the union data inside the UpdateFacilityConnectionJSONBody as a InterFacilityConnectionToCustomerForUpdate

func (UpdateFacilityConnectionJSONBody) AsInterFacilityConnectionToManagedFacilityForUpdate

func (t UpdateFacilityConnectionJSONBody) AsInterFacilityConnectionToManagedFacilityForUpdate() (InterFacilityConnectionToManagedFacilityForUpdate, error)

AsInterFacilityConnectionToManagedFacilityForUpdate returns the union data inside the UpdateFacilityConnectionJSONBody as a InterFacilityConnectionToManagedFacilityForUpdate

func (UpdateFacilityConnectionJSONBody) AsInterFacilityConnectionToSupplierForUpdate

func (t UpdateFacilityConnectionJSONBody) AsInterFacilityConnectionToSupplierForUpdate() (InterFacilityConnectionToSupplierForUpdate, error)

AsInterFacilityConnectionToSupplierForUpdate returns the union data inside the UpdateFacilityConnectionJSONBody as a InterFacilityConnectionToSupplierForUpdate

func (UpdateFacilityConnectionJSONBody) Discriminator

func (t UpdateFacilityConnectionJSONBody) Discriminator() (string, error)

func (*UpdateFacilityConnectionJSONBody) FromInterFacilityConnectionToCustomerForUpdate

func (t *UpdateFacilityConnectionJSONBody) FromInterFacilityConnectionToCustomerForUpdate(v InterFacilityConnectionToCustomerForUpdate) error

FromInterFacilityConnectionToCustomerForUpdate overwrites any union data inside the UpdateFacilityConnectionJSONBody as the provided InterFacilityConnectionToCustomerForUpdate

func (*UpdateFacilityConnectionJSONBody) FromInterFacilityConnectionToManagedFacilityForUpdate

func (t *UpdateFacilityConnectionJSONBody) FromInterFacilityConnectionToManagedFacilityForUpdate(v InterFacilityConnectionToManagedFacilityForUpdate) error

FromInterFacilityConnectionToManagedFacilityForUpdate overwrites any union data inside the UpdateFacilityConnectionJSONBody as the provided InterFacilityConnectionToManagedFacilityForUpdate

func (*UpdateFacilityConnectionJSONBody) FromInterFacilityConnectionToSupplierForUpdate

func (t *UpdateFacilityConnectionJSONBody) FromInterFacilityConnectionToSupplierForUpdate(v InterFacilityConnectionToSupplierForUpdate) error

FromInterFacilityConnectionToSupplierForUpdate overwrites any union data inside the UpdateFacilityConnectionJSONBody as the provided InterFacilityConnectionToSupplierForUpdate

func (UpdateFacilityConnectionJSONBody) MarshalJSON

func (t UpdateFacilityConnectionJSONBody) MarshalJSON() ([]byte, error)

func (*UpdateFacilityConnectionJSONBody) MergeInterFacilityConnectionToCustomerForUpdate

func (t *UpdateFacilityConnectionJSONBody) MergeInterFacilityConnectionToCustomerForUpdate(v InterFacilityConnectionToCustomerForUpdate) error

MergeInterFacilityConnectionToCustomerForUpdate performs a merge with any union data inside the UpdateFacilityConnectionJSONBody, using the provided InterFacilityConnectionToCustomerForUpdate

func (*UpdateFacilityConnectionJSONBody) MergeInterFacilityConnectionToManagedFacilityForUpdate

func (t *UpdateFacilityConnectionJSONBody) MergeInterFacilityConnectionToManagedFacilityForUpdate(v InterFacilityConnectionToManagedFacilityForUpdate) error

MergeInterFacilityConnectionToManagedFacilityForUpdate performs a merge with any union data inside the UpdateFacilityConnectionJSONBody, using the provided InterFacilityConnectionToManagedFacilityForUpdate

func (*UpdateFacilityConnectionJSONBody) MergeInterFacilityConnectionToSupplierForUpdate

func (t *UpdateFacilityConnectionJSONBody) MergeInterFacilityConnectionToSupplierForUpdate(v InterFacilityConnectionToSupplierForUpdate) error

MergeInterFacilityConnectionToSupplierForUpdate performs a merge with any union data inside the UpdateFacilityConnectionJSONBody, using the provided InterFacilityConnectionToSupplierForUpdate

func (*UpdateFacilityConnectionJSONBody) UnmarshalJSON

func (t *UpdateFacilityConnectionJSONBody) UnmarshalJSON(b []byte) error

func (UpdateFacilityConnectionJSONBody) ValueByDiscriminator

func (t UpdateFacilityConnectionJSONBody) ValueByDiscriminator() (interface{}, error)

type UpdateFacilityConnectionJSONRequestBody

type UpdateFacilityConnectionJSONRequestBody UpdateFacilityConnectionJSONBody

UpdateFacilityConnectionJSONRequestBody defines body for UpdateFacilityConnection for application/json ContentType.

type UpdateFacilityConnectionParams

type UpdateFacilityConnectionParams struct {
	// Locale Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.
	Locale *string `form:"locale,omitempty" json:"locale,omitempty"`
}

UpdateFacilityConnectionParams defines parameters for UpdateFacilityConnection.

type UpdateFacilityConnectionResponse

type UpdateFacilityConnectionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *InterFacilityConnection
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseUpdateFacilityConnectionResponse

func ParseUpdateFacilityConnectionResponse(rsp *http.Response) (*UpdateFacilityConnectionResponse, error)

ParseUpdateFacilityConnectionResponse parses an HTTP response from a UpdateFacilityConnectionWithResponse call

func (UpdateFacilityConnectionResponse) ContentType

func (r UpdateFacilityConnectionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateFacilityConnectionResponse) GetBody added in v0.8.0

func (r UpdateFacilityConnectionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateFacilityConnectionResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateFacilityConnectionResponse) GetJSON401 added in v0.8.0

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateFacilityConnectionResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpdateFacilityConnectionResponse) GetJSON404 added in v0.8.0

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (UpdateFacilityConnectionResponse) Status

Status returns HTTPResponse.Status

func (UpdateFacilityConnectionResponse) StatusCode

func (r UpdateFacilityConnectionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateFacilityCoordinatesActionParameter

type UpdateFacilityCoordinatesActionParameter struct {
	// Coordinates Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
	Coordinates Coordinates                                  `json:"coordinates"`
	Name        UpdateFacilityCoordinatesActionParameterName `json:"name"`

	// Version Version of the entity to be changed
	Version int `json:"version"`
}

UpdateFacilityCoordinatesActionParameter Update facility Coordinates.

type UpdateFacilityCoordinatesActionParameterName added in v0.8.0

type UpdateFacilityCoordinatesActionParameterName string

UpdateFacilityCoordinatesActionParameterName defines model for UpdateFacilityCoordinatesActionParameter.Name.

const (
	UPDATEFACILITYCOORDINATES UpdateFacilityCoordinatesActionParameterName = "UPDATE_FACILITY_COORDINATES"
)

Defines values for UpdateFacilityCoordinatesActionParameterName.

func (UpdateFacilityCoordinatesActionParameterName) Valid added in v0.8.0

Valid indicates whether the value is a known member of the UpdateFacilityCoordinatesActionParameterName enum.

type UpdateMeJSONRequestBody deprecated

type UpdateMeJSONRequestBody = ModifyUserPersonalData

UpdateMeJSONRequestBody defines body for UpdateMe for application/json ContentType.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type UpdateMeResponse

type UpdateMeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *User
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
}

func ParseUpdateMeResponse

func ParseUpdateMeResponse(rsp *http.Response) (*UpdateMeResponse, error)

ParseUpdateMeResponse parses an HTTP response from a UpdateMeWithResponse call

func (UpdateMeResponse) ContentType

func (r UpdateMeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateMeResponse) GetBody added in v0.8.0

func (r UpdateMeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateMeResponse) GetJSON200 added in v0.8.0

func (r UpdateMeResponse) GetJSON200() *User

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateMeResponse) GetJSON401 added in v0.8.0

func (r UpdateMeResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateMeResponse) Status

func (r UpdateMeResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateMeResponse) StatusCode

func (r UpdateMeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateOrderJSONRequestBody added in v0.3.0

type UpdateOrderJSONRequestBody = OrderForUpdate

UpdateOrderJSONRequestBody defines body for UpdateOrder for application/json ContentType.

type UpdateOrderResponse added in v0.3.0

type UpdateOrderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Order
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseUpdateOrderResponse added in v0.3.0

func ParseUpdateOrderResponse(rsp *http.Response) (*UpdateOrderResponse, error)

ParseUpdateOrderResponse parses an HTTP response from a UpdateOrderWithResponse call

func (UpdateOrderResponse) ContentType added in v0.3.0

func (r UpdateOrderResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateOrderResponse) GetBody added in v0.8.0

func (r UpdateOrderResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateOrderResponse) GetJSON200 added in v0.8.0

func (r UpdateOrderResponse) GetJSON200() *Order

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateOrderResponse) GetJSON401 added in v0.8.0

func (r UpdateOrderResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateOrderResponse) GetJSON403 added in v0.8.0

func (r UpdateOrderResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpdateOrderResponse) GetJSON404 added in v0.8.0

func (r UpdateOrderResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (UpdateOrderResponse) Status added in v0.3.0

func (r UpdateOrderResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateOrderResponse) StatusCode added in v0.3.0

func (r UpdateOrderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateRoleJSONRequestBody

type UpdateRoleJSONRequestBody = RoleForUpdate

UpdateRoleJSONRequestBody defines body for UpdateRole for application/json ContentType.

type UpdateRoleResponse

type UpdateRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Role
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ApiError
}

func ParseUpdateRoleResponse

func ParseUpdateRoleResponse(rsp *http.Response) (*UpdateRoleResponse, error)

ParseUpdateRoleResponse parses an HTTP response from a UpdateRoleWithResponse call

func (UpdateRoleResponse) ContentType

func (r UpdateRoleResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateRoleResponse) GetBody added in v0.8.0

func (r UpdateRoleResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateRoleResponse) GetJSON200 added in v0.8.0

func (r UpdateRoleResponse) GetJSON200() *Role

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateRoleResponse) GetJSON401 added in v0.8.0

func (r UpdateRoleResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateRoleResponse) GetJSON403 added in v0.8.0

func (r UpdateRoleResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpdateRoleResponse) GetJSON404 added in v0.8.0

func (r UpdateRoleResponse) GetJSON404() *ApiError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (UpdateRoleResponse) Status

func (r UpdateRoleResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateRoleResponse) StatusCode

func (r UpdateRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateStockJSONBody

type UpdateStockJSONBody struct {
	// contains filtered or unexported fields
}

UpdateStockJSONBody defines parameters for UpdateStock.

func (UpdateStockJSONBody) AsStockForUpdate

func (t UpdateStockJSONBody) AsStockForUpdate() (StockForUpdate, error)

AsStockForUpdate returns the union data inside the UpdateStockJSONBody as a StockForUpdate

func (UpdateStockJSONBody) AsUpdateStockJSONBody1

func (t UpdateStockJSONBody) AsUpdateStockJSONBody1() (UpdateStockJSONBody1, error)

AsUpdateStockJSONBody1 returns the union data inside the UpdateStockJSONBody as a UpdateStockJSONBody1

func (*UpdateStockJSONBody) FromStockForUpdate

func (t *UpdateStockJSONBody) FromStockForUpdate(v StockForUpdate) error

FromStockForUpdate overwrites any union data inside the UpdateStockJSONBody as the provided StockForUpdate

func (*UpdateStockJSONBody) FromUpdateStockJSONBody1

func (t *UpdateStockJSONBody) FromUpdateStockJSONBody1(v UpdateStockJSONBody1) error

FromUpdateStockJSONBody1 overwrites any union data inside the UpdateStockJSONBody as the provided UpdateStockJSONBody1

func (UpdateStockJSONBody) MarshalJSON

func (t UpdateStockJSONBody) MarshalJSON() ([]byte, error)

func (*UpdateStockJSONBody) MergeStockForUpdate

func (t *UpdateStockJSONBody) MergeStockForUpdate(v StockForUpdate) error

MergeStockForUpdate performs a merge with any union data inside the UpdateStockJSONBody, using the provided StockForUpdate

func (*UpdateStockJSONBody) MergeUpdateStockJSONBody1

func (t *UpdateStockJSONBody) MergeUpdateStockJSONBody1(v UpdateStockJSONBody1) error

MergeUpdateStockJSONBody1 performs a merge with any union data inside the UpdateStockJSONBody, using the provided UpdateStockJSONBody1

func (*UpdateStockJSONBody) UnmarshalJSON

func (t *UpdateStockJSONBody) UnmarshalJSON(b []byte) error

type UpdateStockJSONBody1

type UpdateStockJSONBody1 struct {
	LocationRef *string `json:"locationRef,omitempty"`
	Value       int32   `json:"value"`
}

UpdateStockJSONBody1 defines parameters for UpdateStock.

type UpdateStockJSONRequestBody

type UpdateStockJSONRequestBody UpdateStockJSONBody

UpdateStockJSONRequestBody defines body for UpdateStock for application/json ContentType.

type UpdateStockResponse

type UpdateStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Stock
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseUpdateStockResponse

func ParseUpdateStockResponse(rsp *http.Response) (*UpdateStockResponse, error)

ParseUpdateStockResponse parses an HTTP response from a UpdateStockWithResponse call

func (UpdateStockResponse) ContentType

func (r UpdateStockResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateStockResponse) GetBody added in v0.8.0

func (r UpdateStockResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateStockResponse) GetJSON200 added in v0.8.0

func (r UpdateStockResponse) GetJSON200() *Stock

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateStockResponse) GetJSON401 added in v0.8.0

func (r UpdateStockResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateStockResponse) GetJSON403 added in v0.8.0

func (r UpdateStockResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpdateStockResponse) Status

func (r UpdateStockResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateStockResponse) StatusCode

func (r UpdateStockResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpsertStocksJSONRequestBody

type UpsertStocksJSONRequestBody = StocksForUpsert

UpsertStocksJSONRequestBody defines body for UpsertStocks for application/json ContentType.

type UpsertStocksResponse

type UpsertStocksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]StockUpsertOperationResult
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ApiError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiError
}

func ParseUpsertStocksResponse

func ParseUpsertStocksResponse(rsp *http.Response) (*UpsertStocksResponse, error)

ParseUpsertStocksResponse parses an HTTP response from a UpsertStocksWithResponse call

func (UpsertStocksResponse) ContentType

func (r UpsertStocksResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpsertStocksResponse) GetBody added in v0.8.0

func (r UpsertStocksResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpsertStocksResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpsertStocksResponse) GetJSON401 added in v0.8.0

func (r UpsertStocksResponse) GetJSON401() *ApiError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpsertStocksResponse) GetJSON403 added in v0.8.0

func (r UpsertStocksResponse) GetJSON403() *ApiError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpsertStocksResponse) Status

func (r UpsertStocksResponse) Status() string

Status returns HTTPResponse.Status

func (UpsertStocksResponse) StatusCode

func (r UpsertStocksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type User

type User struct {
	// AssignedFacilities Deprecated: Find all relevant information in assignedRoles instead
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AssignedFacilities *[]UserAssignedFacility `json:"assignedFacilities,omitempty"`

	// AssignedRoles The assigned roles of a user
	AssignedRoles []AssignedRoles `json:"assignedRoles"`

	// AuthenticationProvider The authentication provider of the user
	AuthenticationProvider AuthenticationProvider `json:"authenticationProvider"`

	// AuthenticationProviderType This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
	//
	// Example: de_DE
	AuthenticationProviderType *SupportedLocale `json:"authenticationProviderType,omitempty"`

	// Created Creation date of the user
	Created *time.Time `json:"created,omitempty"`

	// CustomAttributes The custom attributes of the user
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// CustomClaims Deprecated: Find all relevant information in assignedRoles instead
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	CustomClaims *CustomClaims `json:"customClaims,omitempty"`

	// Email The email of the user
	//
	// Example: john.doe@example.com
	Email *string `json:"email,omitempty"`

	// FacilityLimitations Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted
	FacilityLimitations *[]string `json:"facilityLimitations,omitempty"`

	// Firstname The first name of the user
	//
	// Example: John
	Firstname string `json:"firstname"`

	// Id The id of the user
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id string `json:"id"`

	// LastLogin The last login timestamp of the user
	LastLogin *time.Time `json:"lastLogin,omitempty"`

	// LastModified Last modification date of the user
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Lastname The last name of the user
	//
	// Example: Doe
	Lastname string `json:"lastname"`

	// Locale This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
	//
	// Example: de_DE
	Locale *SupportedLocale `json:"locale,omitempty"`

	// Username The username of the user
	//
	// Example: johndoe
	Username string `json:"username"`

	// Version Version of the user
	//
	// Example: 1
	Version float32 `json:"version"`
}

User User

type UserActionEnum

type UserActionEnum string

UserActionEnum The type of action to perform

const (
	UserActionEnumModifyUser UserActionEnum = "ModifyUser"
)

Defines values for UserActionEnum.

func (UserActionEnum) Valid

func (e UserActionEnum) Valid() bool

Valid indicates whether the value is a known member of the UserActionEnum enum.

type UserAssignedFacilitiesFilter

type UserAssignedFacilitiesFilter struct {
	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`
}

UserAssignedFacilitiesFilter UserAssignedFacilitiesFilter

type UserAssignedFacilitiesListFilter

type UserAssignedFacilitiesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *UserAssignedFacilitiesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

UserAssignedFacilitiesListFilter UserAssignedFacilitiesListFilter

type UserAssignedFacility

type UserAssignedFacility struct {
	// AssignedZones The assigned zones of the user
	AssignedZones *[]UserAssignedZone `json:"assignedZones,omitempty"`

	// FacilityRef The id of the assigned facility
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef string `json:"facilityRef"`

	// Id The id of the assigned facility
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id string `json:"id"`
}

UserAssignedFacility UserAssignedFacility

type UserAssignedFacilityForCreation

type UserAssignedFacilityForCreation struct {
	// AssignedZones The assigned zones of the user
	AssignedZones *[]UserAssignedZone `json:"assignedZones,omitempty"`

	// FacilityRef The id of the assigned facility
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef string `json:"facilityRef"`
}

UserAssignedFacilityForCreation UserAssignedFacilityForCreation

type UserAssignedRolesContextContextTypesEnumFilter

type UserAssignedRolesContextContextTypesEnumFilter struct {
	// Eq Search by type
	Eq *UserAssignedRolesContextContextTypesEnumFilterEq `json:"eq,omitempty"`

	// In Search by type
	In *[]UserAssignedRolesContextContextTypesEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by type
	NotEq *UserAssignedRolesContextContextTypesEnumFilterNotEq `json:"notEq,omitempty"`
}

UserAssignedRolesContextContextTypesEnumFilter UserAssignedRolesContextContextTypesEnumFilter

type UserAssignedRolesContextContextTypesEnumFilterEq

type UserAssignedRolesContextContextTypesEnumFilterEq string

UserAssignedRolesContextContextTypesEnumFilterEq Search by type

const (
	UserAssignedRolesContextContextTypesEnumFilterEqFACILITY      UserAssignedRolesContextContextTypesEnumFilterEq = "FACILITY"
	UserAssignedRolesContextContextTypesEnumFilterEqFACILITYGROUP UserAssignedRolesContextContextTypesEnumFilterEq = "FACILITY_GROUP"
	UserAssignedRolesContextContextTypesEnumFilterEqROLE          UserAssignedRolesContextContextTypesEnumFilterEq = "ROLE"
	UserAssignedRolesContextContextTypesEnumFilterEqUSERROLE      UserAssignedRolesContextContextTypesEnumFilterEq = "USER_ROLE"
	UserAssignedRolesContextContextTypesEnumFilterEqZONE          UserAssignedRolesContextContextTypesEnumFilterEq = "ZONE"
)

Defines values for UserAssignedRolesContextContextTypesEnumFilterEq.

func (UserAssignedRolesContextContextTypesEnumFilterEq) Valid

Valid indicates whether the value is a known member of the UserAssignedRolesContextContextTypesEnumFilterEq enum.

type UserAssignedRolesContextContextTypesEnumFilterIn

type UserAssignedRolesContextContextTypesEnumFilterIn string

UserAssignedRolesContextContextTypesEnumFilterIn defines model for UserAssignedRolesContextContextTypesEnumFilter.In.

const (
	UserAssignedRolesContextContextTypesEnumFilterInFACILITY      UserAssignedRolesContextContextTypesEnumFilterIn = "FACILITY"
	UserAssignedRolesContextContextTypesEnumFilterInFACILITYGROUP UserAssignedRolesContextContextTypesEnumFilterIn = "FACILITY_GROUP"
	UserAssignedRolesContextContextTypesEnumFilterInROLE          UserAssignedRolesContextContextTypesEnumFilterIn = "ROLE"
	UserAssignedRolesContextContextTypesEnumFilterInUSERROLE      UserAssignedRolesContextContextTypesEnumFilterIn = "USER_ROLE"
	UserAssignedRolesContextContextTypesEnumFilterInZONE          UserAssignedRolesContextContextTypesEnumFilterIn = "ZONE"
)

Defines values for UserAssignedRolesContextContextTypesEnumFilterIn.

func (UserAssignedRolesContextContextTypesEnumFilterIn) Valid

Valid indicates whether the value is a known member of the UserAssignedRolesContextContextTypesEnumFilterIn enum.

type UserAssignedRolesContextContextTypesEnumFilterNotEq

type UserAssignedRolesContextContextTypesEnumFilterNotEq string

UserAssignedRolesContextContextTypesEnumFilterNotEq Search by type

const (
	UserAssignedRolesContextContextTypesEnumFilterNotEqFACILITY      UserAssignedRolesContextContextTypesEnumFilterNotEq = "FACILITY"
	UserAssignedRolesContextContextTypesEnumFilterNotEqFACILITYGROUP UserAssignedRolesContextContextTypesEnumFilterNotEq = "FACILITY_GROUP"
	UserAssignedRolesContextContextTypesEnumFilterNotEqROLE          UserAssignedRolesContextContextTypesEnumFilterNotEq = "ROLE"
	UserAssignedRolesContextContextTypesEnumFilterNotEqUSERROLE      UserAssignedRolesContextContextTypesEnumFilterNotEq = "USER_ROLE"
	UserAssignedRolesContextContextTypesEnumFilterNotEqZONE          UserAssignedRolesContextContextTypesEnumFilterNotEq = "ZONE"
)

Defines values for UserAssignedRolesContextContextTypesEnumFilterNotEq.

func (UserAssignedRolesContextContextTypesEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the UserAssignedRolesContextContextTypesEnumFilterNotEq enum.

type UserAssignedRolesContextFilter

type UserAssignedRolesContextFilter struct {
	// Type Search by type
	Type *UserAssignedRolesContextContextTypesEnumFilter `json:"type,omitempty"`

	// Values Search by values
	Values *StringListFilter `json:"values,omitempty"`
}

UserAssignedRolesContextFilter UserAssignedRolesContextFilter

type UserAssignedRolesContextLimitationsContextTypesEnumFilter

type UserAssignedRolesContextLimitationsContextTypesEnumFilter struct {
	// Eq Search by type
	Eq *UserAssignedRolesContextLimitationsContextTypesEnumFilterEq `json:"eq,omitempty"`

	// In Search by type
	In *[]UserAssignedRolesContextLimitationsContextTypesEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by type
	NotEq *UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq `json:"notEq,omitempty"`
}

UserAssignedRolesContextLimitationsContextTypesEnumFilter UserAssignedRolesContextLimitationsContextTypesEnumFilter

type UserAssignedRolesContextLimitationsContextTypesEnumFilterEq

type UserAssignedRolesContextLimitationsContextTypesEnumFilterEq string

UserAssignedRolesContextLimitationsContextTypesEnumFilterEq Search by type

const (
	UserAssignedRolesContextLimitationsContextTypesEnumFilterEqFACILITY      UserAssignedRolesContextLimitationsContextTypesEnumFilterEq = "FACILITY"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterEqFACILITYGROUP UserAssignedRolesContextLimitationsContextTypesEnumFilterEq = "FACILITY_GROUP"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterEqROLE          UserAssignedRolesContextLimitationsContextTypesEnumFilterEq = "ROLE"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterEqUSERROLE      UserAssignedRolesContextLimitationsContextTypesEnumFilterEq = "USER_ROLE"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterEqZONE          UserAssignedRolesContextLimitationsContextTypesEnumFilterEq = "ZONE"
)

Defines values for UserAssignedRolesContextLimitationsContextTypesEnumFilterEq.

func (UserAssignedRolesContextLimitationsContextTypesEnumFilterEq) Valid

Valid indicates whether the value is a known member of the UserAssignedRolesContextLimitationsContextTypesEnumFilterEq enum.

type UserAssignedRolesContextLimitationsContextTypesEnumFilterIn

type UserAssignedRolesContextLimitationsContextTypesEnumFilterIn string

UserAssignedRolesContextLimitationsContextTypesEnumFilterIn defines model for UserAssignedRolesContextLimitationsContextTypesEnumFilter.In.

const (
	UserAssignedRolesContextLimitationsContextTypesEnumFilterInFACILITY      UserAssignedRolesContextLimitationsContextTypesEnumFilterIn = "FACILITY"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterInFACILITYGROUP UserAssignedRolesContextLimitationsContextTypesEnumFilterIn = "FACILITY_GROUP"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterInROLE          UserAssignedRolesContextLimitationsContextTypesEnumFilterIn = "ROLE"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterInUSERROLE      UserAssignedRolesContextLimitationsContextTypesEnumFilterIn = "USER_ROLE"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterInZONE          UserAssignedRolesContextLimitationsContextTypesEnumFilterIn = "ZONE"
)

Defines values for UserAssignedRolesContextLimitationsContextTypesEnumFilterIn.

func (UserAssignedRolesContextLimitationsContextTypesEnumFilterIn) Valid

Valid indicates whether the value is a known member of the UserAssignedRolesContextLimitationsContextTypesEnumFilterIn enum.

type UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq

type UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq string

UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq Search by type

const (
	UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEqFACILITY      UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq = "FACILITY"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEqFACILITYGROUP UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq = "FACILITY_GROUP"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEqROLE          UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq = "ROLE"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEqUSERROLE      UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq = "USER_ROLE"
	UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEqZONE          UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq = "ZONE"
)

Defines values for UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq.

func (UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the UserAssignedRolesContextLimitationsContextTypesEnumFilterNotEq enum.

type UserAssignedRolesContextLimitationsFilter

type UserAssignedRolesContextLimitationsFilter struct {
	// Type Search by type
	Type *UserAssignedRolesContextLimitationsContextTypesEnumFilter `json:"type,omitempty"`

	// Values Search by values
	Values *StringListFilter `json:"values,omitempty"`
}

UserAssignedRolesContextLimitationsFilter UserAssignedRolesContextLimitationsFilter

type UserAssignedRolesContextLimitationsListFilter

type UserAssignedRolesContextLimitationsListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *UserAssignedRolesContextLimitationsFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

UserAssignedRolesContextLimitationsListFilter UserAssignedRolesContextLimitationsListFilter

type UserAssignedRolesContextListFilter

type UserAssignedRolesContextListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *UserAssignedRolesContextFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

UserAssignedRolesContextListFilter UserAssignedRolesContextListFilter

type UserAssignedRolesFilter

type UserAssignedRolesFilter struct {
	// Context Nested list search by context
	Context *UserAssignedRolesContextListFilter `json:"context,omitempty"`

	// ContextLimitations Deprecated: Use context field instead
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ContextLimitations *UserAssignedRolesContextLimitationsListFilter `json:"contextLimitations,omitempty"`

	// Ref Search by ref
	Ref *StringFilter `json:"ref,omitempty"`
}

UserAssignedRolesFilter UserAssignedRolesFilter

type UserAssignedRolesListFilter

type UserAssignedRolesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *UserAssignedRolesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

UserAssignedRolesListFilter UserAssignedRolesListFilter

type UserAssignedRolesSort

type UserAssignedRolesSort struct {
	Ref *UserAssignedRolesSortRef `json:"ref,omitempty"`
}

UserAssignedRolesSort UserAssignedRolesSort

type UserAssignedRolesSortRef

type UserAssignedRolesSortRef string

UserAssignedRolesSortRef defines model for UserAssignedRolesSort.Ref.

const (
	UserAssignedRolesSortRefASC  UserAssignedRolesSortRef = "ASC"
	UserAssignedRolesSortRefDESC UserAssignedRolesSortRef = "DESC"
)

Defines values for UserAssignedRolesSortRef.

func (UserAssignedRolesSortRef) Valid

func (e UserAssignedRolesSortRef) Valid() bool

Valid indicates whether the value is a known member of the UserAssignedRolesSortRef enum.

type UserAssignedZone

type UserAssignedZone struct {
	// ZoneRef The id of the assigned zone
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	ZoneRef string `json:"zoneRef"`
}

UserAssignedZone UserAssignedZone

type UserAuthAuthenticationProviderTypeEnumFilter

type UserAuthAuthenticationProviderTypeEnumFilter struct {
	// Eq Search by type
	Eq *UserAuthAuthenticationProviderTypeEnumFilterEq `json:"eq,omitempty"`

	// In Search by type
	In *[]UserAuthAuthenticationProviderTypeEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by type
	NotEq *UserAuthAuthenticationProviderTypeEnumFilterNotEq `json:"notEq,omitempty"`
}

UserAuthAuthenticationProviderTypeEnumFilter UserAuthAuthenticationProviderTypeEnumFilter

type UserAuthAuthenticationProviderTypeEnumFilterEq

type UserAuthAuthenticationProviderTypeEnumFilterEq string

UserAuthAuthenticationProviderTypeEnumFilterEq Search by type

const (
	UserAuthAuthenticationProviderTypeEnumFilterEqEMAILPASSWORD UserAuthAuthenticationProviderTypeEnumFilterEq = "EMAIL_PASSWORD"
	UserAuthAuthenticationProviderTypeEnumFilterEqOIDC          UserAuthAuthenticationProviderTypeEnumFilterEq = "OIDC"
	UserAuthAuthenticationProviderTypeEnumFilterEqSUPPORTACCESS UserAuthAuthenticationProviderTypeEnumFilterEq = "SUPPORT_ACCESS"
)

Defines values for UserAuthAuthenticationProviderTypeEnumFilterEq.

func (UserAuthAuthenticationProviderTypeEnumFilterEq) Valid

Valid indicates whether the value is a known member of the UserAuthAuthenticationProviderTypeEnumFilterEq enum.

type UserAuthAuthenticationProviderTypeEnumFilterIn

type UserAuthAuthenticationProviderTypeEnumFilterIn string

UserAuthAuthenticationProviderTypeEnumFilterIn defines model for UserAuthAuthenticationProviderTypeEnumFilter.In.

const (
	UserAuthAuthenticationProviderTypeEnumFilterInEMAILPASSWORD UserAuthAuthenticationProviderTypeEnumFilterIn = "EMAIL_PASSWORD"
	UserAuthAuthenticationProviderTypeEnumFilterInOIDC          UserAuthAuthenticationProviderTypeEnumFilterIn = "OIDC"
	UserAuthAuthenticationProviderTypeEnumFilterInSUPPORTACCESS UserAuthAuthenticationProviderTypeEnumFilterIn = "SUPPORT_ACCESS"
)

Defines values for UserAuthAuthenticationProviderTypeEnumFilterIn.

func (UserAuthAuthenticationProviderTypeEnumFilterIn) Valid

Valid indicates whether the value is a known member of the UserAuthAuthenticationProviderTypeEnumFilterIn enum.

type UserAuthAuthenticationProviderTypeEnumFilterNotEq

type UserAuthAuthenticationProviderTypeEnumFilterNotEq string

UserAuthAuthenticationProviderTypeEnumFilterNotEq Search by type

const (
	UserAuthAuthenticationProviderTypeEnumFilterNotEqEMAILPASSWORD UserAuthAuthenticationProviderTypeEnumFilterNotEq = "EMAIL_PASSWORD"
	UserAuthAuthenticationProviderTypeEnumFilterNotEqOIDC          UserAuthAuthenticationProviderTypeEnumFilterNotEq = "OIDC"
	UserAuthAuthenticationProviderTypeEnumFilterNotEqSUPPORTACCESS UserAuthAuthenticationProviderTypeEnumFilterNotEq = "SUPPORT_ACCESS"
)

Defines values for UserAuthAuthenticationProviderTypeEnumFilterNotEq.

func (UserAuthAuthenticationProviderTypeEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the UserAuthAuthenticationProviderTypeEnumFilterNotEq enum.

type UserAuthFilter

type UserAuthFilter struct {
	// Type Search by type
	Type *UserAuthAuthenticationProviderTypeEnumFilter `json:"type,omitempty"`
}

UserAuthFilter UserAuthFilter

type UserAuthenticationProviderSort

type UserAuthenticationProviderSort struct {
	Type *UserAuthenticationProviderSortType `json:"type,omitempty"`
}

UserAuthenticationProviderSort UserAuthenticationProviderSort

type UserAuthenticationProviderSortType

type UserAuthenticationProviderSortType string

UserAuthenticationProviderSortType defines model for UserAuthenticationProviderSort.Type.

const (
	UserAuthenticationProviderSortTypeASC  UserAuthenticationProviderSortType = "ASC"
	UserAuthenticationProviderSortTypeDESC UserAuthenticationProviderSortType = "DESC"
)

Defines values for UserAuthenticationProviderSortType.

func (UserAuthenticationProviderSortType) Valid

Valid indicates whether the value is a known member of the UserAuthenticationProviderSortType enum.

type UserCustomClaimsFilter

type UserCustomClaimsFilter struct {
	// Roles Nested list search by roles
	Roles *UserCustomClaimsRolesListFilter `json:"roles,omitempty"`
}

UserCustomClaimsFilter UserCustomClaimsFilter

type UserCustomClaimsRolesFilter

type UserCustomClaimsRolesFilter struct {
	// Facilities Search by facilities
	Facilities *StringListFilter `json:"facilities,omitempty"`

	// Name Search by name
	Name *UserCustomClaimsRolesUserRoleNamesEnumFilter `json:"name,omitempty"`
}

UserCustomClaimsRolesFilter UserCustomClaimsRolesFilter

type UserCustomClaimsRolesListFilter

type UserCustomClaimsRolesListFilter struct {
	// Contains Contains returns if at least one entry matches
	Contains *UserCustomClaimsRolesFilter `json:"contains,omitempty"`

	// Exists exists:false matches empty or absent lists; exists:true matches non-empty lists
	Exists *bool `json:"exists,omitempty"`
}

UserCustomClaimsRolesListFilter UserCustomClaimsRolesListFilter

type UserCustomClaimsRolesUserRoleNamesEnumFilter

type UserCustomClaimsRolesUserRoleNamesEnumFilter struct {
	// Eq Search by name
	Eq *UserCustomClaimsRolesUserRoleNamesEnumFilterEq `json:"eq,omitempty"`

	// In Search by name
	In *[]UserCustomClaimsRolesUserRoleNamesEnumFilterIn `json:"in,omitempty"`

	// NotEq Search by name
	NotEq *UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq `json:"notEq,omitempty"`
}

UserCustomClaimsRolesUserRoleNamesEnumFilter UserCustomClaimsRolesUserRoleNamesEnumFilter

type UserCustomClaimsRolesUserRoleNamesEnumFilterEq

type UserCustomClaimsRolesUserRoleNamesEnumFilterEq string

UserCustomClaimsRolesUserRoleNamesEnumFilterEq Search by name

const (
	UserCustomClaimsRolesUserRoleNamesEnumFilterEqADMINISTRATOR UserCustomClaimsRolesUserRoleNamesEnumFilterEq = "ADMINISTRATOR"
	UserCustomClaimsRolesUserRoleNamesEnumFilterEqFULFILLER     UserCustomClaimsRolesUserRoleNamesEnumFilterEq = "FULFILLER"
	UserCustomClaimsRolesUserRoleNamesEnumFilterEqSUPERVISOR    UserCustomClaimsRolesUserRoleNamesEnumFilterEq = "SUPERVISOR"
)

Defines values for UserCustomClaimsRolesUserRoleNamesEnumFilterEq.

func (UserCustomClaimsRolesUserRoleNamesEnumFilterEq) Valid

Valid indicates whether the value is a known member of the UserCustomClaimsRolesUserRoleNamesEnumFilterEq enum.

type UserCustomClaimsRolesUserRoleNamesEnumFilterIn

type UserCustomClaimsRolesUserRoleNamesEnumFilterIn string

UserCustomClaimsRolesUserRoleNamesEnumFilterIn defines model for UserCustomClaimsRolesUserRoleNamesEnumFilter.In.

const (
	UserCustomClaimsRolesUserRoleNamesEnumFilterInADMINISTRATOR UserCustomClaimsRolesUserRoleNamesEnumFilterIn = "ADMINISTRATOR"
	UserCustomClaimsRolesUserRoleNamesEnumFilterInFULFILLER     UserCustomClaimsRolesUserRoleNamesEnumFilterIn = "FULFILLER"
	UserCustomClaimsRolesUserRoleNamesEnumFilterInSUPERVISOR    UserCustomClaimsRolesUserRoleNamesEnumFilterIn = "SUPERVISOR"
)

Defines values for UserCustomClaimsRolesUserRoleNamesEnumFilterIn.

func (UserCustomClaimsRolesUserRoleNamesEnumFilterIn) Valid

Valid indicates whether the value is a known member of the UserCustomClaimsRolesUserRoleNamesEnumFilterIn enum.

type UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq

type UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq string

UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq Search by name

const (
	UserCustomClaimsRolesUserRoleNamesEnumFilterNotEqADMINISTRATOR UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq = "ADMINISTRATOR"
	UserCustomClaimsRolesUserRoleNamesEnumFilterNotEqFULFILLER     UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq = "FULFILLER"
	UserCustomClaimsRolesUserRoleNamesEnumFilterNotEqSUPERVISOR    UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq = "SUPERVISOR"
)

Defines values for UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq.

func (UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq) Valid

Valid indicates whether the value is a known member of the UserCustomClaimsRolesUserRoleNamesEnumFilterNotEq enum.

type UserForCreation

type UserForCreation struct {
	// AssignedFacilities The assigned facilities of the user
	AssignedFacilities *[]UserAssignedFacilityForCreation `json:"assignedFacilities,omitempty"`

	// AssignedRoles The roles which are assigned to the user
	AssignedRoles *[]AssignedRoles `json:"assignedRoles,omitempty"`

	// CustomAttributes The custom attributes of the user
	CustomAttributes *map[string]interface{} `json:"customAttributes,omitempty"`

	// Email The email of the user
	//
	// Example: john.doe@example.com
	Email *string `json:"email,omitempty"`

	// Firstname The first name of the user
	//
	// Example: John
	Firstname string `json:"firstname"`

	// Lastname The last name of the user
	//
	// Example: Doe
	Lastname string `json:"lastname"`

	// Locale This part of the API is in Beta status. For details, see the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview" target="_blank">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
	//
	// Example: de_DE
	Locale *SupportedLocale `json:"locale,omitempty"`

	// Password The password of the user
	//
	// Example: elephantMangoDance123
	Password string `json:"password"`

	// Roles Deprecated: Use assignedRoles instead
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Roles *[]UserRole `json:"roles,omitempty"`

	// Username The username of the user
	//
	// Example: johndoe
	Username string `json:"username"`
}

UserForCreation UserForCreation

type UserPaginatedResult

type UserPaginatedResult struct {
	// PageInfo Pagination information for the search result.
	PageInfo PageInfo `json:"pageInfo"`

	// Total The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
	Total *float32 `json:"total,omitempty"`
	Users []User   `json:"users"`
}

UserPaginatedResult UserPaginatedResult

type UserPatchActions

type UserPatchActions struct {
	// Actions The actions to perform
	Actions []ModifyUserAction `json:"actions"`

	// Version The version of the user to modify
	//
	// Example: 1
	Version float32 `json:"version"`
}

UserPatchActions UserPatchActions

type UserRole

type UserRole struct {
	// Context An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.
	Context *[]ContextLimitation `json:"context,omitempty"`

	// ContextLimitations The context limitations for this role (deprecated)
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ContextLimitations *[]ContextLimitation `json:"contextLimitations,omitempty"`

	// Facilities Facility limitations are now defined in the context with type FACILITY
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Facilities *[]string `json:"facilities,omitempty"`

	// Name The name of the role
	Name string `json:"name"`
}

UserRole UserRole

type UserRoleWithPermissions

type UserRoleWithPermissions struct {
	// Context An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.
	Context *[]ContextLimitation `json:"context,omitempty"`

	// ContextLimitations The context limitations for this role (deprecated)
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ContextLimitations *[]ContextLimitation `json:"contextLimitations,omitempty"`

	// Facilities Facility limitations are now defined in the context with type FACILITY
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Facilities *[]string `json:"facilities,omitempty"`

	// Name The name of the role
	Name string `json:"name"`

	// Permissions The permissions associated with the role, which define what actions the role can perform.
	Permissions *[]UserRoleWithPermissionsPermissions `json:"permissions,omitempty"`
}

UserRoleWithPermissions UserRoleWithPermissions

type UserRoleWithPermissionsPermissions

type UserRoleWithPermissionsPermissions string

UserRoleWithPermissionsPermissions defines model for UserRoleWithPermissions.Permissions.

const (
	UserRoleWithPermissionsPermissionsADMINDATARESET                        UserRoleWithPermissionsPermissions = "ADMIN_DATA_RESET"
	UserRoleWithPermissionsPermissionsADMININTERFACILITYCONNECTIONMIGRATION UserRoleWithPermissionsPermissions = "ADMIN_INTER_FACILITY_CONNECTION_MIGRATION"
	UserRoleWithPermissionsPermissionsADMINMODULESREAD                      UserRoleWithPermissionsPermissions = "ADMIN_MODULES_READ"
	UserRoleWithPermissionsPermissionsADMINMODULESWRITE                     UserRoleWithPermissionsPermissions = "ADMIN_MODULES_WRITE"
	UserRoleWithPermissionsPermissionsADMINROUTINGPLANANALYSIS              UserRoleWithPermissionsPermissions = "ADMIN_ROUTING_PLAN_ANALYSIS"
	UserRoleWithPermissionsPermissionsAIASSISTANTACCESS                     UserRoleWithPermissionsPermissions = "AI_ASSISTANT_ACCESS"
	UserRoleWithPermissionsPermissionsANALYTICSDASHBOARDREAD                UserRoleWithPermissionsPermissions = "ANALYTICS_DASHBOARD_READ"
	UserRoleWithPermissionsPermissionsAUDITREAD                             UserRoleWithPermissionsPermissions = "AUDIT_READ"
	UserRoleWithPermissionsPermissionsAVAILABILITYCHANNELREAD               UserRoleWithPermissionsPermissions = "AVAILABILITY_CHANNEL_READ"
	UserRoleWithPermissionsPermissionsAVAILABILITYCHANNELWRITE              UserRoleWithPermissionsPermissions = "AVAILABILITY_CHANNEL_WRITE"
	UserRoleWithPermissionsPermissionsAVAILABILITYTHRESHOLDSREAD            UserRoleWithPermissionsPermissions = "AVAILABILITY_THRESHOLDS_READ"
	UserRoleWithPermissionsPermissionsAVAILABILITYTHRESHOLDSWRITE           UserRoleWithPermissionsPermissions = "AVAILABILITY_THRESHOLDS_WRITE"
	UserRoleWithPermissionsPermissionsBRANDREAD                             UserRoleWithPermissionsPermissions = "BRAND_READ"
	UserRoleWithPermissionsPermissionsCARRIERREAD                           UserRoleWithPermissionsPermissions = "CARRIER_READ"
	UserRoleWithPermissionsPermissionsCARRIERWRITE                          UserRoleWithPermissionsPermissions = "CARRIER_WRITE"
	UserRoleWithPermissionsPermissionsCATEGORYREAD                          UserRoleWithPermissionsPermissions = "CATEGORY_READ"
	UserRoleWithPermissionsPermissionsCATEGORYWRITE                         UserRoleWithPermissionsPermissions = "CATEGORY_WRITE"
	UserRoleWithPermissionsPermissionsCONFIGREAD                            UserRoleWithPermissionsPermissions = "CONFIG_READ"
	UserRoleWithPermissionsPermissionsCONFIGWRITE                           UserRoleWithPermissionsPermissions = "CONFIG_WRITE"
	UserRoleWithPermissionsPermissionsCURRENTUSERMODIFY                     UserRoleWithPermissionsPermissions = "CURRENT_USER_MODIFY"
	UserRoleWithPermissionsPermissionsCURRENTUSERREAD                       UserRoleWithPermissionsPermissions = "CURRENT_USER_READ"
	UserRoleWithPermissionsPermissionsCUSTOMSERVICEREAD                     UserRoleWithPermissionsPermissions = "CUSTOM_SERVICE_READ"
	UserRoleWithPermissionsPermissionsCUSTOMSERVICEWRITE                    UserRoleWithPermissionsPermissions = "CUSTOM_SERVICE_WRITE"
	UserRoleWithPermissionsPermissionsDELIVERYNOTEWRITE                     UserRoleWithPermissionsPermissions = "DELIVERYNOTE_WRITE"
	UserRoleWithPermissionsPermissionsDOCUMENTSETREAD                       UserRoleWithPermissionsPermissions = "DOCUMENT_SET_READ"
	UserRoleWithPermissionsPermissionsDOCUMENTSETWRITE                      UserRoleWithPermissionsPermissions = "DOCUMENT_SET_WRITE"
	UserRoleWithPermissionsPermissionsDOMSSTATISTICSREAD                    UserRoleWithPermissionsPermissions = "DOMS_STATISTICS_READ"
	UserRoleWithPermissionsPermissionsDOMSTOOLKITREAD                       UserRoleWithPermissionsPermissions = "DOMS_TOOLKIT_READ"
	UserRoleWithPermissionsPermissionsDOMSTOOLKITWRITE                      UserRoleWithPermissionsPermissions = "DOMS_TOOLKIT_WRITE"
	UserRoleWithPermissionsPermissionsEVENTREAD                             UserRoleWithPermissionsPermissions = "EVENT_READ"
	UserRoleWithPermissionsPermissionsEXPIRIESREAD                          UserRoleWithPermissionsPermissions = "EXPIRIES_READ"
	UserRoleWithPermissionsPermissionsEXPIRIESWRITE                         UserRoleWithPermissionsPermissions = "EXPIRIES_WRITE"
	UserRoleWithPermissionsPermissionsEXPORTREAD                            UserRoleWithPermissionsPermissions = "EXPORT_READ"
	UserRoleWithPermissionsPermissionsEXPORTWRITE                           UserRoleWithPermissionsPermissions = "EXPORT_WRITE"
	UserRoleWithPermissionsPermissionsEXTERNALACTIONSREAD                   UserRoleWithPermissionsPermissions = "EXTERNAL_ACTIONS_READ"
	UserRoleWithPermissionsPermissionsEXTERNALACTIONSWRITE                  UserRoleWithPermissionsPermissions = "EXTERNAL_ACTIONS_WRITE"
	UserRoleWithPermissionsPermissionsEXTERNALSTOCKCHANGEREASONSREAD        UserRoleWithPermissionsPermissions = "EXTERNAL_STOCK_CHANGE_REASONS_READ"
	UserRoleWithPermissionsPermissionsEXTERNALSTOCKCHANGEREASONSWRITE       UserRoleWithPermissionsPermissions = "EXTERNAL_STOCK_CHANGE_REASONS_WRITE"
	UserRoleWithPermissionsPermissionsFACILITYCREATE                        UserRoleWithPermissionsPermissions = "FACILITY_CREATE"
	UserRoleWithPermissionsPermissionsFACILITYDELETE                        UserRoleWithPermissionsPermissions = "FACILITY_DELETE"
	UserRoleWithPermissionsPermissionsFACILITYGROUPREAD                     UserRoleWithPermissionsPermissions = "FACILITY_GROUP_READ"
	UserRoleWithPermissionsPermissionsFACILITYGROUPWRITE                    UserRoleWithPermissionsPermissions = "FACILITY_GROUP_WRITE"
	UserRoleWithPermissionsPermissionsFACILITYREAD                          UserRoleWithPermissionsPermissions = "FACILITY_READ"
	UserRoleWithPermissionsPermissionsFACILITYWRITE                         UserRoleWithPermissionsPermissions = "FACILITY_WRITE"
	UserRoleWithPermissionsPermissionsFILTERENTITYREAD                      UserRoleWithPermissionsPermissions = "FILTER_ENTITY_READ"
	UserRoleWithPermissionsPermissionsHANDOVERCONTAINERREAD                 UserRoleWithPermissionsPermissions = "HANDOVER_CONTAINER_READ"
	UserRoleWithPermissionsPermissionsHANDOVERCONTAINERWRITE                UserRoleWithPermissionsPermissions = "HANDOVER_CONTAINER_WRITE"
	UserRoleWithPermissionsPermissionsHANDOVERJOBREAD                       UserRoleWithPermissionsPermissions = "HANDOVERJOB_READ"
	UserRoleWithPermissionsPermissionsHANDOVERJOBWRITE                      UserRoleWithPermissionsPermissions = "HANDOVERJOB_WRITE"
	UserRoleWithPermissionsPermissionsINBOUNDPROCESSREAD                    UserRoleWithPermissionsPermissions = "INBOUND_PROCESS_READ"
	UserRoleWithPermissionsPermissionsINBOUNDPROCESSWRITE                   UserRoleWithPermissionsPermissions = "INBOUND_PROCESS_WRITE"
	UserRoleWithPermissionsPermissionsKPIREAD                               UserRoleWithPermissionsPermissions = "KPI_READ"
	UserRoleWithPermissionsPermissionsLINEITEMADD                           UserRoleWithPermissionsPermissions = "LINE_ITEM_ADD"
	UserRoleWithPermissionsPermissionsLINEITEMDELETE                        UserRoleWithPermissionsPermissions = "LINE_ITEM_DELETE"
	UserRoleWithPermissionsPermissionsLINEITEMPRICINGREAD                   UserRoleWithPermissionsPermissions = "LINE_ITEM_PRICING_READ"
	UserRoleWithPermissionsPermissionsLINEITEMQUANTITYDECREASE              UserRoleWithPermissionsPermissions = "LINE_ITEM_QUANTITY_DECREASE"
	UserRoleWithPermissionsPermissionsLINEITEMQUANTITYINCREASE              UserRoleWithPermissionsPermissions = "LINE_ITEM_QUANTITY_INCREASE"
	UserRoleWithPermissionsPermissionsLINKEDSERVICEJOBSREAD                 UserRoleWithPermissionsPermissions = "LINKED_SERVICE_JOBS_READ"
	UserRoleWithPermissionsPermissionsLINKEDSERVICEJOBSWRITE                UserRoleWithPermissionsPermissions = "LINKED_SERVICE_JOBS_WRITE"
	UserRoleWithPermissionsPermissionsLISTINGDELETE                         UserRoleWithPermissionsPermissions = "LISTING_DELETE"
	UserRoleWithPermissionsPermissionsLISTINGREAD                           UserRoleWithPermissionsPermissions = "LISTING_READ"
	UserRoleWithPermissionsPermissionsLISTINGWRITE                          UserRoleWithPermissionsPermissions = "LISTING_WRITE"
	UserRoleWithPermissionsPermissionsLOADUNITREAD                          UserRoleWithPermissionsPermissions = "LOADUNIT_READ"
	UserRoleWithPermissionsPermissionsLOADUNITTYPEREAD                      UserRoleWithPermissionsPermissions = "LOADUNITTYPE_READ"
	UserRoleWithPermissionsPermissionsLOADUNITTYPEWRITE                     UserRoleWithPermissionsPermissions = "LOADUNITTYPE_WRITE"
	UserRoleWithPermissionsPermissionsLOADUNITWRITE                         UserRoleWithPermissionsPermissions = "LOADUNIT_WRITE"
	UserRoleWithPermissionsPermissionsLOCALEWRITE                           UserRoleWithPermissionsPermissions = "LOCALE_WRITE"
	UserRoleWithPermissionsPermissionsLOOKUPRECORDREAD                      UserRoleWithPermissionsPermissions = "LOOKUP_RECORD_READ"
	UserRoleWithPermissionsPermissionsLOOKUPRECORDWRITE                     UserRoleWithPermissionsPermissions = "LOOKUP_RECORD_WRITE"
	UserRoleWithPermissionsPermissionsMEASUREMENTUNITREAD                   UserRoleWithPermissionsPermissions = "MEASUREMENTUNIT_READ"
	UserRoleWithPermissionsPermissionsMEASUREMENTUNITWRITE                  UserRoleWithPermissionsPermissions = "MEASUREMENTUNIT_WRITE"
	UserRoleWithPermissionsPermissionsNOTIFICATIONCENTERCONFIGREAD          UserRoleWithPermissionsPermissions = "NOTIFICATION_CENTER_CONFIG_READ"
	UserRoleWithPermissionsPermissionsNOTIFICATIONCENTERCONFIGWRITE         UserRoleWithPermissionsPermissions = "NOTIFICATION_CENTER_CONFIG_WRITE"
	UserRoleWithPermissionsPermissionsNOTIFICATIONREAD                      UserRoleWithPermissionsPermissions = "NOTIFICATION_READ"
	UserRoleWithPermissionsPermissionsNOTIFICATIONWRITE                     UserRoleWithPermissionsPermissions = "NOTIFICATION_WRITE"
	UserRoleWithPermissionsPermissionsOIDCPROVIDERSCONFIGREAD               UserRoleWithPermissionsPermissions = "OIDC_PROVIDERS_CONFIG_READ"
	UserRoleWithPermissionsPermissionsOIDCPROVIDERSCONFIGWRITE              UserRoleWithPermissionsPermissions = "OIDC_PROVIDERS_CONFIG_WRITE"
	UserRoleWithPermissionsPermissionsOPERATIONSTATISTICSREAD               UserRoleWithPermissionsPermissions = "OPERATION_STATISTICS_READ"
	UserRoleWithPermissionsPermissionsOPERATIVEPROCESSREAD                  UserRoleWithPermissionsPermissions = "OPERATIVE_PROCESS_READ"
	UserRoleWithPermissionsPermissionsOPERATIVEPROCESSWRITE                 UserRoleWithPermissionsPermissions = "OPERATIVE_PROCESS_WRITE"
	UserRoleWithPermissionsPermissionsORDERCANCEL                           UserRoleWithPermissionsPermissions = "ORDER_CANCEL"
	UserRoleWithPermissionsPermissionsORDERCONSUMERWRITE                    UserRoleWithPermissionsPermissions = "ORDER_CONSUMER_WRITE"
	UserRoleWithPermissionsPermissionsORDERCUSTOMATTRIBUTESWRITE            UserRoleWithPermissionsPermissions = "ORDER_CUSTOM_ATTRIBUTES_WRITE"
	UserRoleWithPermissionsPermissionsORDERDELIVERYPROMISEWRITE             UserRoleWithPermissionsPermissions = "ORDER_DELIVERY_PROMISE_WRITE"
	UserRoleWithPermissionsPermissionsORDERFORCECANCEL                      UserRoleWithPermissionsPermissions = "ORDER_FORCE_CANCEL"
	UserRoleWithPermissionsPermissionsORDERLINEITEMWRITE                    UserRoleWithPermissionsPermissions = "ORDER_LINEITEM_WRITE"
	UserRoleWithPermissionsPermissionsORDERREAD                             UserRoleWithPermissionsPermissions = "ORDER_READ"
	UserRoleWithPermissionsPermissionsORDERRECORDREAD                       UserRoleWithPermissionsPermissions = "ORDER_RECORD_READ"
	UserRoleWithPermissionsPermissionsORDERRECORDWRITE                      UserRoleWithPermissionsPermissions = "ORDER_RECORD_WRITE"
	UserRoleWithPermissionsPermissionsORDERTOTALREAD                        UserRoleWithPermissionsPermissions = "ORDER_TOTAL_READ"
	UserRoleWithPermissionsPermissionsORDERUNLOCK                           UserRoleWithPermissionsPermissions = "ORDER_UNLOCK"
	UserRoleWithPermissionsPermissionsORDERWRITE                            UserRoleWithPermissionsPermissions = "ORDER_WRITE"
	UserRoleWithPermissionsPermissionsPACKAGINGUNITSREAD                    UserRoleWithPermissionsPermissions = "PACKAGING_UNITS_READ"
	UserRoleWithPermissionsPermissionsPACKAGINGUNITSWRITE                   UserRoleWithPermissionsPermissions = "PACKAGING_UNITS_WRITE"
	UserRoleWithPermissionsPermissionsPACKINGCONTAINERTYPEWRITE             UserRoleWithPermissionsPermissions = "PACKINGCONTAINER_TYPE_WRITE"
	UserRoleWithPermissionsPermissionsPACKINGSOURCECONTAINERREAD            UserRoleWithPermissionsPermissions = "PACKING_SOURCE_CONTAINER_READ"
	UserRoleWithPermissionsPermissionsPACKINGSOURCECONTAINERWRITE           UserRoleWithPermissionsPermissions = "PACKING_SOURCE_CONTAINER_WRITE"
	UserRoleWithPermissionsPermissionsPACKJOBREAD                           UserRoleWithPermissionsPermissions = "PACKJOB_READ"
	UserRoleWithPermissionsPermissionsPACKJOBWRITE                          UserRoleWithPermissionsPermissions = "PACKJOB_WRITE"
	UserRoleWithPermissionsPermissionsPARCELREAD                            UserRoleWithPermissionsPermissions = "PARCEL_READ"
	UserRoleWithPermissionsPermissionsPARCELWRITE                           UserRoleWithPermissionsPermissions = "PARCEL_WRITE"
	UserRoleWithPermissionsPermissionsPERMISSIONREAD                        UserRoleWithPermissionsPermissions = "PERMISSION_READ"
	UserRoleWithPermissionsPermissionsPICKJOBREAD                           UserRoleWithPermissionsPermissions = "PICKJOB_READ"
	UserRoleWithPermissionsPermissionsPICKJOBREROUTE                        UserRoleWithPermissionsPermissions = "PICKJOB_REROUTE"
	UserRoleWithPermissionsPermissionsPICKJOBWRITE                          UserRoleWithPermissionsPermissions = "PICKJOB_WRITE"
	UserRoleWithPermissionsPermissionsPICKRUNREAD                           UserRoleWithPermissionsPermissions = "PICKRUN_READ"
	UserRoleWithPermissionsPermissionsPICKRUNWRITE                          UserRoleWithPermissionsPermissions = "PICKRUN_WRITE"
	UserRoleWithPermissionsPermissionsPICKUPSERVICEREAD                     UserRoleWithPermissionsPermissions = "PICKUP_SERVICE_READ"
	UserRoleWithPermissionsPermissionsPICKUPSERVICEWRITE                    UserRoleWithPermissionsPermissions = "PICKUP_SERVICE_WRITE"
	UserRoleWithPermissionsPermissionsPROCESSLOGREAD                        UserRoleWithPermissionsPermissions = "PROCESS_LOG_READ"
	UserRoleWithPermissionsPermissionsPROCESSREAD                           UserRoleWithPermissionsPermissions = "PROCESS_READ"
	UserRoleWithPermissionsPermissionsPROCESSREROUTE                        UserRoleWithPermissionsPermissions = "PROCESS_REROUTE"
	UserRoleWithPermissionsPermissionsPROCESSWRITE                          UserRoleWithPermissionsPermissions = "PROCESS_WRITE"
	UserRoleWithPermissionsPermissionsPROMISESCONFIGREAD                    UserRoleWithPermissionsPermissions = "PROMISES_CONFIG_READ"
	UserRoleWithPermissionsPermissionsPROMISESCONFIGWRITE                   UserRoleWithPermissionsPermissions = "PROMISES_CONFIG_WRITE"
	UserRoleWithPermissionsPermissionsPURCHASEPRICEREAD                     UserRoleWithPermissionsPermissions = "PURCHASE_PRICE_READ"
	UserRoleWithPermissionsPermissionsREMOTECONFIGREAD                      UserRoleWithPermissionsPermissions = "REMOTE_CONFIG_READ"
	UserRoleWithPermissionsPermissionsREMOTECONFIGWRITE                     UserRoleWithPermissionsPermissions = "REMOTE_CONFIG_WRITE"
	UserRoleWithPermissionsPermissionsRESERVATIONREAD                       UserRoleWithPermissionsPermissions = "RESERVATION_READ"
	UserRoleWithPermissionsPermissionsRESERVATIONWRITE                      UserRoleWithPermissionsPermissions = "RESERVATION_WRITE"
	UserRoleWithPermissionsPermissionsRESTOWITEMREAD                        UserRoleWithPermissionsPermissions = "RESTOW_ITEM_READ"
	UserRoleWithPermissionsPermissionsRESTOWITEMWRITE                       UserRoleWithPermissionsPermissions = "RESTOW_ITEM_WRITE"
	UserRoleWithPermissionsPermissionsRETURNREAD                            UserRoleWithPermissionsPermissions = "RETURN_READ"
	UserRoleWithPermissionsPermissionsRETURNWRITE                           UserRoleWithPermissionsPermissions = "RETURN_WRITE"
	UserRoleWithPermissionsPermissionsROLEREAD                              UserRoleWithPermissionsPermissions = "ROLE_READ"
	UserRoleWithPermissionsPermissionsROLEWRITE                             UserRoleWithPermissionsPermissions = "ROLE_WRITE"
	UserRoleWithPermissionsPermissionsROUTINGCONFIGREAD                     UserRoleWithPermissionsPermissions = "ROUTING_CONFIG_READ"
	UserRoleWithPermissionsPermissionsROUTINGCONFIGWRITE                    UserRoleWithPermissionsPermissions = "ROUTING_CONFIG_WRITE"
	UserRoleWithPermissionsPermissionsROUTINGREAD                           UserRoleWithPermissionsPermissions = "ROUTING_READ"
	UserRoleWithPermissionsPermissionsROUTINGWRITE                          UserRoleWithPermissionsPermissions = "ROUTING_WRITE"
	UserRoleWithPermissionsPermissionsSAFETYSTOCKREAD                       UserRoleWithPermissionsPermissions = "SAFETY_STOCK_READ"
	UserRoleWithPermissionsPermissionsSAFETYSTOCKWRITE                      UserRoleWithPermissionsPermissions = "SAFETY_STOCK_WRITE"
	UserRoleWithPermissionsPermissionsSERVICEJOBREAD                        UserRoleWithPermissionsPermissions = "SERVICE_JOB_READ"
	UserRoleWithPermissionsPermissionsSERVICEJOBWRITE                       UserRoleWithPermissionsPermissions = "SERVICE_JOB_WRITE"
	UserRoleWithPermissionsPermissionsSHIPMENTREAD                          UserRoleWithPermissionsPermissions = "SHIPMENT_READ"
	UserRoleWithPermissionsPermissionsSHIPMENTWRITE                         UserRoleWithPermissionsPermissions = "SHIPMENT_WRITE"
	UserRoleWithPermissionsPermissionsSIMULATIONORDERREAD                   UserRoleWithPermissionsPermissions = "SIMULATION_ORDER_READ"
	UserRoleWithPermissionsPermissionsSIMULATIONORDERWRITE                  UserRoleWithPermissionsPermissions = "SIMULATION_ORDER_WRITE"
	UserRoleWithPermissionsPermissionsSTACKSREAD                            UserRoleWithPermissionsPermissions = "STACKS_READ"
	UserRoleWithPermissionsPermissionsSTACKSWRITE                           UserRoleWithPermissionsPermissions = "STACKS_WRITE"
	UserRoleWithPermissionsPermissionsSTOCKAVAILABILITIESREAD               UserRoleWithPermissionsPermissions = "STOCK_AVAILABILITIES_READ"
	UserRoleWithPermissionsPermissionsSTOCKREAD                             UserRoleWithPermissionsPermissions = "STOCK_READ"
	UserRoleWithPermissionsPermissionsSTOCKWRITE                            UserRoleWithPermissionsPermissions = "STOCK_WRITE"
	UserRoleWithPermissionsPermissionsSTORAGELOCATIONREAD                   UserRoleWithPermissionsPermissions = "STORAGE_LOCATION_READ"
	UserRoleWithPermissionsPermissionsSTORAGELOCATIONWRITE                  UserRoleWithPermissionsPermissions = "STORAGE_LOCATION_WRITE"
	UserRoleWithPermissionsPermissionsSTOWJOBFULLWRITE                      UserRoleWithPermissionsPermissions = "STOW_JOB_FULL_WRITE"
	UserRoleWithPermissionsPermissionsSTOWJOBOPERATIVEWRITE                 UserRoleWithPermissionsPermissions = "STOW_JOB_OPERATIVE_WRITE"
	UserRoleWithPermissionsPermissionsSTOWJOBREAD                           UserRoleWithPermissionsPermissions = "STOW_JOB_READ"
	UserRoleWithPermissionsPermissionsSUBSCRIPTIONREAD                      UserRoleWithPermissionsPermissions = "SUBSCRIPTION_READ"
	UserRoleWithPermissionsPermissionsSUBSCRIPTIONWRITE                     UserRoleWithPermissionsPermissions = "SUBSCRIPTION_WRITE"
	UserRoleWithPermissionsPermissionsSUBSTITUTEREAD                        UserRoleWithPermissionsPermissions = "SUBSTITUTE_READ"
	UserRoleWithPermissionsPermissionsSUBSTITUTEWRITE                       UserRoleWithPermissionsPermissions = "SUBSTITUTE_WRITE"
	UserRoleWithPermissionsPermissionsTAGREAD                               UserRoleWithPermissionsPermissions = "TAG_READ"
	UserRoleWithPermissionsPermissionsTAGWRITE                              UserRoleWithPermissionsPermissions = "TAG_WRITE"
	UserRoleWithPermissionsPermissionsTENANTCONNECTORCONFIGREAD             UserRoleWithPermissionsPermissions = "TENANT_CONNECTOR_CONFIG_READ"
	UserRoleWithPermissionsPermissionsUSERMODIFY                            UserRoleWithPermissionsPermissions = "USER_MODIFY"
	UserRoleWithPermissionsPermissionsUSERREAD                              UserRoleWithPermissionsPermissions = "USER_READ"
	UserRoleWithPermissionsPermissionsUSERSREAD                             UserRoleWithPermissionsPermissions = "USERS_READ"
	UserRoleWithPermissionsPermissionsUSERWRITE                             UserRoleWithPermissionsPermissions = "USER_WRITE"
	UserRoleWithPermissionsPermissionsVALIDATIONSREAD                       UserRoleWithPermissionsPermissions = "VALIDATIONS_READ"
	UserRoleWithPermissionsPermissionsWORKFLOWDEFINITIONREAD                UserRoleWithPermissionsPermissions = "WORKFLOW_DEFINITION_READ"
	UserRoleWithPermissionsPermissionsWORKFLOWDEFINITIONWRITE               UserRoleWithPermissionsPermissions = "WORKFLOW_DEFINITION_WRITE"
	UserRoleWithPermissionsPermissionsZONEREAD                              UserRoleWithPermissionsPermissions = "ZONE_READ"
	UserRoleWithPermissionsPermissionsZONEWRITE                             UserRoleWithPermissionsPermissions = "ZONE_WRITE"
)

Defines values for UserRoleWithPermissionsPermissions.

func (UserRoleWithPermissionsPermissions) Valid

Valid indicates whether the value is a known member of the UserRoleWithPermissionsPermissions enum.

type UserSearchPayload

type UserSearchPayload struct {
	// After 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`.
	After *string `json:"after,omitempty"`

	// Before 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).
	Before *string `json:"before,omitempty"`

	// Last Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
	Last *float32 `json:"last,omitempty"`

	// Options SearchOptions
	Options *SearchOptions `json:"options,omitempty"`

	// Query UserSearchQuery
	Query UserSearchQuery `json:"query"`

	// Size Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
	//
	// Example: 10
	Size *float32 `json:"size,omitempty"`

	// Sort Use for sorting the result.
	Sort *[]UserSort `json:"sort,omitempty"`

	// StartAfterId The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	StartAfterId *string `json:"startAfterId,omitempty"`
}

UserSearchPayload UserSearchPayload

type UserSearchQuery

type UserSearchQuery struct {
	And *[]UserSearchQuery `json:"and,omitempty"`

	// AssignedFacilities Nested list search by assignedFacilities
	AssignedFacilities *UserAssignedFacilitiesListFilter `json:"assignedFacilities,omitempty"`

	// AssignedRoles Nested list search by assignedRoles
	AssignedRoles *UserAssignedRolesListFilter `json:"assignedRoles,omitempty"`

	// Auth Nested search by auth
	Auth *UserAuthFilter `json:"auth,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]UserSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// CustomClaims Nested search by customClaims
	CustomClaims *UserCustomClaimsFilter `json:"customClaims,omitempty"`

	// FacilityLimitations Search by facilityLimitations
	FacilityLimitations *StringListExistsFilter `json:"facilityLimitations,omitempty"`

	// Firstname Search by firstname
	//
	// Example: Phil
	Firstname *StringSearchFilter `json:"firstname,omitempty"`

	// LastModified Search by lastModified
	LastModified *DateFilter `json:"lastModified,omitempty"`

	// Lastname Search by lastname
	//
	// Example: Bison
	Lastname *StringSearchFilter `json:"lastname,omitempty"`
	Or       *[]UserSearchQuery  `json:"or,omitempty"`

	// Username Search by username
	Username *StringSearchFilter `json:"username,omitempty"`
}

UserSearchQuery UserSearchQuery

type UserSearchQuery_CustomAttributes_AdditionalProperties

type UserSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

UserSearchQuery_CustomAttributes_AdditionalProperties defines model for UserSearchQuery.customAttributes.AdditionalProperties.

func (UserSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (UserSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (UserSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (UserSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*UserSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*UserSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*UserSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*UserSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (UserSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*UserSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*UserSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*UserSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*UserSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the UserSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*UserSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

type UserSort

type UserSort struct {
	// AssignedRoles UserAssignedRolesSort
	AssignedRoles *UserAssignedRolesSort `json:"assignedRoles,omitempty"`

	// AuthenticationProvider UserAuthenticationProviderSort
	AuthenticationProvider *UserAuthenticationProviderSort `json:"authenticationProvider,omitempty"`
	CustomAttributes       *map[string]interface{}         `json:"customAttributes,omitempty"`
	Firstname              *UserSortFirstname              `json:"firstname,omitempty"`
	LastLogin              *UserSortLastLogin              `json:"lastLogin,omitempty"`
	Lastname               *UserSortLastname               `json:"lastname,omitempty"`
	Username               *UserSortUsername               `json:"username,omitempty"`
}

UserSort UserSort

type UserSortFirstname

type UserSortFirstname string

UserSortFirstname defines model for UserSort.Firstname.

const (
	UserSortFirstnameASC  UserSortFirstname = "ASC"
	UserSortFirstnameDESC UserSortFirstname = "DESC"
)

Defines values for UserSortFirstname.

func (UserSortFirstname) Valid

func (e UserSortFirstname) Valid() bool

Valid indicates whether the value is a known member of the UserSortFirstname enum.

type UserSortLastLogin

type UserSortLastLogin string

UserSortLastLogin defines model for UserSort.LastLogin.

const (
	UserSortLastLoginASC  UserSortLastLogin = "ASC"
	UserSortLastLoginDESC UserSortLastLogin = "DESC"
)

Defines values for UserSortLastLogin.

func (UserSortLastLogin) Valid

func (e UserSortLastLogin) Valid() bool

Valid indicates whether the value is a known member of the UserSortLastLogin enum.

type UserSortLastname

type UserSortLastname string

UserSortLastname defines model for UserSort.Lastname.

const (
	UserSortLastnameASC  UserSortLastname = "ASC"
	UserSortLastnameDESC UserSortLastname = "DESC"
)

Defines values for UserSortLastname.

func (UserSortLastname) Valid

func (e UserSortLastname) Valid() bool

Valid indicates whether the value is a known member of the UserSortLastname enum.

type UserSortUsername

type UserSortUsername string

UserSortUsername defines model for UserSort.Username.

const (
	UserSortUsernameASC  UserSortUsername = "ASC"
	UserSortUsernameDESC UserSortUsername = "DESC"
)

Defines values for UserSortUsername.

func (UserSortUsername) Valid

func (e UserSortUsername) Valid() bool

Valid indicates whether the value is a known member of the UserSortUsername enum.

type VersionedResource

type VersionedResource struct {
	// Created The date this entity was created at the platform. This value is generated by the service.
	//
	// Example: 2020-02-03T08:45:51.525Z
	Created *time.Time `json:"created,omitempty"`

	// LastModified The date this entity was modified last. This value is generated by the service.
	//
	// Example: 2020-02-03T09:45:51.525Z
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Version The version of the document to be used in optimistic locking mechanisms.
	//
	// Example: 42
	Version int64 `json:"version"`
}

VersionedResource VersionedResource

type VersionlessUpdateStock

type VersionlessUpdateStock struct {
	Name VersionlessUpdateStockName `json:"name"`

	// Stocks Please be sure to include each stock (by ID) only once, when updating. Otherwise the whole batch is rejected with an error.
	Stocks []VersionlessUpdateStock_Stocks_Item `json:"stocks"`
}

VersionlessUpdateStock VersionlessUpdateStock

type VersionlessUpdateStockName

type VersionlessUpdateStockName string

VersionlessUpdateStockName defines model for VersionlessUpdateStock.Name.

const (
	VersionlessUpdateStockNameUPDATEVERSIONLESS VersionlessUpdateStockName = "UPDATE_VERSIONLESS"
)

Defines values for VersionlessUpdateStockName.

func (VersionlessUpdateStockName) Valid

func (e VersionlessUpdateStockName) Valid() bool

Valid indicates whether the value is a known member of the VersionlessUpdateStockName enum.

type VersionlessUpdateStock_Stocks_Item

type VersionlessUpdateStock_Stocks_Item struct {
	// contains filtered or unexported fields
}

VersionlessUpdateStock_Stocks_Item defines model for VersionlessUpdateStock.stocks.Item.

func (VersionlessUpdateStock_Stocks_Item) AsStockForCreationVersionless

func (t VersionlessUpdateStock_Stocks_Item) AsStockForCreationVersionless() (StockForCreationVersionless, error)

AsStockForCreationVersionless returns the union data inside the VersionlessUpdateStock_Stocks_Item as a StockForCreationVersionless

func (VersionlessUpdateStock_Stocks_Item) AsStockForUpdateVersionless

func (t VersionlessUpdateStock_Stocks_Item) AsStockForUpdateVersionless() (StockForUpdateVersionless, error)

AsStockForUpdateVersionless returns the union data inside the VersionlessUpdateStock_Stocks_Item as a StockForUpdateVersionless

func (VersionlessUpdateStock_Stocks_Item) Discriminator

func (t VersionlessUpdateStock_Stocks_Item) Discriminator() (string, error)

func (*VersionlessUpdateStock_Stocks_Item) FromStockForCreationVersionless

func (t *VersionlessUpdateStock_Stocks_Item) FromStockForCreationVersionless(v StockForCreationVersionless) error

FromStockForCreationVersionless overwrites any union data inside the VersionlessUpdateStock_Stocks_Item as the provided StockForCreationVersionless

func (*VersionlessUpdateStock_Stocks_Item) FromStockForUpdateVersionless

func (t *VersionlessUpdateStock_Stocks_Item) FromStockForUpdateVersionless(v StockForUpdateVersionless) error

FromStockForUpdateVersionless overwrites any union data inside the VersionlessUpdateStock_Stocks_Item as the provided StockForUpdateVersionless

func (VersionlessUpdateStock_Stocks_Item) MarshalJSON

func (t VersionlessUpdateStock_Stocks_Item) MarshalJSON() ([]byte, error)

func (*VersionlessUpdateStock_Stocks_Item) MergeStockForCreationVersionless

func (t *VersionlessUpdateStock_Stocks_Item) MergeStockForCreationVersionless(v StockForCreationVersionless) error

MergeStockForCreationVersionless performs a merge with any union data inside the VersionlessUpdateStock_Stocks_Item, using the provided StockForCreationVersionless

func (*VersionlessUpdateStock_Stocks_Item) MergeStockForUpdateVersionless

func (t *VersionlessUpdateStock_Stocks_Item) MergeStockForUpdateVersionless(v StockForUpdateVersionless) error

MergeStockForUpdateVersionless performs a merge with any union data inside the VersionlessUpdateStock_Stocks_Item, using the provided StockForUpdateVersionless

func (*VersionlessUpdateStock_Stocks_Item) UnmarshalJSON

func (t *VersionlessUpdateStock_Stocks_Item) UnmarshalJSON(b []byte) error

func (VersionlessUpdateStock_Stocks_Item) ValueByDiscriminator

func (t VersionlessUpdateStock_Stocks_Item) ValueByDiscriminator() (interface{}, error)

type WeekDay

type WeekDay string

WeekDay A weekday

const (
	WeekDayFRIDAY    WeekDay = "FRIDAY"
	WeekDayMONDAY    WeekDay = "MONDAY"
	WeekDaySATURDAY  WeekDay = "SATURDAY"
	WeekDaySUNDAY    WeekDay = "SUNDAY"
	WeekDayTHURSDAY  WeekDay = "THURSDAY"
	WeekDayTUESDAY   WeekDay = "TUESDAY"
	WeekDayWEDNESDAY WeekDay = "WEDNESDAY"
)

Defines values for WeekDay.

func (WeekDay) Valid

func (e WeekDay) Valid() bool

Valid indicates whether the value is a known member of the WeekDay enum.

type WorkflowInformation added in v0.3.0

type WorkflowInformation struct {
	// InstanceRef The ID identifying the workflow instance this entity belongs to.
	//
	// Example: 64c13ab08edf48a008793cac
	InstanceRef *string `json:"instanceRef,omitempty"`

	// IsAvailable Explicitly states if this entity is part of a workflow.
	IsAvailable *WorkflowInformationIsAvailable `json:"isAvailable,omitempty"`

	// NodeRef The ID identifying the node within the workflow instance tha this entity belongs to.
	NodeRef *string `json:"nodeRef,omitempty"`
}

WorkflowInformation WorkflowInformation

type WorkflowInformationIsAvailable added in v0.3.0

type WorkflowInformationIsAvailable bool

WorkflowInformationIsAvailable Explicitly states if this entity is part of a workflow.

Defines values for WorkflowInformationIsAvailable.

func (WorkflowInformationIsAvailable) Valid added in v0.3.0

Valid indicates whether the value is a known member of the WorkflowInformationIsAvailable enum.

type WorkflowSearchQuery

type WorkflowSearchQuery struct {
	And *[]WorkflowSearchQuery `json:"and,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// IsActive Search by isActive
	IsActive *BooleanFilter `json:"isActive,omitempty"`

	// Name Search by name
	Name *LocalizedStringSearchFilter `json:"name,omitempty"`
	Or   *[]WorkflowSearchQuery       `json:"or,omitempty"`

	// TenantWorkflowId Search by tenantWorkflowId
	//
	// Example: MY_WORKFLOW_ID
	TenantWorkflowId *StringFilter `json:"tenantWorkflowId,omitempty"`
}

WorkflowSearchQuery WorkflowSearchQuery

type WorkflowUnavailable added in v0.3.0

type WorkflowUnavailable struct {
	// IsAvailable Explicitly states if this entity is part of a workflow.
	IsAvailable *WorkflowUnavailableIsAvailable `json:"isAvailable,omitempty"`
}

WorkflowUnavailable WorkflowUnavailable

type WorkflowUnavailableIsAvailable added in v0.3.0

type WorkflowUnavailableIsAvailable bool

WorkflowUnavailableIsAvailable Explicitly states if this entity is part of a workflow.

Defines values for WorkflowUnavailableIsAvailable.

func (WorkflowUnavailableIsAvailable) Valid added in v0.3.0

Valid indicates whether the value is a known member of the WorkflowUnavailableIsAvailable enum.

type ZoneSearchQuery

type ZoneSearchQuery struct {
	And *[]ZoneSearchQuery `json:"and,omitempty"`

	// CustomAttributes Search by custom attributes
	CustomAttributes *map[string]ZoneSearchQuery_CustomAttributes_AdditionalProperties `json:"customAttributes,omitempty"`

	// FacilityRef Search by facilityRef
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	FacilityRef *StringFilter `json:"facilityRef,omitempty"`

	// Id Search by id
	//
	// Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
	Id *StringFilter `json:"id,omitempty"`

	// Name Search by name
	Name *StringFilter      `json:"name,omitempty"`
	Or   *[]ZoneSearchQuery `json:"or,omitempty"`
}

ZoneSearchQuery ZoneSearchQuery

type ZoneSearchQuery_CustomAttributes_AdditionalProperties

type ZoneSearchQuery_CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

ZoneSearchQuery_CustomAttributes_AdditionalProperties defines model for ZoneSearchQuery.customAttributes.AdditionalProperties.

func (ZoneSearchQuery_CustomAttributes_AdditionalProperties) AsBooleanFilter

AsBooleanFilter returns the union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties as a BooleanFilter

func (ZoneSearchQuery_CustomAttributes_AdditionalProperties) AsDateFilter

AsDateFilter returns the union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties as a DateFilter

func (ZoneSearchQuery_CustomAttributes_AdditionalProperties) AsNumberEqFilter

AsNumberEqFilter returns the union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties as a NumberEqFilter

func (ZoneSearchQuery_CustomAttributes_AdditionalProperties) AsStringEqFilter

AsStringEqFilter returns the union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties as a StringEqFilter

func (*ZoneSearchQuery_CustomAttributes_AdditionalProperties) FromBooleanFilter

FromBooleanFilter overwrites any union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties as the provided BooleanFilter

func (*ZoneSearchQuery_CustomAttributes_AdditionalProperties) FromDateFilter

FromDateFilter overwrites any union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties as the provided DateFilter

func (*ZoneSearchQuery_CustomAttributes_AdditionalProperties) FromNumberEqFilter

FromNumberEqFilter overwrites any union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties as the provided NumberEqFilter

func (*ZoneSearchQuery_CustomAttributes_AdditionalProperties) FromStringEqFilter

FromStringEqFilter overwrites any union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties as the provided StringEqFilter

func (ZoneSearchQuery_CustomAttributes_AdditionalProperties) MarshalJSON

func (*ZoneSearchQuery_CustomAttributes_AdditionalProperties) MergeBooleanFilter

MergeBooleanFilter performs a merge with any union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties, using the provided BooleanFilter

func (*ZoneSearchQuery_CustomAttributes_AdditionalProperties) MergeDateFilter

MergeDateFilter performs a merge with any union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties, using the provided DateFilter

func (*ZoneSearchQuery_CustomAttributes_AdditionalProperties) MergeNumberEqFilter

MergeNumberEqFilter performs a merge with any union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties, using the provided NumberEqFilter

func (*ZoneSearchQuery_CustomAttributes_AdditionalProperties) MergeStringEqFilter

MergeStringEqFilter performs a merge with any union data inside the ZoneSearchQuery_CustomAttributes_AdditionalProperties, using the provided StringEqFilter

func (*ZoneSearchQuery_CustomAttributes_AdditionalProperties) UnmarshalJSON

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL