shipment
POST /shipment
Changed oncreate a shipment
Request
- Base URLhttps://www.weclapp.com/api/nullapi/v2
- AuthAPI key in header AuthenticationToken
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
dryRunboolean
Request body
idstring
versionstring
additionalDeliveryInformationstring
commercialLanguagestring
consolidationStoragePlaceIdstring
createdDateinteger
creatorIdstring
customerPurchaseOrderNumberstring
declaredValueAmountstring number
declaredValueAmountCurrencyIdstring
deliveryDateinteger
descriptionstring
destinationStoragePlaceIdstring
destinationWarehouseIdstring
dhlReceiverIdstring
disableRecordEmailingRuleboolean
invoiceRecipientIdstring
lastModifiedDateinteger
lastStatusChangeUserIdstring
mainSalesOrderIdstring
packageHeightinteger
packageLengthinteger
packageReferenceNumberstring
packageReturnTrackingNumberstring
packageReturnTrackingUrlstring
packageTrackingNumberstring
packageTrackingUrlstring
packageWeightstring number
packageWidthinteger
pickingInstructionsstring
picksCompleteboolean
recipientCustomerNumberstring
recipientPartyIdstring
recipientSupplierNumberstring
recordCommentstring
recordFreeTextstring
recordOpeningstring
responsibleUserIdstring
sentToRecipientboolean
shipmentMethodIdstring
shipmentNumberstring
shipmentType'CONSIGNMENT' | 'CONSIGNMENT_RETURN' | 'CUSTOMER_COMPENSATION' | 'INTERNAL' | 'STANDARD' | 'SUPPLIER_RETURN'
shippingCarrierIdstring
shippingDateinteger
shippingLabelsCountinteger
shippingReturnCarrierIdstring
shippingReturnLabelsCountinteger
status'CANCELLED' | 'DELIVERED' | 'DELIVERY_NOTE_PRINTED' | 'INCOMING_CANCELLED' | 'INCOMING_MOVED_INTO_STORE' | 'INCOMING_SHIPPED' | 'IN_ROUTE' | 'NEW' | 'SHIPPED' required
tagsstring[]
totalWeightstring number
warehouseIdstring
Response
shipment create response
idstring
versionstring
additionalDeliveryInformationstring
commercialLanguagestring
consolidationStoragePlaceIdstring
createdDateinteger
creatorIdstring
customerPurchaseOrderNumberstring
declaredValueAmountstring number
declaredValueAmountCurrencyIdstring
deliveryDateinteger
descriptionstring
destinationStoragePlaceIdstring
destinationWarehouseIdstring
dhlReceiverIdstring
disableRecordEmailingRuleboolean
invoiceRecipientIdstring
lastModifiedDateinteger
lastStatusChangeUserIdstring
mainSalesOrderIdstring
packageHeightinteger
packageLengthinteger
packageReferenceNumberstring
packageReturnTrackingNumberstring
packageReturnTrackingUrlstring
packageTrackingNumberstring
packageTrackingUrlstring
packageWeightstring number
packageWidthinteger
pickingInstructionsstring
picksCompleteboolean
recipientCustomerNumberstring
recipientPartyIdstring
recipientSupplierNumberstring
recordCommentstring
recordFreeTextstring
recordOpeningstring
responsibleUserIdstring
sentToRecipientboolean
shipmentMethodIdstring
shipmentNumberstring
shipmentType'CONSIGNMENT' | 'CONSIGNMENT_RETURN' | 'CUSTOMER_COMPENSATION' | 'INTERNAL' | 'STANDARD' | 'SUPPLIER_RETURN'
shippingCarrierIdstring
shippingDateinteger
shippingLabelsCountinteger
shippingReturnCarrierIdstring
shippingReturnLabelsCountinteger
status'CANCELLED' | 'DELIVERED' | 'DELIVERY_NOTE_PRINTED' | 'INCOMING_CANCELLED' | 'INCOMING_MOVED_INTO_STORE' | 'INCOMING_SHIPPED' | 'IN_ROUTE' | 'NEW' | 'SHIPPED' required
tagsstring[]
totalWeightstring number
warehouseIdstring
Changes
- info
added the new optional
queryrequest parameterdryRun
- info