NC365 Sales Order API (11260734)

GetMagentoOrder

GetMagentoOrder(orderID: Integer): JsonObject

Retrieve a specific Magento sales order.

Parameters:

• orderID - The Magento order ID

Returns: The Magento sales order as a JSON object

GetMagentoOrder

GetMagentoOrder(StagingOrderHeader: Record "NC365 Staging Order Header"): JsonObject

Retrieve a specific Magento sales order.

Parameters:

• StagingOrderHeader - A Staging Order record

Returns: The Magento sales order as a JSON object

UpdateAllOpenStagingOrders

UpdateAllOpenStagingOrders()

Update all open staging orders.

Parameters: none

Returns: nothing

UpdateStagingOrder

UpdateStagingOrder(SalesHeader: Record "Sales Header")

Update a specific staging order.

Parameters:

• SalesHeader - A sales header record

Returns: nothing

UpdateStagingOrder

UpdateStagingOrder(incrementID: Text)

Update a specific staging order.

Parameters:

• incrementID - Magento Increment ID (the visible Magento order number)

Returns: nothing

UpdateStagingOrder

UpdateStagingOrder(orderID: Integer)

Update a specific staging order.

Parameters:

• orderID - Magento Order ID (the technical Magento order ID)

Returns: nothing

UpdateStagingOrder

UpdateStagingOrder(StagingOrderHeader: Record "NC365 Staging Order Header")

Update a specific staging order.

Parameters:

• StagingOrderHeader - A staging order header record

Returns: nothing

CancelStagingOrder

CancelStagingOrder(SalesHeader: Record "Sales Header")

Cancel a staging order and the connected Magento sales order.

Parameters:

• SalesHeader - A sales header record

Returns: nothing

CancelStagingOrder

CancelStagingOrder(incrementID: Text)

Cancel a staging order and the connected Magento sales order.

Parameters:

• incrementID - Magento Increment ID (the visible Magento order number)

Returns: nothing

CancelStagingOrder

CancelStagingOrder(orderID: Integer)

Cancel a Staging Order and the connected Magento sales order.

Parameters:

• orderID - Magento Order ID (the technical Magento order ID)

Returns: nothing

CancelStagingOrder

CancelStagingOrder(StagingOrderHeader: Record "NC365 Staging Order Header")

Cancel a Staging Order and the connected Magento sales order.

Parameters:

• StagingOrderHeader - Staging Order Header record

Returns: nothing

GetShipmentMethodDetails

GetShipmentMethodDetails(StagingOrderHeader: Record "NC365 Staging Order Header"; var ShipmentMethodCode: Code[10]; var ShippingAgentCode: Code[10]; var ShippingAgentServiceCode: Code[10]; var GLAccountNo: Code[20])

Retrieve shipment method details for a specific Staging Order Header and set 4 var params.

Parameters:

• StagingOrderHeader - Staging Order Header record
• ShipmentMethodCode - The shipment method code
• ShippingAgentCode - The shipping agento code
• ShippingAgentServiceCode - The shipping agent service code
• GLAccountNo - The GL account nubmer that was configured for this shipment method

Returns: nothing

GetPaymentMethodDetails

GetPaymentMethodDetails(StagingOrderHeader: Record "NC365 Staging Order Header"; var PaymentMethodCode: Code[10]; var PaymentTermsCode: Code[10])

Retrieve all payment method details for a specific Staging Order Header and set 2 var params.

Parameters:

• StagingOrderHeader - Staging Order Header record
• PaymentMethodCode - The payment method code
• PaymentTermsCode - The payment terms code

Returns: nothing

GetStagingOrderAttributes

GetStagingOrderAttributes(StagingOrderHeader: Record "NC365 Staging Order Header"): Dictionary of [Text, Text]

Retrieve all Order Attributes for a specific Staging Order

Parameters:

• StagingOrderHeader - Staging Order Header record

Returns: Dictionary with order attribute key/value pairs

GetStagingOrderAttributeValue

GetStagingOrderAttributeValue(StagingOrderHeader: Record "NC365 Staging Order Header"; AttributeCode: Text): Text

Get the value of a single staging order attribute

Parameters:

• StagingOrderHeader - Staging Order Header record
• AttributeCode - The attribute code

Returns: Value in text format

GetStagingOrderLineAttributes

GetStagingOrderLineAttributes(StagingOrderLine: Record "NC365 Staging Order Line"): Dictionary of [Text, Text]

Retrieve all Order Line Attributes for a specific Staging Order Line

Parameters:

• StagingOrderLine - Staging Order Line record

Returns: Dictionary with order line attribute key/value pairs

GetStagingOrderLineAttributeValue

GetStagingOrderLineAttributeValue(StagingOrderLine: Record "NC365 Staging Order Line"; AttributeCode: Text): Text

Retrieve the value of a single staging order line attribute

Parameters:

• StagingOrderLine - Staging Order Line record
• AttributeCode - The attribute code

Returns: Value in text format

GetAdditionalPaymentInformation

GetAdditionalPaymentInformation(StagingOrderHeader: Record "NC365 Staging Order Header"): Dictionary of [Text, Text]

Retrieve all additional payment information for a specific Staging Order

Parameters:

• StagingOrderHeader - Staging Order Header record

Returns: Dictionary with key/value pairs

GetStagingOrderLineCustomOptions

GetStagingOrderLineCustomOptions(StagingOrderLine: Record "NC365 Staging Order Line"): Dictionary of [Text, Text]

Retrieve all Order Line Custom Options for a specific Staging Order Line

Parameters:

• StagingOrderLine - Staging Order Line record

Returns: Dictionary with order line attribute key/value pairs

UpdateMagentoSalesOrderStatus

UpdateMagentoSalesOrderStatus(IncrementID: Text; Comment: text; Status: Text): Boolean

Updates the status of a Magento order.

Parameters:

• IncrementID - The increment id of the Magento order
• Comment - The comment that is placed on the status update
• Status - The new Magento order status

Returns: True of the status was changed successfully

UpdateMagentoSalesOrderStatus

UpdateMagentoSalesOrderStatus(IncrementID: Text; Comment: text; Status: Text; NotifyCustomer: Boolean; VisibleOnFront: Boolean): Boolean

Updates the status of a Magento order.

Parameters:

• IncrementID - The increment id of the Magento order
• Comment - The comment that is placed on the status update
• Status - The new Magento order status
• NotifyCustomer - Specify whether the customer should be notified by email about this status update
• VisibleOnFront - Specify whether this status update should be visible on the Magento front-end

Returns: True of the status was changed successfully

UpdateMagentoSalesOrderStatus

UpdateMagentoSalesOrderStatus(IncrementID: Text; Comment: text; Status: Text; NotifyCustomer: Boolean; VisibleOnFront: Boolean; ExtensionAttributes: JsonObject): Boolean

Updates the status of a Magento order.

Parameters:

• IncrementID - The increment id of the Magento order
• Comment - The comment that is placed on the status update
• Status - The new Magento order status
• NotifyCustomer - Specify whether the customer should be notified by email about this status update
• VisibleOnFront - Specify whether this status update should be visible on the Magento front-end
• ExtensionAttributes - Any custom attribute(s) you want to add to the status update request

Returns: True of the status was changed successfully

UpdateMagentoSalesOrderStatus

UpdateMagentoSalesOrderStatus(EntityID: Integer; Comment: text; Status: Text): Boolean

Updates the status of a Magento order.

Parameters:

• EntityID - The (entity)) id of the Magento order
• Comment - The comment that is placed on the status update
• Status - The new Magento order status

Returns: True of the status was changed successfully

UpdateMagentoSalesOrderStatus

UpdateMagentoSalesOrderStatus(EntityID: Integer; Comment: text; Status: Text; NotifyCustomer: Boolean; VisibleOnFront: Boolean): Boolean

Updates the status of a Magento order.

Parameters:

• EntityID - The (entity)) id of the Magento order
• Comment - The comment that is placed on the status update
• Status - The new Magento order status
• NotifyCustomer - Specify whether the customer should be notified by email about this status update
• VisibleOnFront - Specify whether this status update should be visible on the Magento front-end

Returns: True of the status was changed successfully

UpdateMagentoSalesOrderStatus

UpdateMagentoSalesOrderStatus(EntityID: Integer; Comment: text; Status: Text; NotifyCustomer: Boolean; VisibleOnFront: Boolean; ExtensionAttributes: JsonObject): Boolean

Updates the status of a Magento order.

Parameters:

• EntityID - The (entity)) id of the Magento order
• Comment - The comment that is placed on the status update
• Status - The new Magento order status
• NotifyCustomer - Specify whether the customer should be notified by email about this status update
• VisibleOnFront - Specify whether this status update should be visible on the Magento front-end
• ExtensionAttributes - Any custom attribute(s) you want to add to the status update request

Returns: True of the status was changed successfully

CreateOrderAttribute

CreateOrderAttribute(AttributeCode: Code[50]; Type: Enum "NC365 Order Attribute Type"; MappedFieldID: Integer; Validate: Boolean)

Updates the status of a Magento order.procedure UpdateMagentoSalesOrderStatus(EntityID: Integer; Comment: text; Status: Text; NotifyCustomer: Boolean; VisibleOnFront: Boolean; ExtensionAttributes: JsonObject): BooleanvarHttpHelper: Codeunit "NC365 HTTP Helper";beginexit(HttpHelper.UpdateSalesOrderStatus(EntityID, Comment, Status, NotifyCustomer, VisibleOnFront, ExtensionAttributes));end;

Parameters:

• EntityID - The (entity)) id of the Magento order
• Comment - The comment that is placed on the status update
• Status - The new Magento order status
• NotifyCustomer - Specify whether the customer should be notified by email about this status update
• VisibleOnFront - Specify whether this status update should be visible on the Magento front-end
• ExtensionAttributes - Any custom attribute(s) you want to add to the status update request

Returns: True of the status was changed successfully

RemoveOrderAttribute

RemoveOrderAttribute(AttributeCode: Code[50])

procedure CreateOrderAttribute(AttributeCode: Code[50]; Type: Enum "NC365 Order Attribute Type"; MappedFieldID: Integer; Validate: Boolean)varOrderAttibute: Record "NC365 Order Attibute";beginOrderAttibute.SetLoadFields(Type, "Mapped Field ID", Validate);if not OrderAttibute.Get(AttributeCode) then beginOrderAttibute.Init();OrderAttibute.Validate(Code, AttributeCode);OrderAttibute.Insert(true);end;OrderAttibute.Validate(Type, Type);OrderAttibute.Validate("Mapped Field ID", MappedFieldID);OrderAttibute.Validate(Validate, Validate);OrderAttibute.Modify(true);end;

Parameters: none

Returns: nothing