- Introduction to our API
- User
- Client
- User
- Schemas
- AssignUserRoleDto
- BulkResponse
- BulkResponseItem
- ClientTokenResponseDTO
- ConflictErrorResponse
- CreateInvitationDto
- CreateInvitationDtoBulkModel
- CreateInvitationResponse
- CreateRoleDTO
- CreateServiceClientDto
- CreateServiceClientResponseDTO
- CreateUserDto
- CreateVendorInvitationDto
- CreateVendorInvitationDtoBulkModel
- CreateVendorInvitationResponse
- DeleteInvitationResponse
- DeleteVendorInvitationResponse
- Error
- ExternalErrorResponse
- ForbiddenErrorResponse
- ForgotPasswordDTO
- FutureAssociationsDTO
- GetInvitationResponse
- GetInvitationsByMerchantIdResponse
- GetInvitationsByMerchantIdResponseDto
- GetServiceClientTokenDto
- GetVendorInvitationResponse
- GetVendorInvitationsByVendorIdResponse
- GetVendorInvitationsByVendorIdResponseDto
- InvitationDeliveryMethodEnum
- InvitationDeliveryResponse
- InvitationStatusEnum
- InvitationsByMerchantIdSortByEnum
- LoginUserDto
- LoginUserWithAuthorizationCode
- LoginUserWithRefreshToken
- NotFoundErrorResponse
- OnboardUserDto
- PasswordPolicyDTO
- PatchUserDTO
- PermissionDTO
- PermissionSet
- PermissionSetsRequestDTO
- PermissionSetsResponseDTO
- ProblemDetails
- ResendInvitationResponse
- ResendVendorInvitationResponse
- ResetPasswordDTO
- ResourceDTO
- RoleDTO
- RolePermissionDTO
- RoleWithPermissionDTO
- SearchRolesEnum
- SearchRolesResponseDTO
- SearchUsersEnum
- SearchUsersResponseDTO
- ServiceClientResponseDTO
- StringBulkModel
- TokenResponseDTO
- UnassignUserRoleDTO
- UnauthorizedErrorResponse
- UnauthorizedResult
- UnhandledErrorResponse
- UpdateAssociationTypeDTO
- UpdateAttributesDto
- UpdateRoleDTO
- UpdateRolePermissionsDTO
- UserResponseDTO
- ValidateEmailsResponse
- ValidationErrorResponse
- ValidationResponseDTO
- Order
- OrderItems
- Orders
- Create a New Order.
- Search for orders based on various criteria and filters.
- Create multiple orders
- Retrieve multiple orders
- Update multiple orders
- Retrieve a list of orders
- Retrieve an order by Order ID.
- Update order data.
- Retrieve an order by Safe ID
- Retrieve order item by Order Item ID
- Update an item within an order.
- Cancel Order or order items
- Change the order status to Customer Care Hold
- Place a manual hold on an order
- Add time to an active manual hold
- Release a manual hold and let the order carry on
- Retrieve audit logs for a specific order.
- Retrieve audit logs for a specific order.
- Retrieve audit logs for a specific order item.
- Add a Refund Request.
- Schemas
- APIClientInfoModel
- AddRefundItemModel
- AddRefundModel
- AddressModel
- AttributeModel
- BaseAddressModel
- BillingInfoModel
- BulkResponse
- BulkResponseItem
- CancelOrderItemModel
- CancelOrderModel
- CancelOrderResponse
- ConflictErrorResponse
- CoordinatesModel
- CreateOrderCustomerPaymentMethodModel
- CreateOrderCustomerTransactionModel
- CreateOrderItemImageModel
- CreateOrderItemModel
- CreateOrderModel
- CreateOrderModelBulkModel
- CreateOrderResponse
- CustomerCareHoldOrderResponse
- Error
- EvaluateRedactionModel
- EvaluateRedactionResponse
- EvaluateRedactionResultModel
- ForbiddenErrorResponse
- FulfillmentHoldResponse
- GateVerdictModel
- GetAuditLogResponse
- GetOrderCustomerPaymentMethodModel
- GetOrderCustomerTransactionModel
- GetOrderItemImageModel
- GetOrderItemModel
- GetOrderItemRefundDataItemModel
- GetOrderItemRefundDataModel
- GetOrderItemResponse
- GetOrderModel
- GetOrderResponse
- GetOrdersCountByStatusResponse
- GetOrdersPollingStoppedCountResponse
- GetRedactionCandidatesResponse
- GetRedactionCountersResponse
- GetRedactionEligibilityResponse
- InsertModel
- ListOrderModel
- ListOrdersResponse
- ManualHoldModel
- ManualHoldResponse
- NotFoundErrorResponse
- OptionModel
- OrderItemStatus
- OrderStatus
- OrdersCountByStatus
- PriceModel
- ProcessingLockModel
- RedactionCandidateModel
- RefreshProcessingModel
- RefreshProcessingResponse
- ReprintCostCoverageModel
- ReprintModel
- ReprintShipmentItemModel
- ReprintShipmentModel
- ResourceFormat
- SearchOrderItemsResponse
- SearchOrderModel
- SearchOrdersResponse
- ShipmentMetadata
- StartProcessingModel
- StartProcessingResponse
- StringAuditEvent
- UnauthorizedResult
- UnhandledErrorResponse
- UpdateOrderItemImageModel
- UpdateOrderItemModel
- UpdateOrderItemResponse
- UpdateOrderModel
- UpdateOrderModelBulkModel
- UpdateOrderResponse
- UpdatePriceModel
- ValidationErrorResponse
- VariantAttribute
- VariantOption
- Note
- Notes
- Schemas
- CreateNoteModel
- CreateNoteReponse
- Error
- ForbiddenErrorResponse
- GetAuditLogResponse
- GetNoteByIdResponse
- GetNoteResponseItemModel
- GetNotesResponse
- NotFoundErrorResponse
- ResourceFormat
- ResourceReferenceModel
- StringAuditEvent
- UnauthorizedResult
- UnhandledErrorResponse
- UpdateNotePayload
- UpdateNoteResponse
- UserReferenceModel
- ValidationErrorResponse
- Catalog
- Categories
- MerchantCatalog
- Create a merchant catalog
- Update a merchant catalog
- Partially update a merchant catalog
- Get a list of merchant catalogs
- Delete a merchant catalog
- Get a merchant catalog and search variants in it
- Get a merchant catalog with variants
- Get a list of variants the merchant can use in accordance with their enabled catalog
- Search for variants in enabled merchant catalog with fallback to global catalog
- Get audit logs of a merchant catalog
- Products
- Variants
- MerchantVariants
- Schemas
- AddMerchantVariantsDto
- AddMerchantVariantsResponse
- BulkResponse
- BulkResponseItem
- Category
- CategoryGetChangesResponse
- CategoryModel
- CreateCategoryModel
- CreateCategoryResponse
- CreateMerchantCatalogDto
- CreateMerchantCatalogResponse
- CreatePrintMethodDto
- CreatePrintMethodResponse
- CreateProductModel
- CreateProductModelBulkModel
- CreateProductResponse
- CreateShippingGroupDto
- CreateShippingGroupResponse
- CreateVariantModel
- CreateVariantResult
- DecorationModel
- DeleteMerchantVariantsDto
- DeleteMerchantVariantsResponse
- Error
- ForbiddenErrorResponse
- GetAuditLogResponse
- GetCategoriesResponse
- GetEffectiveProductsResponse
- GetEffectiveVariantListResponse
- GetEffectiveVariantsByProductResponse
- GetPrintMethodResponse
- GetPrintMethodsResponse
- GetProductVariantsResponse
- GetProductsResponse
- GetShippingGroupResponse
- GetShippingGroupsBySkusDto
- GetShippingGroupsBySkusResponse
- ListMerchantCatalogsResponse
- ListShippingGroupsResponse
- MerchantCatalogDto
- MerchantVariantAttributeDto
- MerchantVariantDto
- Meta
- MultiPrice
- PrintMethod
- MultiPriceModel
- NotFoundErrorResponse
- PatchMerchantCatalogDto
- PatchMerchantCatalogResponse
- Price
- PriceModel
- PrintImageModel
- PrintImageUploadStatus
- PrintMethodDto
- ProblemDetails
- Product
- ProductAttribute
- ProductAttributeModel
- ProductAttributeValue
- ProductAttributeValueModel
- ProductExtra
- ProductExtraModel
- ProductGetChangesResponse
- ProductModel
- ProductStatus
- ReorderShippingGroupsDto
- ReorderShippingGroupsResponse
- ResourceFormat
- SearchEffectiveVariantsDto
- SearchEffectiveVariantsResponse
- SearchEffectiveVariantsSeparateDto
- SearchEffectiveVariantsSeparateResponse
- SearchMerchantCatalogVariantsResponse
- SearchMerchantVariantDto
- SearchProductsResponse
- SearchVariantsModel
- SearchVariantsPagedDto
- SearchVariantsPagedResponse
- SetVariantShippingGroupDto
- SetVariantShippingGroupResponse
- ShippingGroupModel
- StandardAttributeModel
- StringAuditEvent
- VariantExtra
- UnauthorizedResult
- UnhandledErrorResponse
- UpdateCategoryModel
- UpdateMerchantCatalogDto
- UpdateMerchantCatalogResponse
- UpdateMerchantVariantsDto
- UpdateMerchantVariantsResponse
- UpdatePrintMethodDto
- UpdatePrintMethodResponse
- UpdateProductModel
- UpdateProductModelBulkModel
- UpdateProductResponse
- UpdateProductVariantModel
- UpdateProductVariantResponse
- UpdateShippingGroupDto
- UpdateShippingGroupResponse
- ValidationErrorResponse
- Variant
- VariantAttribute
- VariantAttributeModel
- VariantDecoration
- VariantExtraModel
- VariantGetChangesResponse
- VariantModel
- Shipment
- Packing Slip
- Shipments
- Get details of a specific shipment by Shipment ID.
- Update details of a specific shipment by Shipment ID.
- Create packages for a specific shipment.
- Delete shipment with packages.
- Get all shipments for an order by Order ID.
- Create shipment for order, vendor, and order items.
- Get shipment with packages for order and vendor.
- Get shipment details by Order Item ID.
- Update a specific shipment package.
- Delete a specific shipment package.
- Cancel shipment.
- Unassign items to shipment.
- Shipment resubmission to assigned facility.
- Retry outbound polling for a shipment by publishing an OutboundShipmentUpdate event.
- Search shipments.
- Reroute shipment.
- Rejects a shipment.
- Bulk reroute shipments.
- Get shipment audit logs.
- Get package audit logs.
- Get message audit logs for shipment updates.
- Assign Shipment.
- VendorShipments
- Schemas
- AssignDTO
- AssignShipmentResponse
- BulkResponse
- BulkResponseItem
- CancelShipmentDto
- ConflictErrorResponse
- CountryCodes
- CreatePackageDTO
- CreatePackagesResponse
- CreateShipmentDTO
- CreateShipmentResponse
- CurrencyCodes
- Error
- ExternalErrorResponse
- ForbiddenErrorResponse
- GeneratePackingSlipResponse
- GetAuditLogResponse
- GetOrdersCountByFacilityResponse
- GetPackageResponse
- GetShipmentPollingStoppedCountResponse
- GetShipmentsCountByStatusResponse
- GetVendorShipmentsCountByStatusResponse
- LanguageCodes
- NotFoundErrorResponse
- OrderCount
- OrderItem
- OrderItemDTO
- OrderItemImage
- OrderItemImageDTO
- OrderItemStatus
- PackageDTO
- PackageOrderItemDTO
- PackingSlipDto
- Price
- RedactShipmentsDTO
- RedactShipmentsResponse
- Reject
- RejectResponse
- ReprintDTO
- Reroute
- RerouteBulkModel
- RerouteOrderItem
- RerouteResponse
- ResourceFormat
- SearchShipmentModel
- SearchShipmentResponse
- SelectedCarrierShippingServiceMethod
- SelectedCarrierShippingServiceMethodDTO
- SelectedShippingMapping
- SelectedShippingMappingDTO
- SelectedShippingMappingMethod
- SelectedShippingMappingMethodDTO
- SelectedVendorMapping
- SelectedVendorMappingDTO
- ShipmentDTO
- ShipmentStatus
- ShipmentsCountByStatus
- ShippingAddressDTO
- StringAuditEvent
- UnassignOrderItemDTO
- UnauthorizedResult
- UnhandledErrorResponse
- UpdatePackageDTO
- UpdateShipmentDTO
- ValidationErrorResponse
- VendorBulkFulfillItemDTO
- VendorBulkRejectResponseItem
- VendorBulkFulfillItemDTOBulkModel
- VendorBulkFulfillResponse
- VendorBulkFulfillResponseItem
- VendorBulkReassignItemDTO
- VendorBulkReassignItemDTOBulkModel
- VendorBulkReassignResponse
- VendorBulkRejectItemDTO
- VendorBulkRejectItemDTOBulkModel
- VendorBulkRejectResponse
- VendorBulkShipmentResponseItem
- VendorCostDTO
- VendorCostShippingDTO
- VendorCostVasEntryDTO
- VendorCreatePackagesResponse
- VendorFulfillPackageDTO
- VendorGetShipmentsDetailsDTO
- VendorOrderItemModel
- VendorPackageModel
- VendorReassignShipmentDTO
- VendorReassignShipmentResponse
- VendorRejectShipmentDTO
- VendorSearchShipmentModel
- VendorSearchShipmentResponse
- VendorShipmentResponse
- VendorUpdateShipmentStatusEnumDTO
- VendorUpdateTrackingDTO
- VendorUploadItemImageDTO
- VendorUploadItemImageResponse
- Schemas
- Schemas
- CreateNoteModel
- BulkResponse
- AssignDTO
- APIClientInfoModel
- CreateNoteReponse
- BulkResponseItem
- AssignShipmentResponse
- AddRefundItemModel
- Error
- CategoryModel
- AddRefundModel
- ForbiddenErrorResponse
- CreateCategoryModel
- AddressModel
- GetAuditLogResponse
- CreateCategoryResponse
- CancelShipmentDto
- AttributeModel
- GetNoteByIdResponse
- CreateMerchantCatalogDto
- ConflictErrorResponse
- BaseAddressModel
- GetNoteResponseItemModel
- CreateMerchantCatalogResponse
- CountryCodes
- BillingInfoModel
- GetNotesResponse
- CreateProductModel
- CreatePackageDTO
- NotFoundErrorResponse
- CreateProductModelBulkModel
- CreatePackagesResponse
- ResourceFormat
- CreateProductResponse
- CreateShipmentDTO
- CancelOrderItemModel
- ResourceReferenceModel
- CreateVariantModel
- CreateShipmentResponse
- CancelOrderModel
- StringAuditEvent
- CreateVariantResult
- CurrencyCodes
- CancelOrderResponse
- UnauthorizedResult
- DecorationModel
- UnhandledErrorResponse
- ExternalErrorResponse
- CoordinatesModel
- UpdateNotePayload
- CreateOrderCustomerPaymentMethodModel
- UpdateNoteResponse
- GeneratePackingSlipResponse
- CreateOrderCustomerTransactionModel
- UserReferenceModel
- GetCategoriesResponse
- CreateOrderItemImageModel
- ValidationErrorResponse
- GetEffectiveProductsResponse
- GetOrdersCountByFacilityResponse
- CreateOrderItemModel
- GetEffectiveVariantListResponse
- GetShipmentPollingStoppedCountResponse
- CreateOrderModel
- GetEffectiveVariantsByProductResponse
- GetShipmentsCountByStatusResponse
- CreateOrderModelBulkModel
- GetProductVariantsResponse
- LanguageCodes
- CreateOrderResponse
- GetProductsResponse
- CustomerCareHoldOrderResponse
- ListMerchantCatalogsResponse
- OrderCount
- MerchantCatalogDto
- OrderItem
- MerchantVariantAttributeDto
- OrderItemDTO
- MerchantVariantDto
- PackageDTO
- OrderItemImage
- GetOrderCustomerPaymentMethodModel
- MultiPrice
- PackageOrderItemDTO
- OrderItemImageDTO
- GetOrderCustomerTransactionModel
- MultiPriceModel
- PackingSlipDto
- OrderItemStatus
- GetOrderItemImageModel
- GetOrderItemModel
- PatchMerchantCatalogDto
- Reject
- GetOrderItemRefundDataItemModel
- PatchMerchantCatalogResponse
- RejectResponse
- GetOrderItemRefundDataModel
- Price
- Reroute
- GetOrderItemResponse
- PriceModel
- RerouteBulkModel
- GetOrderModel
- PrintImageModel
- RerouteOrderItem
- GetOrderResponse
- PrintImageUploadStatus
- RerouteResponse
- ReprintDTO
- GetOrdersCountByStatusResponse
- PrintMethod
- GetOrdersPollingStoppedCountResponse
- ProductAttributeModel
- SearchShipmentModel
- ListOrderModel
- ProductAttributeValueModel
- SearchShipmentResponse
- ListOrdersResponse
- ProductExtraModel
- SelectedCarrierShippingServiceMethodDTO
- ProductModel
- SelectedShippingMappingDTO
- OptionModel
- ProductStatus
- SelectedShippingMappingMethodDTO
- SelectedVendorMappingDTO
- OrderStatus
- SearchEffectiveVariantsDto
- ShipmentDTO
- OrdersCountByStatus
- SearchEffectiveVariantsResponse
- ShipmentStatus
- SearchEffectiveVariantsSeparateDto
- ShipmentsCountByStatus
- RefreshProcessingModel
- SearchEffectiveVariantsSeparateResponse
- RefreshProcessingResponse
- SearchMerchantCatalogVariantsResponse
- UnassignOrderItemDTO
- ReprintCostCoverageModel
- SearchMerchantVariantDto
- ReprintModel
- SearchProductsResponse
- ReprintShipmentItemModel
- SearchVariantsModel
- UpdatePackageDTO
- ShippingAddressDTO
- ReprintShipmentModel
- UpdateShipmentDTO
- SearchOrderItemsResponse
- SearchOrderModel
- UpdateCategoryModel
- SearchOrdersResponse
- UpdateMerchantCatalogDto
- ShipmentMetadata
- UpdateMerchantCatalogResponse
- StartProcessingModel
- UpdateProductModel
- StartProcessingResponse
- UpdateProductModelBulkModel
- VendorOrderItemModel
- UpdateProductResponse
- VendorPackageModel
- UpdateProductVariantModel
- VendorSearchShipmentModel
- UpdateProductVariantResponse
- VendorSearchShipmentResponse
- UpdateOrderItemImageModel
- VendorShipmentResponse
- UpdateOrderItemModel
- VariantAttributeModel
- VendorUpdateTrackingDTO
- UpdateOrderItemResponse
- VariantModel
- UpdateOrderModel
- UpdateOrderModelBulkModel
- UpdateOrderResponse
- UpdatePriceModel
- VariantAttribute
- VariantOption
- Schemas
ManualHoldResponse
{
"message": "string",
"manualHold": {
"active": true,
"reason": "string",
"heldAtStatus": 1,
"appliedAt": "2019-08-24T14:15:22.123Z",
"appliedByName": "string",
"expiresAt": "2019-08-24T14:15:22.123Z",
"extensionCount": 0
}
}